From 9678faba19830db0671870acca86794fbc83cb42 Mon Sep 17 00:00:00 2001 From: Google APIs Date: Mon, 14 Sep 2020 23:21:28 +0000 Subject: [PATCH] Autogenerated update (2020-09-14) Update: - accessapproval_v1 - accesscontextmanager_v1 - accesscontextmanager_v1beta - admin_directory_v1 - admob_v1 - analyticsreporting_v4 - androidpublisher_v3 - appengine_v1 - appengine_v1beta - bigquery_v2 - bigtableadmin_v1 - bigtableadmin_v2 - binaryauthorization_v1 - binaryauthorization_v1beta1 - calendar_v3 - civicinfo_v2 - cloudasset_v1 - cloudasset_v1beta1 - cloudasset_v1p5beta1 - cloudbuild_v1 - cloudbuild_v1alpha1 - cloudbuild_v1alpha2 - clouderrorreporting_v1beta1 - cloudidentity_v1 - cloudidentity_v1beta1 - cloudiot_v1 - cloudresourcemanager_v1 - cloudresourcemanager_v1beta1 - cloudresourcemanager_v2 - cloudresourcemanager_v2beta1 - cloudsearch_v1 - cloudtasks_v2beta3 - container_v1 - container_v1beta1 - containeranalysis_v1alpha1 - containeranalysis_v1beta1 - content_v2 - content_v2_1 - datacatalog_v1beta1 - datafusion_v1 - datafusion_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - dialogflow_v3beta1 - digitalassetlinks_v1 - displayvideo_v1 - dlp_v2 - documentai_v1beta2 - doubleclickbidmanager_v1 - doubleclickbidmanager_v1_1 - firebase_v1beta1 - firebasedynamiclinks_v1 - firebasehosting_v1beta1 - firebaseml_v1beta2 - firestore_v1 - firestore_v1beta1 - fitness_v1 - games_v1 - gameservices_v1 - gameservices_v1beta - healthcare_v1 - healthcare_v1beta1 - homegraph_v1 - iam_v1 - iap_v1 - iap_v1beta1 - jobs_v2 - jobs_v3 - jobs_v3p1beta1 - managedidentities_v1alpha1 - managedidentities_v1beta1 - ml_v1 - monitoring_v1 - osconfig_v1 - osconfig_v1beta - playcustomapp_v1 - prod_tt_sasportal_v1alpha1 - remotebuildexecution_v1 - remotebuildexecution_v1alpha - remotebuildexecution_v2 - runtimeconfig_v1beta1 - safebrowsing_v4 - secretmanager_v1 - secretmanager_v1beta1 - servicedirectory_v1beta1 - servicenetworking_v1 - speech_v1p1beta1 - sql_v1beta4 - storage_v1 - storagetransfer_v1 - texttospeech_v1beta1 - tpu_v1 - tpu_v1alpha1 - vault_v1 - verifiedaccess_v1 - videointelligence_v1 - videointelligence_v1beta2 - videointelligence_v1p1beta1 - videointelligence_v1p2beta1 - videointelligence_v1p3beta1 - vision_v1 - vision_v1p1beta1 - vision_v1p2beta1 - youtube_partner_v1 - youtube_v3 --- api_names_out.yaml | 1201 +++++++++++ generated/google/apis/accessapproval_v1.rb | 2 +- .../google/apis/accessapproval_v1/classes.rb | 10 +- .../google/apis/accesscontextmanager_v1.rb | 2 +- .../apis/accesscontextmanager_v1beta.rb | 2 +- generated/google/apis/admin_directory_v1.rb | 2 +- .../google/apis/admin_directory_v1/classes.rb | 16 +- .../admin_directory_v1/representations.rb | 15 +- .../google/apis/admin_directory_v1/service.rb | 90 +- generated/google/apis/admob_v1.rb | 2 +- .../google/apis/analyticsdata_v1alpha.rb | 37 + .../apis/analyticsdata_v1alpha/classes.rb | 1610 ++++++++++++++ .../analyticsdata_v1alpha/representations.rb | 789 +++++++ .../apis/analyticsdata_v1alpha/service.rb | 220 ++ .../google/apis/analyticsreporting_v4.rb | 2 +- generated/google/apis/androidpublisher_v3.rb | 2 +- generated/google/apis/apigateway_v1alpha1.rb | 34 + .../apis/apigateway_v1alpha1/classes.rb | 633 ++++++ .../apigateway_v1alpha1/representations.rb | 250 +++ .../apis/apigateway_v1alpha1/service.rb | 623 ++++++ generated/google/apis/apigateway_v1beta.rb | 34 + .../google/apis/apigateway_v1beta/classes.rb | 1162 ++++++++++ .../apis/apigateway_v1beta/representations.rb | 470 +++++ .../google/apis/apigateway_v1beta/service.rb | 1172 +++++++++++ generated/google/apis/appengine_v1.rb | 2 +- generated/google/apis/appengine_v1/classes.rb | 75 +- .../apis/appengine_v1/representations.rb | 15 + generated/google/apis/appengine_v1beta.rb | 2 +- .../google/apis/appengine_v1beta/classes.rb | 82 +- .../apis/appengine_v1beta/representations.rb | 16 + generated/google/apis/bigquery_v2.rb | 2 +- generated/google/apis/bigquery_v2/classes.rb | 26 + .../apis/bigquery_v2/representations.rb | 15 + generated/google/apis/bigtableadmin_v1.rb | 2 +- .../google/apis/bigtableadmin_v1/classes.rb | 206 +- generated/google/apis/bigtableadmin_v2.rb | 2 +- .../google/apis/bigtableadmin_v2/classes.rb | 1012 ++++----- .../google/apis/bigtableadmin_v2/service.rb | 441 ++-- .../google/apis/binaryauthorization_v1.rb | 2 +- .../apis/binaryauthorization_v1/classes.rb | 7 + .../binaryauthorization_v1/representations.rb | 1 + .../apis/binaryauthorization_v1beta1.rb | 2 +- .../binaryauthorization_v1beta1/classes.rb | 7 + .../representations.rb | 1 + generated/google/apis/calendar_v3.rb | 2 +- generated/google/apis/calendar_v3/classes.rb | 20 +- generated/google/apis/civicinfo_v2.rb | 2 +- generated/google/apis/civicinfo_v2/classes.rb | 26 +- .../apis/civicinfo_v2/representations.rb | 2 + generated/google/apis/cloudasset_v1.rb | 2 +- generated/google/apis/cloudasset_v1beta1.rb | 2 +- generated/google/apis/cloudasset_v1p5beta1.rb | 2 +- generated/google/apis/cloudbuild_v1.rb | 2 +- .../google/apis/cloudbuild_v1/classes.rb | 82 +- .../apis/cloudbuild_v1/representations.rb | 22 + .../google/apis/cloudbuild_v1/service.rb | 220 +- generated/google/apis/cloudbuild_v1alpha1.rb | 2 +- .../apis/cloudbuild_v1alpha1/classes.rb | 8 + .../cloudbuild_v1alpha1/representations.rb | 1 + generated/google/apis/cloudbuild_v1alpha2.rb | 2 +- .../apis/cloudbuild_v1alpha2/classes.rb | 8 + .../cloudbuild_v1alpha2/representations.rb | 1 + .../apis/clouderrorreporting_v1beta1.rb | 2 +- generated/google/apis/cloudidentity_v1.rb | 5 +- .../google/apis/cloudidentity_v1/classes.rb | 272 ++- .../apis/cloudidentity_v1/representations.rb | 139 ++ .../google/apis/cloudidentity_v1/service.rb | 759 +++++++ .../google/apis/cloudidentity_v1beta1.rb | 2 +- .../apis/cloudidentity_v1beta1/classes.rb | 27 +- generated/google/apis/cloudiot_v1.rb | 2 +- generated/google/apis/cloudiot_v1/classes.rb | 7 + .../apis/cloudiot_v1/representations.rb | 1 + .../google/apis/cloudresourcemanager_v1.rb | 2 +- .../apis/cloudresourcemanager_v1/classes.rb | 21 +- .../representations.rb | 1 + .../apis/cloudresourcemanager_v1/service.rb | 116 +- .../apis/cloudresourcemanager_v1beta1.rb | 2 +- .../cloudresourcemanager_v1beta1/classes.rb | 15 +- .../representations.rb | 1 + .../cloudresourcemanager_v1beta1/service.rb | 45 +- .../google/apis/cloudresourcemanager_v2.rb | 2 +- .../apis/cloudresourcemanager_v2/classes.rb | 7 + .../representations.rb | 1 + .../apis/cloudresourcemanager_v2beta1.rb | 2 +- .../cloudresourcemanager_v2beta1/classes.rb | 7 + .../representations.rb | 1 + generated/google/apis/cloudsearch_v1.rb | 2 +- generated/google/apis/cloudtasks_v2beta3.rb | 2 +- .../google/apis/cloudtasks_v2beta3/classes.rb | 36 +- generated/google/apis/container_v1.rb | 2 +- generated/google/apis/container_v1/classes.rb | 59 +- .../apis/container_v1/representations.rb | 7 + generated/google/apis/container_v1beta1.rb | 2 +- .../google/apis/container_v1beta1/classes.rb | 60 +- .../apis/container_v1beta1/representations.rb | 6 + .../google/apis/containeranalysis_v1alpha1.rb | 2 +- .../containeranalysis_v1alpha1/classes.rb | 7 + .../representations.rb | 1 + .../google/apis/containeranalysis_v1beta1.rb | 2 +- .../apis/containeranalysis_v1beta1/classes.rb | 7 + .../representations.rb | 1 + generated/google/apis/content_v2.rb | 2 +- generated/google/apis/content_v2/classes.rb | 3 +- generated/google/apis/content_v2_1.rb | 2 +- generated/google/apis/content_v2_1/classes.rb | 17 +- .../apis/content_v2_1/representations.rb | 1 + generated/google/apis/datacatalog_v1beta1.rb | 2 +- .../apis/datacatalog_v1beta1/classes.rb | 7 + .../datacatalog_v1beta1/representations.rb | 1 + generated/google/apis/datafusion_v1.rb | 2 +- .../google/apis/datafusion_v1/classes.rb | 15 + .../apis/datafusion_v1/representations.rb | 2 + generated/google/apis/datafusion_v1beta1.rb | 2 +- .../google/apis/datafusion_v1beta1/classes.rb | 15 + .../datafusion_v1beta1/representations.rb | 2 + generated/google/apis/dataproc_v1.rb | 2 +- generated/google/apis/dataproc_v1/classes.rb | 31 +- .../apis/dataproc_v1/representations.rb | 2 + generated/google/apis/dataproc_v1beta2.rb | 2 +- .../google/apis/dataproc_v1beta2/classes.rb | 31 +- .../apis/dataproc_v1beta2/representations.rb | 2 + generated/google/apis/dialogflow_v2.rb | 2 +- .../google/apis/dialogflow_v2/classes.rb | 68 +- .../apis/dialogflow_v2/representations.rb | 1 + generated/google/apis/dialogflow_v2beta1.rb | 2 +- .../google/apis/dialogflow_v2beta1/classes.rb | 87 +- .../dialogflow_v2beta1/representations.rb | 1 + .../google/apis/dialogflow_v2beta1/service.rb | 778 ++++--- generated/google/apis/dialogflow_v3beta1.rb | 2 +- .../google/apis/dialogflow_v3beta1/classes.rb | 75 +- .../dialogflow_v3beta1/representations.rb | 2 +- generated/google/apis/digitalassetlinks_v1.rb | 2 +- .../apis/digitalassetlinks_v1/classes.rb | 158 +- .../apis/digitalassetlinks_v1/service.rb | 319 ++- generated/google/apis/displayvideo_v1.rb | 2 +- .../google/apis/displayvideo_v1/service.rb | 4 +- generated/google/apis/displayvideo_v1beta.rb | 38 + .../apis/displayvideo_v1beta/classes.rb | 146 ++ .../displayvideo_v1beta/representations.rb | 72 + .../apis/displayvideo_v1beta/service.rb | 161 ++ generated/google/apis/displayvideo_v1beta2.rb | 38 + .../apis/displayvideo_v1beta2/classes.rb | 146 ++ .../displayvideo_v1beta2/representations.rb | 72 + .../apis/displayvideo_v1beta2/service.rb | 130 ++ generated/google/apis/displayvideo_v1dev.rb | 38 + .../google/apis/displayvideo_v1dev/classes.rb | 146 ++ .../displayvideo_v1dev/representations.rb | 72 + .../google/apis/displayvideo_v1dev/service.rb | 130 ++ generated/google/apis/dlp_v2.rb | 2 +- generated/google/apis/dlp_v2/classes.rb | 10 +- generated/google/apis/documentai_v1beta2.rb | 2 +- .../google/apis/documentai_v1beta2/classes.rb | 1053 ++++++++++ .../documentai_v1beta2/representations.rb | 398 ++++ .../google/apis/doubleclickbidmanager_v1.rb | 2 +- .../apis/doubleclickbidmanager_v1/classes.rb | 3 +- .../google/apis/doubleclickbidmanager_v1_1.rb | 2 +- .../doubleclickbidmanager_v1_1/classes.rb | 3 +- generated/google/apis/firebase_v1beta1.rb | 2 +- .../google/apis/firebase_v1beta1/classes.rb | 12 +- .../google/apis/firebasedynamiclinks_v1.rb | 2 +- .../google/apis/firebasehosting_v1beta1.rb | 2 +- .../apis/firebasehosting_v1beta1/classes.rb | 160 ++ .../representations.rb | 68 + .../apis/firebasehosting_v1beta1/service.rb | 414 ++++ generated/google/apis/firebaseml_v1beta2.rb | 2 +- .../google/apis/firebaseml_v1beta2/classes.rb | 8 + .../firebaseml_v1beta2/representations.rb | 1 + generated/google/apis/firestore_v1.rb | 2 +- generated/google/apis/firestore_v1beta1.rb | 2 +- generated/google/apis/fitness_v1.rb | 6 +- generated/google/apis/fitness_v1/classes.rb | 10 +- generated/google/apis/games_v1.rb | 2 +- generated/google/apis/gameservices_v1.rb | 2 +- .../google/apis/gameservices_v1/classes.rb | 7 + .../apis/gameservices_v1/representations.rb | 1 + generated/google/apis/gameservices_v1beta.rb | 2 +- .../apis/gameservices_v1beta/classes.rb | 7 + .../gameservices_v1beta/representations.rb | 1 + generated/google/apis/healthcare_v1.rb | 2 +- .../google/apis/healthcare_v1/classes.rb | 72 + .../apis/healthcare_v1/representations.rb | 32 + .../google/apis/healthcare_v1/service.rb | 198 +- generated/google/apis/healthcare_v1beta1.rb | 2 +- .../google/apis/healthcare_v1beta1/service.rb | 247 ++- generated/google/apis/homegraph_v1.rb | 5 +- generated/google/apis/iam_v1.rb | 2 +- generated/google/apis/iam_v1/classes.rb | 7 + .../google/apis/iam_v1/representations.rb | 1 + generated/google/apis/iap_v1.rb | 2 +- generated/google/apis/iap_v1/classes.rb | 7 + .../google/apis/iap_v1/representations.rb | 1 + generated/google/apis/iap_v1beta1.rb | 2 +- generated/google/apis/iap_v1beta1/classes.rb | 7 + .../apis/iap_v1beta1/representations.rb | 1 + generated/google/apis/jobs_v2.rb | 2 +- generated/google/apis/jobs_v2/classes.rb | 1872 +++++++---------- generated/google/apis/jobs_v2/service.rb | 211 +- generated/google/apis/jobs_v3.rb | 2 +- generated/google/apis/jobs_v3/classes.rb | 1493 ++++++------- generated/google/apis/jobs_v3/service.rb | 240 +-- generated/google/apis/jobs_v3p1beta1.rb | 2 +- .../google/apis/jobs_v3p1beta1/classes.rb | 1785 +++++++--------- .../google/apis/jobs_v3p1beta1/service.rb | 245 +-- .../google/apis/managedidentities_v1alpha1.rb | 2 +- .../managedidentities_v1alpha1/classes.rb | 8 + .../representations.rb | 1 + .../google/apis/managedidentities_v1beta1.rb | 2 +- .../apis/managedidentities_v1beta1/classes.rb | 8 + .../representations.rb | 1 + generated/google/apis/ml_v1.rb | 2 +- generated/google/apis/ml_v1/classes.rb | 7 + .../google/apis/ml_v1/representations.rb | 1 + generated/google/apis/ml_v1/service.rb | 2 +- generated/google/apis/monitoring_v1.rb | 2 +- .../google/apis/monitoring_v1/classes.rb | 14 +- generated/google/apis/osconfig_v1.rb | 2 +- generated/google/apis/osconfig_v1/classes.rb | 704 ------- .../apis/osconfig_v1/representations.rb | 337 --- generated/google/apis/osconfig_v1beta.rb | 2 +- .../google/apis/osconfig_v1beta/classes.rb | 704 ------- .../apis/osconfig_v1beta/representations.rb | 337 --- generated/google/apis/playcustomapp_v1.rb | 2 +- .../google/apis/playcustomapp_v1/service.rb | 4 +- .../google/apis/prod_tt_sasportal_v1alpha1.rb | 2 +- .../prod_tt_sasportal_v1alpha1/classes.rb | 20 + .../representations.rb | 13 + .../prod_tt_sasportal_v1alpha1/service.rb | 479 +++++ .../google/apis/remotebuildexecution_v1.rb | 2 +- .../apis/remotebuildexecution_v1alpha.rb | 2 +- .../google/apis/remotebuildexecution_v2.rb | 2 +- .../google/apis/runtimeconfig_v1beta1.rb | 2 +- .../apis/runtimeconfig_v1beta1/classes.rb | 7 + .../runtimeconfig_v1beta1/representations.rb | 1 + generated/google/apis/safebrowsing_v4.rb | 2 +- generated/google/apis/secretmanager_v1.rb | 2 +- .../google/apis/secretmanager_v1/classes.rb | 170 +- .../apis/secretmanager_v1/representations.rb | 92 + .../google/apis/secretmanager_v1beta1.rb | 2 +- .../apis/secretmanager_v1beta1/classes.rb | 7 + .../secretmanager_v1beta1/representations.rb | 1 + .../google/apis/servicedirectory_v1beta1.rb | 2 +- .../apis/servicedirectory_v1beta1/classes.rb | 7 + .../representations.rb | 1 + generated/google/apis/servicenetworking_v1.rb | 2 +- .../apis/servicenetworking_v1/classes.rb | 9 - .../servicenetworking_v1/representations.rb | 1 - generated/google/apis/speech_v1p1beta1.rb | 2 +- generated/google/apis/sql_v1beta4.rb | 2 +- generated/google/apis/storage_v1.rb | 2 +- generated/google/apis/storagetransfer_v1.rb | 2 +- generated/google/apis/sts_v1.rb | 32 + generated/google/apis/sts_v1/classes.rb | 120 ++ .../google/apis/sts_v1/representations.rb | 59 + generated/google/apis/sts_v1/service.rb | 90 + generated/google/apis/sts_v1beta.rb | 32 + generated/google/apis/sts_v1beta/classes.rb | 191 ++ .../google/apis/sts_v1beta/representations.rb | 61 + generated/google/apis/sts_v1beta/service.rb | 92 + generated/google/apis/texttospeech_v1beta1.rb | 2 +- generated/google/apis/tpu_v1.rb | 2 +- generated/google/apis/tpu_v1/classes.rb | 43 + .../google/apis/tpu_v1/representations.rb | 18 + generated/google/apis/tpu_v1alpha1.rb | 2 +- generated/google/apis/tpu_v1alpha1/classes.rb | 43 + .../apis/tpu_v1alpha1/representations.rb | 18 + generated/google/apis/vault_v1.rb | 2 +- generated/google/apis/vault_v1/classes.rb | 183 +- generated/google/apis/vault_v1/service.rb | 68 +- generated/google/apis/verifiedaccess_v1.rb | 2 +- .../google/apis/verifiedaccess_v1/classes.rb | 47 +- generated/google/apis/videointelligence_v1.rb | 2 +- .../apis/videointelligence_v1/service.rb | 31 + .../google/apis/videointelligence_v1beta2.rb | 2 +- .../apis/videointelligence_v1p1beta1.rb | 2 +- .../apis/videointelligence_v1p2beta1.rb | 2 +- .../apis/videointelligence_v1p3beta1.rb | 2 +- generated/google/apis/vision_v1.rb | 2 +- generated/google/apis/vision_v1p1beta1.rb | 2 +- generated/google/apis/vision_v1p2beta1.rb | 2 +- .../google/apis/workflowexecutions_v1beta.rb | 34 + .../apis/workflowexecutions_v1beta/classes.rb | 155 ++ .../representations.rb | 88 + .../apis/workflowexecutions_v1beta/service.rb | 211 ++ generated/google/apis/youtube_partner_v1.rb | 2 +- generated/google/apis/youtube_v3.rb | 2 +- generated/google/apis/youtube_v3/service.rb | 156 +- 286 files changed, 20783 insertions(+), 7799 deletions(-) create mode 100644 generated/google/apis/analyticsdata_v1alpha.rb create mode 100644 generated/google/apis/analyticsdata_v1alpha/classes.rb create mode 100644 generated/google/apis/analyticsdata_v1alpha/representations.rb create mode 100644 generated/google/apis/analyticsdata_v1alpha/service.rb create mode 100644 generated/google/apis/apigateway_v1alpha1.rb create mode 100644 generated/google/apis/apigateway_v1alpha1/classes.rb create mode 100644 generated/google/apis/apigateway_v1alpha1/representations.rb create mode 100644 generated/google/apis/apigateway_v1alpha1/service.rb create mode 100644 generated/google/apis/apigateway_v1beta.rb create mode 100644 generated/google/apis/apigateway_v1beta/classes.rb create mode 100644 generated/google/apis/apigateway_v1beta/representations.rb create mode 100644 generated/google/apis/apigateway_v1beta/service.rb create mode 100644 generated/google/apis/displayvideo_v1beta.rb create mode 100644 generated/google/apis/displayvideo_v1beta/classes.rb create mode 100644 generated/google/apis/displayvideo_v1beta/representations.rb create mode 100644 generated/google/apis/displayvideo_v1beta/service.rb create mode 100644 generated/google/apis/displayvideo_v1beta2.rb create mode 100644 generated/google/apis/displayvideo_v1beta2/classes.rb create mode 100644 generated/google/apis/displayvideo_v1beta2/representations.rb create mode 100644 generated/google/apis/displayvideo_v1beta2/service.rb create mode 100644 generated/google/apis/displayvideo_v1dev.rb create mode 100644 generated/google/apis/displayvideo_v1dev/classes.rb create mode 100644 generated/google/apis/displayvideo_v1dev/representations.rb create mode 100644 generated/google/apis/displayvideo_v1dev/service.rb create mode 100644 generated/google/apis/sts_v1.rb create mode 100644 generated/google/apis/sts_v1/classes.rb create mode 100644 generated/google/apis/sts_v1/representations.rb create mode 100644 generated/google/apis/sts_v1/service.rb create mode 100644 generated/google/apis/sts_v1beta.rb create mode 100644 generated/google/apis/sts_v1beta/classes.rb create mode 100644 generated/google/apis/sts_v1beta/representations.rb create mode 100644 generated/google/apis/sts_v1beta/service.rb create mode 100644 generated/google/apis/workflowexecutions_v1beta.rb create mode 100644 generated/google/apis/workflowexecutions_v1beta/classes.rb create mode 100644 generated/google/apis/workflowexecutions_v1beta/representations.rb create mode 100644 generated/google/apis/workflowexecutions_v1beta/service.rb diff --git a/api_names_out.yaml b/api_names_out.yaml index 04bcf7faf..744c3209c 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -4051,6 +4051,8 @@ "/admin:directory_v1/directory.tokens.get/userKey": user_key "/admin:directory_v1/directory.tokens.list": list_tokens "/admin:directory_v1/directory.tokens.list/userKey": user_key +"/admin:directory_v1/directory.twoStepVerification.turnOff": turn_two_step_verification_off +"/admin:directory_v1/directory.twoStepVerification.turnOff/userKey": user_key "/admin:directory_v1/directory.users.aliases.delete": delete_user_alias "/admin:directory_v1/directory.users.aliases.delete/alias": user_alias "/admin:directory_v1/directory.users.aliases.delete/userKey": user_key @@ -4095,6 +4097,8 @@ "/admin:directory_v1/directory.users.photos.patch/userKey": user_key "/admin:directory_v1/directory.users.photos.update": update_user_photo "/admin:directory_v1/directory.users.photos.update/userKey": user_key +"/admin:directory_v1/directory.users.signOut": sign_user_out +"/admin:directory_v1/directory.users.signOut/userKey": user_key "/admin:directory_v1/directory.users.undelete": undelete_user "/admin:directory_v1/directory.users.undelete/userKey": user_key "/admin:directory_v1/directory.users.update": update_user @@ -6401,6 +6405,238 @@ "/analytics:v3/key": key "/analytics:v3/quotaUser": quota_user "/analytics:v3/userIp": user_ip +"/analyticsdata:v1alpha/BatchRunPivotReportsRequest": batch_run_pivot_reports_request +"/analyticsdata:v1alpha/BatchRunPivotReportsRequest/entity": entity +"/analyticsdata:v1alpha/BatchRunPivotReportsRequest/requests": requests +"/analyticsdata:v1alpha/BatchRunPivotReportsRequest/requests/request": request +"/analyticsdata:v1alpha/BatchRunPivotReportsResponse": batch_run_pivot_reports_response +"/analyticsdata:v1alpha/BatchRunPivotReportsResponse/pivotReports": pivot_reports +"/analyticsdata:v1alpha/BatchRunPivotReportsResponse/pivotReports/pivot_report": pivot_report +"/analyticsdata:v1alpha/BatchRunReportsRequest": batch_run_reports_request +"/analyticsdata:v1alpha/BatchRunReportsRequest/entity": entity +"/analyticsdata:v1alpha/BatchRunReportsRequest/requests": requests +"/analyticsdata:v1alpha/BatchRunReportsRequest/requests/request": request +"/analyticsdata:v1alpha/BatchRunReportsResponse": batch_run_reports_response +"/analyticsdata:v1alpha/BatchRunReportsResponse/reports": reports +"/analyticsdata:v1alpha/BatchRunReportsResponse/reports/report": report +"/analyticsdata:v1alpha/BetweenFilter": between_filter +"/analyticsdata:v1alpha/BetweenFilter/fromValue": from_value +"/analyticsdata:v1alpha/BetweenFilter/toValue": to_value +"/analyticsdata:v1alpha/CaseExpression": case_expression +"/analyticsdata:v1alpha/CaseExpression/dimensionName": dimension_name +"/analyticsdata:v1alpha/Cohort": cohort +"/analyticsdata:v1alpha/Cohort/dateRange": date_range +"/analyticsdata:v1alpha/Cohort/dimension": dimension +"/analyticsdata:v1alpha/Cohort/name": name +"/analyticsdata:v1alpha/CohortReportSettings": cohort_report_settings +"/analyticsdata:v1alpha/CohortReportSettings/accumulate": accumulate +"/analyticsdata:v1alpha/CohortSpec": cohort_spec +"/analyticsdata:v1alpha/CohortSpec/cohortReportSettings": cohort_report_settings +"/analyticsdata:v1alpha/CohortSpec/cohorts": cohorts +"/analyticsdata:v1alpha/CohortSpec/cohorts/cohort": cohort +"/analyticsdata:v1alpha/CohortSpec/cohortsRange": cohorts_range +"/analyticsdata:v1alpha/CohortsRange": cohorts_range +"/analyticsdata:v1alpha/CohortsRange/endOffset": end_offset +"/analyticsdata:v1alpha/CohortsRange/granularity": granularity +"/analyticsdata:v1alpha/CohortsRange/startOffset": start_offset +"/analyticsdata:v1alpha/ConcatenateExpression": concatenate_expression +"/analyticsdata:v1alpha/ConcatenateExpression/delimiter": delimiter +"/analyticsdata:v1alpha/ConcatenateExpression/dimensionNames": dimension_names +"/analyticsdata:v1alpha/ConcatenateExpression/dimensionNames/dimension_name": dimension_name +"/analyticsdata:v1alpha/DateRange": date_range +"/analyticsdata:v1alpha/DateRange/endDate": end_date +"/analyticsdata:v1alpha/DateRange/name": name +"/analyticsdata:v1alpha/DateRange/startDate": start_date +"/analyticsdata:v1alpha/Dimension": dimension +"/analyticsdata:v1alpha/Dimension/dimensionExpression": dimension_expression +"/analyticsdata:v1alpha/Dimension/name": name +"/analyticsdata:v1alpha/DimensionExpression": dimension_expression +"/analyticsdata:v1alpha/DimensionExpression/concatenate": concatenate +"/analyticsdata:v1alpha/DimensionExpression/lowerCase": lower_case +"/analyticsdata:v1alpha/DimensionExpression/upperCase": upper_case +"/analyticsdata:v1alpha/DimensionHeader": dimension_header +"/analyticsdata:v1alpha/DimensionHeader/name": name +"/analyticsdata:v1alpha/DimensionMetadata": dimension_metadata +"/analyticsdata:v1alpha/DimensionMetadata/apiName": api_name +"/analyticsdata:v1alpha/DimensionMetadata/deprecatedApiNames": deprecated_api_names +"/analyticsdata:v1alpha/DimensionMetadata/deprecatedApiNames/deprecated_api_name": deprecated_api_name +"/analyticsdata:v1alpha/DimensionMetadata/description": description +"/analyticsdata:v1alpha/DimensionMetadata/uiName": ui_name +"/analyticsdata:v1alpha/DimensionOrderBy": dimension_order_by +"/analyticsdata:v1alpha/DimensionOrderBy/dimensionName": dimension_name +"/analyticsdata:v1alpha/DimensionOrderBy/orderType": order_type +"/analyticsdata:v1alpha/DimensionValue": dimension_value +"/analyticsdata:v1alpha/DimensionValue/value": value +"/analyticsdata:v1alpha/Entity": entity +"/analyticsdata:v1alpha/Entity/propertyId": property_id +"/analyticsdata:v1alpha/Filter": filter +"/analyticsdata:v1alpha/Filter/betweenFilter": between_filter +"/analyticsdata:v1alpha/Filter/fieldName": field_name +"/analyticsdata:v1alpha/Filter/inListFilter": in_list_filter +"/analyticsdata:v1alpha/Filter/nullFilter": null_filter +"/analyticsdata:v1alpha/Filter/numericFilter": numeric_filter +"/analyticsdata:v1alpha/Filter/stringFilter": string_filter +"/analyticsdata:v1alpha/FilterExpression": filter_expression +"/analyticsdata:v1alpha/FilterExpression/andGroup": and_group +"/analyticsdata:v1alpha/FilterExpression/filter": filter +"/analyticsdata:v1alpha/FilterExpression/notExpression": not_expression +"/analyticsdata:v1alpha/FilterExpression/orGroup": or_group +"/analyticsdata:v1alpha/FilterExpressionList": filter_expression_list +"/analyticsdata:v1alpha/FilterExpressionList/expressions": expressions +"/analyticsdata:v1alpha/FilterExpressionList/expressions/expression": expression +"/analyticsdata:v1alpha/InListFilter": in_list_filter +"/analyticsdata:v1alpha/InListFilter/caseSensitive": case_sensitive +"/analyticsdata:v1alpha/InListFilter/values": values +"/analyticsdata:v1alpha/InListFilter/values/value": value +"/analyticsdata:v1alpha/Metric": metric +"/analyticsdata:v1alpha/Metric/expression": expression +"/analyticsdata:v1alpha/Metric/invisible": invisible +"/analyticsdata:v1alpha/Metric/name": name +"/analyticsdata:v1alpha/MetricHeader": metric_header +"/analyticsdata:v1alpha/MetricHeader/name": name +"/analyticsdata:v1alpha/MetricHeader/type": type +"/analyticsdata:v1alpha/MetricMetadata": metric_metadata +"/analyticsdata:v1alpha/MetricMetadata/apiName": api_name +"/analyticsdata:v1alpha/MetricMetadata/deprecatedApiNames": deprecated_api_names +"/analyticsdata:v1alpha/MetricMetadata/deprecatedApiNames/deprecated_api_name": deprecated_api_name +"/analyticsdata:v1alpha/MetricMetadata/description": description +"/analyticsdata:v1alpha/MetricMetadata/expression": expression +"/analyticsdata:v1alpha/MetricMetadata/type": type +"/analyticsdata:v1alpha/MetricMetadata/uiName": ui_name +"/analyticsdata:v1alpha/MetricOrderBy": metric_order_by +"/analyticsdata:v1alpha/MetricOrderBy/metricName": metric_name +"/analyticsdata:v1alpha/MetricValue": metric_value +"/analyticsdata:v1alpha/MetricValue/value": value +"/analyticsdata:v1alpha/NumericFilter": numeric_filter +"/analyticsdata:v1alpha/NumericFilter/operation": operation +"/analyticsdata:v1alpha/NumericFilter/value": value +"/analyticsdata:v1alpha/NumericValue": numeric_value +"/analyticsdata:v1alpha/NumericValue/doubleValue": double_value +"/analyticsdata:v1alpha/NumericValue/int64Value": int64_value +"/analyticsdata:v1alpha/OrderBy": order_by +"/analyticsdata:v1alpha/OrderBy/desc": desc +"/analyticsdata:v1alpha/OrderBy/dimension": dimension +"/analyticsdata:v1alpha/OrderBy/metric": metric +"/analyticsdata:v1alpha/OrderBy/pivot": pivot +"/analyticsdata:v1alpha/Pivot": pivot +"/analyticsdata:v1alpha/Pivot/fieldNames": field_names +"/analyticsdata:v1alpha/Pivot/fieldNames/field_name": field_name +"/analyticsdata:v1alpha/Pivot/limit": limit +"/analyticsdata:v1alpha/Pivot/metricAggregations": metric_aggregations +"/analyticsdata:v1alpha/Pivot/metricAggregations/metric_aggregation": metric_aggregation +"/analyticsdata:v1alpha/Pivot/offset": offset +"/analyticsdata:v1alpha/Pivot/orderBys": order_bys +"/analyticsdata:v1alpha/Pivot/orderBys/order_by": order_by +"/analyticsdata:v1alpha/PivotDimensionHeader": pivot_dimension_header +"/analyticsdata:v1alpha/PivotDimensionHeader/dimensionValues": dimension_values +"/analyticsdata:v1alpha/PivotDimensionHeader/dimensionValues/dimension_value": dimension_value +"/analyticsdata:v1alpha/PivotHeader": pivot_header +"/analyticsdata:v1alpha/PivotHeader/pivotDimensionHeaders": pivot_dimension_headers +"/analyticsdata:v1alpha/PivotHeader/pivotDimensionHeaders/pivot_dimension_header": pivot_dimension_header +"/analyticsdata:v1alpha/PivotHeader/rowCount": row_count +"/analyticsdata:v1alpha/PivotOrderBy": pivot_order_by +"/analyticsdata:v1alpha/PivotOrderBy/metricName": metric_name +"/analyticsdata:v1alpha/PivotOrderBy/pivotSelections": pivot_selections +"/analyticsdata:v1alpha/PivotOrderBy/pivotSelections/pivot_selection": pivot_selection +"/analyticsdata:v1alpha/PivotSelection": pivot_selection +"/analyticsdata:v1alpha/PivotSelection/dimensionName": dimension_name +"/analyticsdata:v1alpha/PivotSelection/dimensionValue": dimension_value +"/analyticsdata:v1alpha/PropertyQuota": property_quota +"/analyticsdata:v1alpha/PropertyQuota/concurrentRequests": concurrent_requests +"/analyticsdata:v1alpha/PropertyQuota/serverErrorsPerProjectPerHour": server_errors_per_project_per_hour +"/analyticsdata:v1alpha/PropertyQuota/tokensPerDay": tokens_per_day +"/analyticsdata:v1alpha/PropertyQuota/tokensPerHour": tokens_per_hour +"/analyticsdata:v1alpha/QuotaStatus": quota_status +"/analyticsdata:v1alpha/QuotaStatus/consumed": consumed +"/analyticsdata:v1alpha/QuotaStatus/remaining": remaining +"/analyticsdata:v1alpha/ResponseMetaData": response_meta_data +"/analyticsdata:v1alpha/ResponseMetaData/dataLossFromOtherRow": data_loss_from_other_row +"/analyticsdata:v1alpha/Row": row +"/analyticsdata:v1alpha/Row/dimensionValues": dimension_values +"/analyticsdata:v1alpha/Row/dimensionValues/dimension_value": dimension_value +"/analyticsdata:v1alpha/Row/metricValues": metric_values +"/analyticsdata:v1alpha/Row/metricValues/metric_value": metric_value +"/analyticsdata:v1alpha/RunPivotReportRequest": run_pivot_report_request +"/analyticsdata:v1alpha/RunPivotReportRequest/cohortSpec": cohort_spec +"/analyticsdata:v1alpha/RunPivotReportRequest/currencyCode": currency_code +"/analyticsdata:v1alpha/RunPivotReportRequest/dateRanges": date_ranges +"/analyticsdata:v1alpha/RunPivotReportRequest/dateRanges/date_range": date_range +"/analyticsdata:v1alpha/RunPivotReportRequest/dimensionFilter": dimension_filter +"/analyticsdata:v1alpha/RunPivotReportRequest/dimensions": dimensions +"/analyticsdata:v1alpha/RunPivotReportRequest/dimensions/dimension": dimension +"/analyticsdata:v1alpha/RunPivotReportRequest/entity": entity +"/analyticsdata:v1alpha/RunPivotReportRequest/keepEmptyRows": keep_empty_rows +"/analyticsdata:v1alpha/RunPivotReportRequest/metricFilter": metric_filter +"/analyticsdata:v1alpha/RunPivotReportRequest/metrics": metrics +"/analyticsdata:v1alpha/RunPivotReportRequest/metrics/metric": metric +"/analyticsdata:v1alpha/RunPivotReportRequest/pivots": pivots +"/analyticsdata:v1alpha/RunPivotReportRequest/pivots/pivot": pivot +"/analyticsdata:v1alpha/RunPivotReportRequest/returnPropertyQuota": return_property_quota +"/analyticsdata:v1alpha/RunPivotReportResponse": run_pivot_report_response +"/analyticsdata:v1alpha/RunPivotReportResponse/aggregates": aggregates +"/analyticsdata:v1alpha/RunPivotReportResponse/aggregates/aggregate": aggregate +"/analyticsdata:v1alpha/RunPivotReportResponse/dimensionHeaders": dimension_headers +"/analyticsdata:v1alpha/RunPivotReportResponse/dimensionHeaders/dimension_header": dimension_header +"/analyticsdata:v1alpha/RunPivotReportResponse/metadata": metadata +"/analyticsdata:v1alpha/RunPivotReportResponse/metricHeaders": metric_headers +"/analyticsdata:v1alpha/RunPivotReportResponse/metricHeaders/metric_header": metric_header +"/analyticsdata:v1alpha/RunPivotReportResponse/pivotHeaders": pivot_headers +"/analyticsdata:v1alpha/RunPivotReportResponse/pivotHeaders/pivot_header": pivot_header +"/analyticsdata:v1alpha/RunPivotReportResponse/propertyQuota": property_quota +"/analyticsdata:v1alpha/RunPivotReportResponse/rows": rows +"/analyticsdata:v1alpha/RunPivotReportResponse/rows/row": row +"/analyticsdata:v1alpha/RunReportRequest": run_report_request +"/analyticsdata:v1alpha/RunReportRequest/cohortSpec": cohort_spec +"/analyticsdata:v1alpha/RunReportRequest/currencyCode": currency_code +"/analyticsdata:v1alpha/RunReportRequest/dateRanges": date_ranges +"/analyticsdata:v1alpha/RunReportRequest/dateRanges/date_range": date_range +"/analyticsdata:v1alpha/RunReportRequest/dimensionFilter": dimension_filter +"/analyticsdata:v1alpha/RunReportRequest/dimensions": dimensions +"/analyticsdata:v1alpha/RunReportRequest/dimensions/dimension": dimension +"/analyticsdata:v1alpha/RunReportRequest/entity": entity +"/analyticsdata:v1alpha/RunReportRequest/keepEmptyRows": keep_empty_rows +"/analyticsdata:v1alpha/RunReportRequest/limit": limit +"/analyticsdata:v1alpha/RunReportRequest/metricAggregations": metric_aggregations +"/analyticsdata:v1alpha/RunReportRequest/metricAggregations/metric_aggregation": metric_aggregation +"/analyticsdata:v1alpha/RunReportRequest/metricFilter": metric_filter +"/analyticsdata:v1alpha/RunReportRequest/metrics": metrics +"/analyticsdata:v1alpha/RunReportRequest/metrics/metric": metric +"/analyticsdata:v1alpha/RunReportRequest/offset": offset +"/analyticsdata:v1alpha/RunReportRequest/orderBys": order_bys +"/analyticsdata:v1alpha/RunReportRequest/orderBys/order_by": order_by +"/analyticsdata:v1alpha/RunReportRequest/returnPropertyQuota": return_property_quota +"/analyticsdata:v1alpha/RunReportResponse": run_report_response +"/analyticsdata:v1alpha/RunReportResponse/dimensionHeaders": dimension_headers +"/analyticsdata:v1alpha/RunReportResponse/dimensionHeaders/dimension_header": dimension_header +"/analyticsdata:v1alpha/RunReportResponse/maximums": maximums +"/analyticsdata:v1alpha/RunReportResponse/maximums/maximum": maximum +"/analyticsdata:v1alpha/RunReportResponse/metadata": metadata +"/analyticsdata:v1alpha/RunReportResponse/metricHeaders": metric_headers +"/analyticsdata:v1alpha/RunReportResponse/metricHeaders/metric_header": metric_header +"/analyticsdata:v1alpha/RunReportResponse/minimums": minimums +"/analyticsdata:v1alpha/RunReportResponse/minimums/minimum": minimum +"/analyticsdata:v1alpha/RunReportResponse/propertyQuota": property_quota +"/analyticsdata:v1alpha/RunReportResponse/rowCount": row_count +"/analyticsdata:v1alpha/RunReportResponse/rows": rows +"/analyticsdata:v1alpha/RunReportResponse/rows/row": row +"/analyticsdata:v1alpha/RunReportResponse/totals": totals +"/analyticsdata:v1alpha/RunReportResponse/totals/total": total +"/analyticsdata:v1alpha/StringFilter": string_filter +"/analyticsdata:v1alpha/StringFilter/caseSensitive": case_sensitive +"/analyticsdata:v1alpha/StringFilter/matchType": match_type +"/analyticsdata:v1alpha/StringFilter/value": value +"/analyticsdata:v1alpha/UniversalMetadata": universal_metadata +"/analyticsdata:v1alpha/UniversalMetadata/dimensions": dimensions +"/analyticsdata:v1alpha/UniversalMetadata/dimensions/dimension": dimension +"/analyticsdata:v1alpha/UniversalMetadata/metrics": metrics +"/analyticsdata:v1alpha/UniversalMetadata/metrics/metric": metric +"/analyticsdata:v1alpha/analyticsdata.batchRunPivotReports": batch_run_pivot_reports +"/analyticsdata:v1alpha/analyticsdata.batchRunReports": batch_run_reports +"/analyticsdata:v1alpha/analyticsdata.runPivotReport": run_pivot_report +"/analyticsdata:v1alpha/analyticsdata.runReport": run_report +"/analyticsdata:v1alpha/fields": fields +"/analyticsdata:v1alpha/key": key +"/analyticsdata:v1alpha/quotaUser": quota_user "/analyticsreporting:v4/Activity": activity "/analyticsreporting:v4/Activity/activityTime": activity_time "/analyticsreporting:v4/Activity/activityType": activity_type @@ -9393,6 +9629,350 @@ "/androidpublisher:v3/key": key "/androidpublisher:v3/quotaUser": quota_user "/androidpublisher:v3/userIp": user_ip +"/apigateway:v1alpha1/ApigatewayAuditConfig": apigateway_audit_config +"/apigateway:v1alpha1/ApigatewayAuditConfig/auditLogConfigs": audit_log_configs +"/apigateway:v1alpha1/ApigatewayAuditConfig/auditLogConfigs/audit_log_config": audit_log_config +"/apigateway:v1alpha1/ApigatewayAuditConfig/service": service +"/apigateway:v1alpha1/ApigatewayAuditLogConfig": apigateway_audit_log_config +"/apigateway:v1alpha1/ApigatewayAuditLogConfig/exemptedMembers": exempted_members +"/apigateway:v1alpha1/ApigatewayAuditLogConfig/exemptedMembers/exempted_member": exempted_member +"/apigateway:v1alpha1/ApigatewayAuditLogConfig/logType": log_type +"/apigateway:v1alpha1/ApigatewayBinding": apigateway_binding +"/apigateway:v1alpha1/ApigatewayBinding/condition": condition +"/apigateway:v1alpha1/ApigatewayBinding/members": members +"/apigateway:v1alpha1/ApigatewayBinding/members/member": member +"/apigateway:v1alpha1/ApigatewayBinding/role": role +"/apigateway:v1alpha1/ApigatewayCancelOperationRequest": apigateway_cancel_operation_request +"/apigateway:v1alpha1/ApigatewayExpr": apigateway_expr +"/apigateway:v1alpha1/ApigatewayExpr/description": description +"/apigateway:v1alpha1/ApigatewayExpr/expression": expression +"/apigateway:v1alpha1/ApigatewayExpr/location": location +"/apigateway:v1alpha1/ApigatewayExpr/title": title +"/apigateway:v1alpha1/ApigatewayListLocationsResponse": apigateway_list_locations_response +"/apigateway:v1alpha1/ApigatewayListLocationsResponse/locations": locations +"/apigateway:v1alpha1/ApigatewayListLocationsResponse/locations/location": location +"/apigateway:v1alpha1/ApigatewayListLocationsResponse/nextPageToken": next_page_token +"/apigateway:v1alpha1/ApigatewayListOperationsResponse": apigateway_list_operations_response +"/apigateway:v1alpha1/ApigatewayListOperationsResponse/nextPageToken": next_page_token +"/apigateway:v1alpha1/ApigatewayListOperationsResponse/operations": operations +"/apigateway:v1alpha1/ApigatewayListOperationsResponse/operations/operation": operation +"/apigateway:v1alpha1/ApigatewayLocation": apigateway_location +"/apigateway:v1alpha1/ApigatewayLocation/displayName": display_name +"/apigateway:v1alpha1/ApigatewayLocation/labels": labels +"/apigateway:v1alpha1/ApigatewayLocation/labels/label": label +"/apigateway:v1alpha1/ApigatewayLocation/locationId": location_id +"/apigateway:v1alpha1/ApigatewayLocation/metadata": metadata +"/apigateway:v1alpha1/ApigatewayLocation/metadata/metadatum": metadatum +"/apigateway:v1alpha1/ApigatewayLocation/name": name +"/apigateway:v1alpha1/ApigatewayOperation": apigateway_operation +"/apigateway:v1alpha1/ApigatewayOperation/done": done +"/apigateway:v1alpha1/ApigatewayOperation/error": error +"/apigateway:v1alpha1/ApigatewayOperation/metadata": metadata +"/apigateway:v1alpha1/ApigatewayOperation/metadata/metadatum": metadatum +"/apigateway:v1alpha1/ApigatewayOperation/name": name +"/apigateway:v1alpha1/ApigatewayOperation/response": response +"/apigateway:v1alpha1/ApigatewayOperation/response/response": response +"/apigateway:v1alpha1/ApigatewayPolicy": apigateway_policy +"/apigateway:v1alpha1/ApigatewayPolicy/auditConfigs": audit_configs +"/apigateway:v1alpha1/ApigatewayPolicy/auditConfigs/audit_config": audit_config +"/apigateway:v1alpha1/ApigatewayPolicy/bindings": bindings +"/apigateway:v1alpha1/ApigatewayPolicy/bindings/binding": binding +"/apigateway:v1alpha1/ApigatewayPolicy/etag": etag +"/apigateway:v1alpha1/ApigatewayPolicy/version": version +"/apigateway:v1alpha1/ApigatewaySetIamPolicyRequest": apigateway_set_iam_policy_request +"/apigateway:v1alpha1/ApigatewaySetIamPolicyRequest/policy": policy +"/apigateway:v1alpha1/ApigatewaySetIamPolicyRequest/updateMask": update_mask +"/apigateway:v1alpha1/ApigatewayStatus": apigateway_status +"/apigateway:v1alpha1/ApigatewayStatus/code": code +"/apigateway:v1alpha1/ApigatewayStatus/details": details +"/apigateway:v1alpha1/ApigatewayStatus/details/detail": detail +"/apigateway:v1alpha1/ApigatewayStatus/details/detail/detail": detail +"/apigateway:v1alpha1/ApigatewayStatus/message": message +"/apigateway:v1alpha1/ApigatewayTestIamPermissionsRequest": apigateway_test_iam_permissions_request +"/apigateway:v1alpha1/ApigatewayTestIamPermissionsRequest/permissions": permissions +"/apigateway:v1alpha1/ApigatewayTestIamPermissionsRequest/permissions/permission": permission +"/apigateway:v1alpha1/ApigatewayTestIamPermissionsResponse": apigateway_test_iam_permissions_response +"/apigateway:v1alpha1/ApigatewayTestIamPermissionsResponse/permissions": permissions +"/apigateway:v1alpha1/ApigatewayTestIamPermissionsResponse/permissions/permission": permission +"/apigateway:v1alpha1/Empty": empty +"/apigateway:v1alpha1/apigateway.projects.locations.apis.configs.getIamPolicy": get_project_location_api_config_iam_policy +"/apigateway:v1alpha1/apigateway.projects.locations.apis.configs.getIamPolicy/options.requestedPolicyVersion": options_requested_policy_version +"/apigateway:v1alpha1/apigateway.projects.locations.apis.configs.getIamPolicy/resource": resource +"/apigateway:v1alpha1/apigateway.projects.locations.apis.configs.setIamPolicy": set_project_location_api_config_iam_policy +"/apigateway:v1alpha1/apigateway.projects.locations.apis.configs.setIamPolicy/resource": resource +"/apigateway:v1alpha1/apigateway.projects.locations.apis.configs.testIamPermissions": test_project_location_api_config_iam_permissions +"/apigateway:v1alpha1/apigateway.projects.locations.apis.configs.testIamPermissions/resource": resource +"/apigateway:v1alpha1/apigateway.projects.locations.apis.getIamPolicy": get_project_location_api_iam_policy +"/apigateway:v1alpha1/apigateway.projects.locations.apis.getIamPolicy/options.requestedPolicyVersion": options_requested_policy_version +"/apigateway:v1alpha1/apigateway.projects.locations.apis.getIamPolicy/resource": resource +"/apigateway:v1alpha1/apigateway.projects.locations.apis.setIamPolicy": set_project_location_api_iam_policy +"/apigateway:v1alpha1/apigateway.projects.locations.apis.setIamPolicy/resource": resource +"/apigateway:v1alpha1/apigateway.projects.locations.apis.testIamPermissions": test_project_location_api_iam_permissions +"/apigateway:v1alpha1/apigateway.projects.locations.apis.testIamPermissions/resource": resource +"/apigateway:v1alpha1/apigateway.projects.locations.gateways.getIamPolicy": get_project_location_gateway_iam_policy +"/apigateway:v1alpha1/apigateway.projects.locations.gateways.getIamPolicy/options.requestedPolicyVersion": options_requested_policy_version +"/apigateway:v1alpha1/apigateway.projects.locations.gateways.getIamPolicy/resource": resource +"/apigateway:v1alpha1/apigateway.projects.locations.gateways.setIamPolicy": set_project_location_gateway_iam_policy +"/apigateway:v1alpha1/apigateway.projects.locations.gateways.setIamPolicy/resource": resource +"/apigateway:v1alpha1/apigateway.projects.locations.gateways.testIamPermissions": test_project_location_gateway_iam_permissions +"/apigateway:v1alpha1/apigateway.projects.locations.gateways.testIamPermissions/resource": resource +"/apigateway:v1alpha1/apigateway.projects.locations.get": get_project_location +"/apigateway:v1alpha1/apigateway.projects.locations.get/name": name +"/apigateway:v1alpha1/apigateway.projects.locations.list": list_project_locations +"/apigateway:v1alpha1/apigateway.projects.locations.list/filter": filter +"/apigateway:v1alpha1/apigateway.projects.locations.list/name": name +"/apigateway:v1alpha1/apigateway.projects.locations.list/pageSize": page_size +"/apigateway:v1alpha1/apigateway.projects.locations.list/pageToken": page_token +"/apigateway:v1alpha1/apigateway.projects.locations.operations.cancel": cancel_project_location_operation +"/apigateway:v1alpha1/apigateway.projects.locations.operations.cancel/name": name +"/apigateway:v1alpha1/apigateway.projects.locations.operations.delete": delete_project_location_operation +"/apigateway:v1alpha1/apigateway.projects.locations.operations.delete/name": name +"/apigateway:v1alpha1/apigateway.projects.locations.operations.get": get_project_location_operation +"/apigateway:v1alpha1/apigateway.projects.locations.operations.get/name": name +"/apigateway:v1alpha1/apigateway.projects.locations.operations.list": list_project_location_operations +"/apigateway:v1alpha1/apigateway.projects.locations.operations.list/filter": filter +"/apigateway:v1alpha1/apigateway.projects.locations.operations.list/name": name +"/apigateway:v1alpha1/apigateway.projects.locations.operations.list/pageSize": page_size +"/apigateway:v1alpha1/apigateway.projects.locations.operations.list/pageToken": page_token +"/apigateway:v1alpha1/fields": fields +"/apigateway:v1alpha1/key": key +"/apigateway:v1alpha1/quotaUser": quota_user +"/apigateway:v1beta/ApigatewayApi": apigateway_api +"/apigateway:v1beta/ApigatewayApi/createTime": create_time +"/apigateway:v1beta/ApigatewayApi/displayName": display_name +"/apigateway:v1beta/ApigatewayApi/labels": labels +"/apigateway:v1beta/ApigatewayApi/labels/label": label +"/apigateway:v1beta/ApigatewayApi/managedService": managed_service +"/apigateway:v1beta/ApigatewayApi/name": name +"/apigateway:v1beta/ApigatewayApi/state": state +"/apigateway:v1beta/ApigatewayApi/updateTime": update_time +"/apigateway:v1beta/ApigatewayApiConfig": apigateway_api_config +"/apigateway:v1beta/ApigatewayApiConfig/createTime": create_time +"/apigateway:v1beta/ApigatewayApiConfig/displayName": display_name +"/apigateway:v1beta/ApigatewayApiConfig/gatewayConfig": gateway_config +"/apigateway:v1beta/ApigatewayApiConfig/grpcServices": grpc_services +"/apigateway:v1beta/ApigatewayApiConfig/grpcServices/grpc_service": grpc_service +"/apigateway:v1beta/ApigatewayApiConfig/labels": labels +"/apigateway:v1beta/ApigatewayApiConfig/labels/label": label +"/apigateway:v1beta/ApigatewayApiConfig/managedServiceConfigs": managed_service_configs +"/apigateway:v1beta/ApigatewayApiConfig/managedServiceConfigs/managed_service_config": managed_service_config +"/apigateway:v1beta/ApigatewayApiConfig/name": name +"/apigateway:v1beta/ApigatewayApiConfig/openapiDocuments": openapi_documents +"/apigateway:v1beta/ApigatewayApiConfig/openapiDocuments/openapi_document": openapi_document +"/apigateway:v1beta/ApigatewayApiConfig/serviceConfigId": service_config_id +"/apigateway:v1beta/ApigatewayApiConfig/state": state +"/apigateway:v1beta/ApigatewayApiConfig/updateTime": update_time +"/apigateway:v1beta/ApigatewayApiConfigFile": apigateway_api_config_file +"/apigateway:v1beta/ApigatewayApiConfigFile/contents": contents +"/apigateway:v1beta/ApigatewayApiConfigFile/path": path +"/apigateway:v1beta/ApigatewayApiConfigGrpcServiceDefinition": apigateway_api_config_grpc_service_definition +"/apigateway:v1beta/ApigatewayApiConfigGrpcServiceDefinition/fileDescriptorSet": file_descriptor_set +"/apigateway:v1beta/ApigatewayApiConfigGrpcServiceDefinition/source": source +"/apigateway:v1beta/ApigatewayApiConfigGrpcServiceDefinition/source/source": source +"/apigateway:v1beta/ApigatewayApiConfigOpenApiDocument": apigateway_api_config_open_api_document +"/apigateway:v1beta/ApigatewayApiConfigOpenApiDocument/document": document +"/apigateway:v1beta/ApigatewayAuditConfig": apigateway_audit_config +"/apigateway:v1beta/ApigatewayAuditConfig/auditLogConfigs": audit_log_configs +"/apigateway:v1beta/ApigatewayAuditConfig/auditLogConfigs/audit_log_config": audit_log_config +"/apigateway:v1beta/ApigatewayAuditConfig/service": service +"/apigateway:v1beta/ApigatewayAuditLogConfig": apigateway_audit_log_config +"/apigateway:v1beta/ApigatewayAuditLogConfig/exemptedMembers": exempted_members +"/apigateway:v1beta/ApigatewayAuditLogConfig/exemptedMembers/exempted_member": exempted_member +"/apigateway:v1beta/ApigatewayAuditLogConfig/logType": log_type +"/apigateway:v1beta/ApigatewayBackendConfig": apigateway_backend_config +"/apigateway:v1beta/ApigatewayBackendConfig/googleServiceAccount": google_service_account +"/apigateway:v1beta/ApigatewayBinding": apigateway_binding +"/apigateway:v1beta/ApigatewayBinding/condition": condition +"/apigateway:v1beta/ApigatewayBinding/members": members +"/apigateway:v1beta/ApigatewayBinding/members/member": member +"/apigateway:v1beta/ApigatewayBinding/role": role +"/apigateway:v1beta/ApigatewayCancelOperationRequest": apigateway_cancel_operation_request +"/apigateway:v1beta/ApigatewayExpr": apigateway_expr +"/apigateway:v1beta/ApigatewayExpr/description": description +"/apigateway:v1beta/ApigatewayExpr/expression": expression +"/apigateway:v1beta/ApigatewayExpr/location": location +"/apigateway:v1beta/ApigatewayExpr/title": title +"/apigateway:v1beta/ApigatewayGateway": apigateway_gateway +"/apigateway:v1beta/ApigatewayGateway/apiConfig": api_config +"/apigateway:v1beta/ApigatewayGateway/createTime": create_time +"/apigateway:v1beta/ApigatewayGateway/defaultHostname": default_hostname +"/apigateway:v1beta/ApigatewayGateway/displayName": display_name +"/apigateway:v1beta/ApigatewayGateway/labels": labels +"/apigateway:v1beta/ApigatewayGateway/labels/label": label +"/apigateway:v1beta/ApigatewayGateway/name": name +"/apigateway:v1beta/ApigatewayGateway/state": state +"/apigateway:v1beta/ApigatewayGateway/updateTime": update_time +"/apigateway:v1beta/ApigatewayGatewayConfig": apigateway_gateway_config +"/apigateway:v1beta/ApigatewayGatewayConfig/backendConfig": backend_config +"/apigateway:v1beta/ApigatewayListApiConfigsResponse": apigateway_list_api_configs_response +"/apigateway:v1beta/ApigatewayListApiConfigsResponse/apiConfigs": api_configs +"/apigateway:v1beta/ApigatewayListApiConfigsResponse/apiConfigs/api_config": api_config +"/apigateway:v1beta/ApigatewayListApiConfigsResponse/nextPageToken": next_page_token +"/apigateway:v1beta/ApigatewayListApiConfigsResponse/unreachableLocations": unreachable_locations +"/apigateway:v1beta/ApigatewayListApiConfigsResponse/unreachableLocations/unreachable_location": unreachable_location +"/apigateway:v1beta/ApigatewayListApisResponse": apigateway_list_apis_response +"/apigateway:v1beta/ApigatewayListApisResponse/apis": apis +"/apigateway:v1beta/ApigatewayListApisResponse/apis/api": api +"/apigateway:v1beta/ApigatewayListApisResponse/nextPageToken": next_page_token +"/apigateway:v1beta/ApigatewayListApisResponse/unreachableLocations": unreachable_locations +"/apigateway:v1beta/ApigatewayListApisResponse/unreachableLocations/unreachable_location": unreachable_location +"/apigateway:v1beta/ApigatewayListGatewaysResponse": apigateway_list_gateways_response +"/apigateway:v1beta/ApigatewayListGatewaysResponse/gateways": gateways +"/apigateway:v1beta/ApigatewayListGatewaysResponse/gateways/gateway": gateway +"/apigateway:v1beta/ApigatewayListGatewaysResponse/nextPageToken": next_page_token +"/apigateway:v1beta/ApigatewayListGatewaysResponse/unreachableLocations": unreachable_locations +"/apigateway:v1beta/ApigatewayListGatewaysResponse/unreachableLocations/unreachable_location": unreachable_location +"/apigateway:v1beta/ApigatewayListLocationsResponse": apigateway_list_locations_response +"/apigateway:v1beta/ApigatewayListLocationsResponse/locations": locations +"/apigateway:v1beta/ApigatewayListLocationsResponse/locations/location": location +"/apigateway:v1beta/ApigatewayListLocationsResponse/nextPageToken": next_page_token +"/apigateway:v1beta/ApigatewayListOperationsResponse": apigateway_list_operations_response +"/apigateway:v1beta/ApigatewayListOperationsResponse/nextPageToken": next_page_token +"/apigateway:v1beta/ApigatewayListOperationsResponse/operations": operations +"/apigateway:v1beta/ApigatewayListOperationsResponse/operations/operation": operation +"/apigateway:v1beta/ApigatewayLocation": apigateway_location +"/apigateway:v1beta/ApigatewayLocation/displayName": display_name +"/apigateway:v1beta/ApigatewayLocation/labels": labels +"/apigateway:v1beta/ApigatewayLocation/labels/label": label +"/apigateway:v1beta/ApigatewayLocation/locationId": location_id +"/apigateway:v1beta/ApigatewayLocation/metadata": metadata +"/apigateway:v1beta/ApigatewayLocation/metadata/metadatum": metadatum +"/apigateway:v1beta/ApigatewayLocation/name": name +"/apigateway:v1beta/ApigatewayOperation": apigateway_operation +"/apigateway:v1beta/ApigatewayOperation/done": done +"/apigateway:v1beta/ApigatewayOperation/error": error +"/apigateway:v1beta/ApigatewayOperation/metadata": metadata +"/apigateway:v1beta/ApigatewayOperation/metadata/metadatum": metadatum +"/apigateway:v1beta/ApigatewayOperation/name": name +"/apigateway:v1beta/ApigatewayOperation/response": response +"/apigateway:v1beta/ApigatewayOperation/response/response": response +"/apigateway:v1beta/ApigatewayOperationMetadata": apigateway_operation_metadata +"/apigateway:v1beta/ApigatewayOperationMetadata/apiVersion": api_version +"/apigateway:v1beta/ApigatewayOperationMetadata/createTime": create_time +"/apigateway:v1beta/ApigatewayOperationMetadata/diagnostics": diagnostics +"/apigateway:v1beta/ApigatewayOperationMetadata/diagnostics/diagnostic": diagnostic +"/apigateway:v1beta/ApigatewayOperationMetadata/endTime": end_time +"/apigateway:v1beta/ApigatewayOperationMetadata/requestedCancellation": requested_cancellation +"/apigateway:v1beta/ApigatewayOperationMetadata/statusMessage": status_message +"/apigateway:v1beta/ApigatewayOperationMetadata/target": target +"/apigateway:v1beta/ApigatewayOperationMetadata/verb": verb +"/apigateway:v1beta/ApigatewayOperationMetadataDiagnostic": apigateway_operation_metadata_diagnostic +"/apigateway:v1beta/ApigatewayOperationMetadataDiagnostic/location": location +"/apigateway:v1beta/ApigatewayOperationMetadataDiagnostic/message": message +"/apigateway:v1beta/ApigatewayPolicy": apigateway_policy +"/apigateway:v1beta/ApigatewayPolicy/auditConfigs": audit_configs +"/apigateway:v1beta/ApigatewayPolicy/auditConfigs/audit_config": audit_config +"/apigateway:v1beta/ApigatewayPolicy/bindings": bindings +"/apigateway:v1beta/ApigatewayPolicy/bindings/binding": binding +"/apigateway:v1beta/ApigatewayPolicy/etag": etag +"/apigateway:v1beta/ApigatewayPolicy/version": version +"/apigateway:v1beta/ApigatewaySetIamPolicyRequest": apigateway_set_iam_policy_request +"/apigateway:v1beta/ApigatewaySetIamPolicyRequest/policy": policy +"/apigateway:v1beta/ApigatewaySetIamPolicyRequest/updateMask": update_mask +"/apigateway:v1beta/ApigatewayStatus": apigateway_status +"/apigateway:v1beta/ApigatewayStatus/code": code +"/apigateway:v1beta/ApigatewayStatus/details": details +"/apigateway:v1beta/ApigatewayStatus/details/detail": detail +"/apigateway:v1beta/ApigatewayStatus/details/detail/detail": detail +"/apigateway:v1beta/ApigatewayStatus/message": message +"/apigateway:v1beta/ApigatewayTestIamPermissionsRequest": apigateway_test_iam_permissions_request +"/apigateway:v1beta/ApigatewayTestIamPermissionsRequest/permissions": permissions +"/apigateway:v1beta/ApigatewayTestIamPermissionsRequest/permissions/permission": permission +"/apigateway:v1beta/ApigatewayTestIamPermissionsResponse": apigateway_test_iam_permissions_response +"/apigateway:v1beta/ApigatewayTestIamPermissionsResponse/permissions": permissions +"/apigateway:v1beta/ApigatewayTestIamPermissionsResponse/permissions/permission": permission +"/apigateway:v1beta/Empty": empty +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.create": create_project_location_api_config +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.create/apiConfigId": api_config_id +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.create/parent": parent +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.delete": delete_project_location_api_config +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.delete/name": name +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.get": get_project_location_api_config +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.get/name": name +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.get/view": view +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.getIamPolicy": get_project_location_api_config_iam_policy +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.getIamPolicy/options.requestedPolicyVersion": options_requested_policy_version +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.getIamPolicy/resource": resource +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.list": list_project_location_api_configs +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.list/filter": filter +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.list/orderBy": order_by +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.list/pageSize": page_size +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.list/pageToken": page_token +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.list/parent": parent +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.patch": patch_project_location_api_config +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.patch/name": name +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.patch/updateMask": update_mask +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.setIamPolicy": set_project_location_api_config_iam_policy +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.setIamPolicy/resource": resource +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.testIamPermissions": test_project_location_api_config_iam_permissions +"/apigateway:v1beta/apigateway.projects.locations.apis.configs.testIamPermissions/resource": resource +"/apigateway:v1beta/apigateway.projects.locations.apis.create": create_project_location_api +"/apigateway:v1beta/apigateway.projects.locations.apis.create/apiId": api_id +"/apigateway:v1beta/apigateway.projects.locations.apis.create/parent": parent +"/apigateway:v1beta/apigateway.projects.locations.apis.delete": delete_project_location_api +"/apigateway:v1beta/apigateway.projects.locations.apis.delete/name": name +"/apigateway:v1beta/apigateway.projects.locations.apis.get": get_project_location_api +"/apigateway:v1beta/apigateway.projects.locations.apis.get/name": name +"/apigateway:v1beta/apigateway.projects.locations.apis.getIamPolicy": get_project_location_api_iam_policy +"/apigateway:v1beta/apigateway.projects.locations.apis.getIamPolicy/options.requestedPolicyVersion": options_requested_policy_version +"/apigateway:v1beta/apigateway.projects.locations.apis.getIamPolicy/resource": resource +"/apigateway:v1beta/apigateway.projects.locations.apis.list": list_project_location_apis +"/apigateway:v1beta/apigateway.projects.locations.apis.list/filter": filter +"/apigateway:v1beta/apigateway.projects.locations.apis.list/orderBy": order_by +"/apigateway:v1beta/apigateway.projects.locations.apis.list/pageSize": page_size +"/apigateway:v1beta/apigateway.projects.locations.apis.list/pageToken": page_token +"/apigateway:v1beta/apigateway.projects.locations.apis.list/parent": parent +"/apigateway:v1beta/apigateway.projects.locations.apis.patch": patch_project_location_api +"/apigateway:v1beta/apigateway.projects.locations.apis.patch/name": name +"/apigateway:v1beta/apigateway.projects.locations.apis.patch/updateMask": update_mask +"/apigateway:v1beta/apigateway.projects.locations.apis.setIamPolicy": set_project_location_api_iam_policy +"/apigateway:v1beta/apigateway.projects.locations.apis.setIamPolicy/resource": resource +"/apigateway:v1beta/apigateway.projects.locations.apis.testIamPermissions": test_project_location_api_iam_permissions +"/apigateway:v1beta/apigateway.projects.locations.apis.testIamPermissions/resource": resource +"/apigateway:v1beta/apigateway.projects.locations.gateways.create": create_project_location_gateway +"/apigateway:v1beta/apigateway.projects.locations.gateways.create/gatewayId": gateway_id +"/apigateway:v1beta/apigateway.projects.locations.gateways.create/parent": parent +"/apigateway:v1beta/apigateway.projects.locations.gateways.delete": delete_project_location_gateway +"/apigateway:v1beta/apigateway.projects.locations.gateways.delete/name": name +"/apigateway:v1beta/apigateway.projects.locations.gateways.get": get_project_location_gateway +"/apigateway:v1beta/apigateway.projects.locations.gateways.get/name": name +"/apigateway:v1beta/apigateway.projects.locations.gateways.getIamPolicy": get_project_location_gateway_iam_policy +"/apigateway:v1beta/apigateway.projects.locations.gateways.getIamPolicy/options.requestedPolicyVersion": options_requested_policy_version +"/apigateway:v1beta/apigateway.projects.locations.gateways.getIamPolicy/resource": resource +"/apigateway:v1beta/apigateway.projects.locations.gateways.list": list_project_location_gateways +"/apigateway:v1beta/apigateway.projects.locations.gateways.list/filter": filter +"/apigateway:v1beta/apigateway.projects.locations.gateways.list/orderBy": order_by +"/apigateway:v1beta/apigateway.projects.locations.gateways.list/pageSize": page_size +"/apigateway:v1beta/apigateway.projects.locations.gateways.list/pageToken": page_token +"/apigateway:v1beta/apigateway.projects.locations.gateways.list/parent": parent +"/apigateway:v1beta/apigateway.projects.locations.gateways.patch": patch_project_location_gateway +"/apigateway:v1beta/apigateway.projects.locations.gateways.patch/name": name +"/apigateway:v1beta/apigateway.projects.locations.gateways.patch/updateMask": update_mask +"/apigateway:v1beta/apigateway.projects.locations.gateways.setIamPolicy": set_project_location_gateway_iam_policy +"/apigateway:v1beta/apigateway.projects.locations.gateways.setIamPolicy/resource": resource +"/apigateway:v1beta/apigateway.projects.locations.gateways.testIamPermissions": test_project_location_gateway_iam_permissions +"/apigateway:v1beta/apigateway.projects.locations.gateways.testIamPermissions/resource": resource +"/apigateway:v1beta/apigateway.projects.locations.get": get_project_location +"/apigateway:v1beta/apigateway.projects.locations.get/name": name +"/apigateway:v1beta/apigateway.projects.locations.list": list_project_locations +"/apigateway:v1beta/apigateway.projects.locations.list/filter": filter +"/apigateway:v1beta/apigateway.projects.locations.list/name": name +"/apigateway:v1beta/apigateway.projects.locations.list/pageSize": page_size +"/apigateway:v1beta/apigateway.projects.locations.list/pageToken": page_token +"/apigateway:v1beta/apigateway.projects.locations.operations.cancel": cancel_project_location_operation +"/apigateway:v1beta/apigateway.projects.locations.operations.cancel/name": name +"/apigateway:v1beta/apigateway.projects.locations.operations.delete": delete_project_location_operation +"/apigateway:v1beta/apigateway.projects.locations.operations.delete/name": name +"/apigateway:v1beta/apigateway.projects.locations.operations.get": get_project_location_operation +"/apigateway:v1beta/apigateway.projects.locations.operations.get/name": name +"/apigateway:v1beta/apigateway.projects.locations.operations.list": list_project_location_operations +"/apigateway:v1beta/apigateway.projects.locations.operations.list/filter": filter +"/apigateway:v1beta/apigateway.projects.locations.operations.list/name": name +"/apigateway:v1beta/apigateway.projects.locations.operations.list/pageSize": page_size +"/apigateway:v1beta/apigateway.projects.locations.operations.list/pageToken": page_token +"/apigateway:v1beta/fields": fields +"/apigateway:v1beta/key": key +"/apigateway:v1beta/quotaUser": quota_user "/apigee:v1/GoogleApiHttpBody": google_api_http_body "/apigee:v1/GoogleApiHttpBody/contentType": content_type "/apigee:v1/GoogleApiHttpBody/data": data @@ -10979,6 +11559,8 @@ "/appengine:v1/Network/name": name "/appengine:v1/Network/sessionAffinity": session_affinity "/appengine:v1/Network/subnetworkName": subnetwork_name +"/appengine:v1/NetworkSettings": network_settings +"/appengine:v1/NetworkSettings/ingressTrafficAllowed": ingress_traffic_allowed "/appengine:v1/NetworkUtilization": network_utilization "/appengine:v1/NetworkUtilization/targetReceivedBytesPerSecond": target_received_bytes_per_second "/appengine:v1/NetworkUtilization/targetReceivedPacketsPerSecond": target_received_packets_per_second @@ -11069,6 +11651,7 @@ "/appengine:v1/Service": service "/appengine:v1/Service/id": id "/appengine:v1/Service/name": name +"/appengine:v1/Service/networkSettings": network_settings "/appengine:v1/Service/split": split "/appengine:v1/SslSettings": ssl_settings "/appengine:v1/SslSettings/certificateId": certificate_id @@ -11667,6 +12250,7 @@ "/appengine:v1beta/Instance/vmDebugEnabled": vm_debug_enabled "/appengine:v1beta/Instance/vmId": vm_id "/appengine:v1beta/Instance/vmIp": vm_ip +"/appengine:v1beta/Instance/vmLiveness": vm_liveness "/appengine:v1beta/Instance/vmName": vm_name "/appengine:v1beta/Instance/vmStatus": vm_status "/appengine:v1beta/Instance/vmZoneName": vm_zone_name @@ -11740,6 +12324,8 @@ "/appengine:v1beta/Network/name": name "/appengine:v1beta/Network/sessionAffinity": session_affinity "/appengine:v1beta/Network/subnetworkName": subnetwork_name +"/appengine:v1beta/NetworkSettings": network_settings +"/appengine:v1beta/NetworkSettings/ingressTrafficAllowed": ingress_traffic_allowed "/appengine:v1beta/NetworkUtilization": network_utilization "/appengine:v1beta/NetworkUtilization/targetReceivedBytesPerSecond": target_received_bytes_per_second "/appengine:v1beta/NetworkUtilization/targetReceivedPacketsPerSecond": target_received_packets_per_second @@ -11834,6 +12420,7 @@ "/appengine:v1beta/Service": service "/appengine:v1beta/Service/id": id "/appengine:v1beta/Service/name": name +"/appengine:v1beta/Service/networkSettings": network_settings "/appengine:v1beta/Service/split": split "/appengine:v1beta/SslSettings": ssl_settings "/appengine:v1beta/SslSettings/certificateId": certificate_id @@ -13717,6 +14304,7 @@ "/bigquery:v2/JobStatistics/startTime": start_time "/bigquery:v2/JobStatistics/totalBytesProcessed": total_bytes_processed "/bigquery:v2/JobStatistics/totalSlotMs": total_slot_ms +"/bigquery:v2/JobStatistics/transactionInfoTemplate": transaction_info_template "/bigquery:v2/JobStatistics2": job_statistics2 "/bigquery:v2/JobStatistics2/billingTier": billing_tier "/bigquery:v2/JobStatistics2/cacheHit": cache_hit @@ -14158,6 +14746,8 @@ "/bigquery:v2/TrainingRun/trainingOptions/maxIteration": max_iteration "/bigquery:v2/TrainingRun/trainingOptions/minRelProgress": min_rel_progress "/bigquery:v2/TrainingRun/trainingOptions/warmStart": warm_start +"/bigquery:v2/TransactionInfo": transaction_info +"/bigquery:v2/TransactionInfo/transactionId": transaction_id "/bigquery:v2/UserDefinedFunctionResource": user_defined_function_resource "/bigquery:v2/UserDefinedFunctionResource/inlineCode": inline_code "/bigquery:v2/UserDefinedFunctionResource/resourceUri": resource_uri @@ -15569,6 +16159,7 @@ "/binaryauthorization:v1/AttestorPublicKey/id": id "/binaryauthorization:v1/AttestorPublicKey/pkixPublicKey": pkix_public_key "/binaryauthorization:v1/Binding": binding +"/binaryauthorization:v1/Binding/bindingId": binding_id "/binaryauthorization:v1/Binding/condition": condition "/binaryauthorization:v1/Binding/members": members "/binaryauthorization:v1/Binding/members/member": member @@ -15666,6 +16257,7 @@ "/binaryauthorization:v1beta1/AttestorPublicKey/id": id "/binaryauthorization:v1beta1/AttestorPublicKey/pkixPublicKey": pkix_public_key "/binaryauthorization:v1beta1/Binding": binding +"/binaryauthorization:v1beta1/Binding/bindingId": binding_id "/binaryauthorization:v1beta1/Binding/condition": condition "/binaryauthorization:v1beta1/Binding/members": members "/binaryauthorization:v1beta1/Binding/members/member": member @@ -17867,6 +18459,8 @@ "/civicinfo:v2/AdministrativeBody/ballotInfoUrl": ballot_info_url "/civicinfo:v2/AdministrativeBody/correspondenceAddress": correspondence_address "/civicinfo:v2/AdministrativeBody/electionInfoUrl": election_info_url +"/civicinfo:v2/AdministrativeBody/electionNoticeText": election_notice_text +"/civicinfo:v2/AdministrativeBody/electionNoticeUrl": election_notice_url "/civicinfo:v2/AdministrativeBody/electionOfficials": election_officials "/civicinfo:v2/AdministrativeBody/electionOfficials/election_official": election_official "/civicinfo:v2/AdministrativeBody/electionRegistrationConfirmationUrl": election_registration_confirmation_url @@ -19645,6 +20239,7 @@ "/cloudbuild:v1/Build/images/image": image "/cloudbuild:v1/Build/logUrl": log_url "/cloudbuild:v1/Build/logsBucket": logs_bucket +"/cloudbuild:v1/Build/name": name "/cloudbuild:v1/Build/options": options "/cloudbuild:v1/Build/projectId": project_id "/cloudbuild:v1/Build/queueTtl": queue_ttl @@ -19727,8 +20322,14 @@ "/cloudbuild:v1/BuiltImage/name": name "/cloudbuild:v1/BuiltImage/pushTiming": push_timing "/cloudbuild:v1/CancelBuildRequest": cancel_build_request +"/cloudbuild:v1/CancelBuildRequest/id": id +"/cloudbuild:v1/CancelBuildRequest/name": name +"/cloudbuild:v1/CancelBuildRequest/projectId": project_id "/cloudbuild:v1/CancelOperationRequest": cancel_operation_request "/cloudbuild:v1/CheckSuiteFilter": check_suite_filter +"/cloudbuild:v1/CreateBuildRequest": create_build_request +"/cloudbuild:v1/CreateBuildRequest/build": build +"/cloudbuild:v1/CreateBuildRequest/projectId": project_id "/cloudbuild:v1/Empty": empty "/cloudbuild:v1/FileHashes": file_hashes "/cloudbuild:v1/FileHashes/fileHash": file_hash @@ -19818,6 +20419,9 @@ "/cloudbuild:v1/Results/images/image": image "/cloudbuild:v1/Results/numArtifacts": num_artifacts "/cloudbuild:v1/RetryBuildRequest": retry_build_request +"/cloudbuild:v1/RetryBuildRequest/id": id +"/cloudbuild:v1/RetryBuildRequest/name": name +"/cloudbuild:v1/RetryBuildRequest/projectId": project_id "/cloudbuild:v1/SMTPDelivery": smtp_delivery "/cloudbuild:v1/SMTPDelivery/fromAddress": from_address "/cloudbuild:v1/SMTPDelivery/password": password @@ -19869,18 +20473,37 @@ "/cloudbuild:v1/cloudbuild.projects.builds.cancel/id": id "/cloudbuild:v1/cloudbuild.projects.builds.cancel/projectId": project_id "/cloudbuild:v1/cloudbuild.projects.builds.create": create_project_build +"/cloudbuild:v1/cloudbuild.projects.builds.create/parent": parent "/cloudbuild:v1/cloudbuild.projects.builds.create/projectId": project_id "/cloudbuild:v1/cloudbuild.projects.builds.get": get_project_build "/cloudbuild:v1/cloudbuild.projects.builds.get/id": id +"/cloudbuild:v1/cloudbuild.projects.builds.get/name": name "/cloudbuild:v1/cloudbuild.projects.builds.get/projectId": project_id "/cloudbuild:v1/cloudbuild.projects.builds.list": list_project_builds "/cloudbuild:v1/cloudbuild.projects.builds.list/filter": filter "/cloudbuild:v1/cloudbuild.projects.builds.list/pageSize": page_size "/cloudbuild:v1/cloudbuild.projects.builds.list/pageToken": page_token +"/cloudbuild:v1/cloudbuild.projects.builds.list/parent": parent "/cloudbuild:v1/cloudbuild.projects.builds.list/projectId": project_id "/cloudbuild:v1/cloudbuild.projects.builds.retry": retry_build "/cloudbuild:v1/cloudbuild.projects.builds.retry/id": id "/cloudbuild:v1/cloudbuild.projects.builds.retry/projectId": project_id +"/cloudbuild:v1/cloudbuild.projects.locations.builds.cancel": cancel_project_location_build +"/cloudbuild:v1/cloudbuild.projects.locations.builds.cancel/name": name +"/cloudbuild:v1/cloudbuild.projects.locations.builds.create": create_build +"/cloudbuild:v1/cloudbuild.projects.locations.builds.create/parent": parent +"/cloudbuild:v1/cloudbuild.projects.locations.builds.get": get_project_location_build +"/cloudbuild:v1/cloudbuild.projects.locations.builds.get/id": id +"/cloudbuild:v1/cloudbuild.projects.locations.builds.get/name": name +"/cloudbuild:v1/cloudbuild.projects.locations.builds.get/projectId": project_id +"/cloudbuild:v1/cloudbuild.projects.locations.builds.list": list_project_location_builds +"/cloudbuild:v1/cloudbuild.projects.locations.builds.list/filter": filter +"/cloudbuild:v1/cloudbuild.projects.locations.builds.list/pageSize": page_size +"/cloudbuild:v1/cloudbuild.projects.locations.builds.list/pageToken": page_token +"/cloudbuild:v1/cloudbuild.projects.locations.builds.list/parent": parent +"/cloudbuild:v1/cloudbuild.projects.locations.builds.list/projectId": project_id +"/cloudbuild:v1/cloudbuild.projects.locations.builds.retry": retry_project_location_build +"/cloudbuild:v1/cloudbuild.projects.locations.builds.retry/name": name "/cloudbuild:v1/cloudbuild.projects.locations.operations.cancel": cancel_project_location_operation "/cloudbuild:v1/cloudbuild.projects.locations.operations.cancel/name": name "/cloudbuild:v1/cloudbuild.projects.locations.operations.get": get_project_location_operation @@ -19929,6 +20552,7 @@ "/cloudbuild:v1alpha1/Build/images/image": image "/cloudbuild:v1alpha1/Build/logUrl": log_url "/cloudbuild:v1alpha1/Build/logsBucket": logs_bucket +"/cloudbuild:v1alpha1/Build/name": name "/cloudbuild:v1alpha1/Build/options": options "/cloudbuild:v1alpha1/Build/projectId": project_id "/cloudbuild:v1alpha1/Build/queueTtl": queue_ttl @@ -20156,6 +20780,7 @@ "/cloudbuild:v1alpha2/Build/images/image": image "/cloudbuild:v1alpha2/Build/logUrl": log_url "/cloudbuild:v1alpha2/Build/logsBucket": logs_bucket +"/cloudbuild:v1alpha2/Build/name": name "/cloudbuild:v1alpha2/Build/options": options "/cloudbuild:v1alpha2/Build/projectId": project_id "/cloudbuild:v1alpha2/Build/queueTtl": queue_ttl @@ -21022,12 +21647,20 @@ "/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1AndroidAttributes/ownerProfileAccount": owner_profile_account "/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1AndroidAttributes/ownershipPrivilege": ownership_privilege "/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1AndroidAttributes/supportsWorkProfile": supports_work_profile +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest": google_apps_cloudidentity_devices_v1_approve_device_user_request +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest/customer": customer "/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1ApproveDeviceUserResponse": google_apps_cloudidentity_devices_v1_approve_device_user_response "/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1ApproveDeviceUserResponse/deviceUser": device_user +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest": google_apps_cloudidentity_devices_v1_block_device_user_request +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest/customer": customer "/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1BlockDeviceUserResponse": google_apps_cloudidentity_devices_v1_block_device_user_response "/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1BlockDeviceUserResponse/deviceUser": device_user +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest": google_apps_cloudidentity_devices_v1_cancel_wipe_device_request +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest/customer": customer "/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1CancelWipeDeviceResponse": google_apps_cloudidentity_devices_v1_cancel_wipe_device_response "/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1CancelWipeDeviceResponse/device": device +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest": google_apps_cloudidentity_devices_v1_cancel_wipe_device_user_request +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest/customer": customer "/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserResponse": google_apps_cloudidentity_devices_v1_cancel_wipe_device_user_response "/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserResponse/deviceUser": device_user "/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1ClientState": google_apps_cloudidentity_devices_v1_client_state @@ -21091,8 +21724,29 @@ "/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1DeviceUser/passwordState": password_state "/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1DeviceUser/userAgent": user_agent "/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1DeviceUser/userEmail": user_email +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1ListClientStatesResponse": google_apps_cloudidentity_devices_v1_list_client_states_response +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1ListClientStatesResponse/clientStates": client_states +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1ListClientStatesResponse/clientStates/client_state": client_state +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1ListClientStatesResponse/nextPageToken": next_page_token +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse": google_apps_cloudidentity_devices_v1_list_device_users_response +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse/deviceUsers": device_users +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse/deviceUsers/device_user": device_user +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse/nextPageToken": next_page_token +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1ListDevicesResponse": google_apps_cloudidentity_devices_v1_list_devices_response +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1ListDevicesResponse/devices": devices +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1ListDevicesResponse/devices/device": device +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1ListDevicesResponse/nextPageToken": next_page_token +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse": google_apps_cloudidentity_devices_v1_lookup_self_device_users_response +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse/customer": customer +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse/names": names +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse/names/name": name +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse/nextPageToken": next_page_token +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1WipeDeviceRequest": google_apps_cloudidentity_devices_v1_wipe_device_request +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1WipeDeviceRequest/customer": customer "/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1WipeDeviceResponse": google_apps_cloudidentity_devices_v1_wipe_device_response "/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1WipeDeviceResponse/device": device +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest": google_apps_cloudidentity_devices_v1_wipe_device_user_request +"/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest/customer": customer "/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1WipeDeviceUserResponse": google_apps_cloudidentity_devices_v1_wipe_device_user_response "/cloudidentity:v1/GoogleAppsCloudidentityDevicesV1WipeDeviceUserResponse/deviceUser": device_user "/cloudidentity:v1/Group": group @@ -21123,6 +21777,7 @@ "/cloudidentity:v1/Membership/preferredMemberKey": preferred_member_key "/cloudidentity:v1/Membership/roles": roles "/cloudidentity:v1/Membership/roles/role": role +"/cloudidentity:v1/Membership/type": type "/cloudidentity:v1/Membership/updateTime": update_time "/cloudidentity:v1/MembershipRole": membership_role "/cloudidentity:v1/MembershipRole/name": name @@ -21148,6 +21803,66 @@ "/cloudidentity:v1/WipeDeviceResponse/device": device "/cloudidentity:v1/WipeDeviceUserResponse": wipe_device_user_response "/cloudidentity:v1/WipeDeviceUserResponse/deviceUser": device_user +"/cloudidentity:v1/cloudidentity.devices.cancelWipe": cancel_device_wipe +"/cloudidentity:v1/cloudidentity.devices.cancelWipe/name": name +"/cloudidentity:v1/cloudidentity.devices.create": create_device +"/cloudidentity:v1/cloudidentity.devices.create/customer": customer +"/cloudidentity:v1/cloudidentity.devices.delete": delete_device +"/cloudidentity:v1/cloudidentity.devices.delete/customer": customer +"/cloudidentity:v1/cloudidentity.devices.delete/name": name +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.approve": approve_device_device_user +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.approve/name": name +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.block": block_device_device_user +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.block/name": name +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.cancelWipe": cancel_device_device_user_wipe +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.cancelWipe/name": name +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.clientStates.get": get_device_device_user_client_state +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.clientStates.get/customer": customer +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.clientStates.get/name": name +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.clientStates.list": list_device_device_user_client_states +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.clientStates.list/customer": customer +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.clientStates.list/filter": filter +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.clientStates.list/orderBy": order_by +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.clientStates.list/pageToken": page_token +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.clientStates.list/parent": parent +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.clientStates.patch": patch_device_device_user_client_state +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.clientStates.patch/customer": customer +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.clientStates.patch/name": name +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.clientStates.patch/updateMask": update_mask +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.delete": delete_device_device_user +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.delete/customer": customer +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.delete/name": name +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.get": get_device_device_user +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.get/customer": customer +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.get/name": name +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.list": list_device_device_users +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.list/customer": customer +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.list/filter": filter +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.list/orderBy": order_by +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.list/pageSize": page_size +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.list/pageToken": page_token +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.list/parent": parent +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.lookup": lookup_device_device_user +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.lookup/androidId": android_id +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.lookup/pageSize": page_size +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.lookup/pageToken": page_token +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.lookup/parent": parent +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.lookup/rawResourceId": raw_resource_id +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.lookup/userId": user_id +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.wipe": wipe_device_device_user +"/cloudidentity:v1/cloudidentity.devices.deviceUsers.wipe/name": name +"/cloudidentity:v1/cloudidentity.devices.get": get_device +"/cloudidentity:v1/cloudidentity.devices.get/customer": customer +"/cloudidentity:v1/cloudidentity.devices.get/name": name +"/cloudidentity:v1/cloudidentity.devices.list": list_devices +"/cloudidentity:v1/cloudidentity.devices.list/customer": customer +"/cloudidentity:v1/cloudidentity.devices.list/filter": filter +"/cloudidentity:v1/cloudidentity.devices.list/orderBy": order_by +"/cloudidentity:v1/cloudidentity.devices.list/pageSize": page_size +"/cloudidentity:v1/cloudidentity.devices.list/pageToken": page_token +"/cloudidentity:v1/cloudidentity.devices.list/view": view +"/cloudidentity:v1/cloudidentity.devices.wipe": wipe_device +"/cloudidentity:v1/cloudidentity.devices.wipe/name": name "/cloudidentity:v1/cloudidentity.groups.create": create_group "/cloudidentity:v1/cloudidentity.groups.delete": delete_group "/cloudidentity:v1/cloudidentity.groups.delete/name": name @@ -21588,6 +22303,7 @@ "/cloudiot:v1/BindDeviceToGatewayRequest/gatewayId": gateway_id "/cloudiot:v1/BindDeviceToGatewayResponse": bind_device_to_gateway_response "/cloudiot:v1/Binding": binding +"/cloudiot:v1/Binding/bindingId": binding_id "/cloudiot:v1/Binding/condition": condition "/cloudiot:v1/Binding/members": members "/cloudiot:v1/Binding/members/member": member @@ -22720,6 +23436,7 @@ "/cloudresourcemanager:v1/AuditLogConfig/exemptedMembers/exempted_member": exempted_member "/cloudresourcemanager:v1/AuditLogConfig/logType": log_type "/cloudresourcemanager:v1/Binding": binding +"/cloudresourcemanager:v1/Binding/bindingId": binding_id "/cloudresourcemanager:v1/Binding/condition": condition "/cloudresourcemanager:v1/Binding/members": members "/cloudresourcemanager:v1/Binding/members/member": member @@ -22969,6 +23686,7 @@ "/cloudresourcemanager:v1beta1/AuditLogConfig/exemptedMembers/exempted_member": exempted_member "/cloudresourcemanager:v1beta1/AuditLogConfig/logType": log_type "/cloudresourcemanager:v1beta1/Binding": binding +"/cloudresourcemanager:v1beta1/Binding/bindingId": binding_id "/cloudresourcemanager:v1beta1/Binding/condition": condition "/cloudresourcemanager:v1beta1/Binding/members": members "/cloudresourcemanager:v1beta1/Binding/members/member": member @@ -23093,6 +23811,7 @@ "/cloudresourcemanager:v2/AuditLogConfig/exemptedMembers/exempted_member": exempted_member "/cloudresourcemanager:v2/AuditLogConfig/logType": log_type "/cloudresourcemanager:v2/Binding": binding +"/cloudresourcemanager:v2/Binding/bindingId": binding_id "/cloudresourcemanager:v2/Binding/condition": condition "/cloudresourcemanager:v2/Binding/members": members "/cloudresourcemanager:v2/Binding/members/member": member @@ -23207,6 +23926,7 @@ "/cloudresourcemanager:v2beta1/AuditLogConfig/exemptedMembers/exempted_member": exempted_member "/cloudresourcemanager:v2beta1/AuditLogConfig/logType": log_type "/cloudresourcemanager:v2beta1/Binding": binding +"/cloudresourcemanager:v2beta1/Binding/bindingId": binding_id "/cloudresourcemanager:v2beta1/Binding/condition": condition "/cloudresourcemanager:v2beta1/Binding/members": members "/cloudresourcemanager:v2beta1/Binding/members/member": member @@ -50246,10 +50966,15 @@ "/container:v1/AutoUpgradeOptions/autoUpgradeStartTime": auto_upgrade_start_time "/container:v1/AutoUpgradeOptions/description": description "/container:v1/AutoprovisioningNodePoolDefaults": autoprovisioning_node_pool_defaults +"/container:v1/AutoprovisioningNodePoolDefaults/bootDiskKmsKey": boot_disk_kms_key +"/container:v1/AutoprovisioningNodePoolDefaults/diskSizeGb": disk_size_gb +"/container:v1/AutoprovisioningNodePoolDefaults/diskType": disk_type "/container:v1/AutoprovisioningNodePoolDefaults/management": management +"/container:v1/AutoprovisioningNodePoolDefaults/minCpuPlatform": min_cpu_platform "/container:v1/AutoprovisioningNodePoolDefaults/oauthScopes": oauth_scopes "/container:v1/AutoprovisioningNodePoolDefaults/oauthScopes/oauth_scope": oauth_scope "/container:v1/AutoprovisioningNodePoolDefaults/serviceAccount": service_account +"/container:v1/AutoprovisioningNodePoolDefaults/shieldedInstanceConfig": shielded_instance_config "/container:v1/AutoprovisioningNodePoolDefaults/upgradeSettings": upgrade_settings "/container:v1/BigQueryDestination": big_query_destination "/container:v1/BigQueryDestination/datasetId": dataset_id @@ -50267,6 +50992,7 @@ "/container:v1/ClientCertificateConfig/issueClientCertificate": issue_client_certificate "/container:v1/CloudRunConfig": cloud_run_config "/container:v1/CloudRunConfig/disabled": disabled +"/container:v1/CloudRunConfig/loadBalancerType": load_balancer_type "/container:v1/Cluster": cluster "/container:v1/Cluster/addonsConfig": addons_config "/container:v1/Cluster/authenticatorGroupsConfig": authenticator_groups_config @@ -51030,11 +51756,15 @@ "/container:v1beta1/AutoUpgradeOptions/autoUpgradeStartTime": auto_upgrade_start_time "/container:v1beta1/AutoUpgradeOptions/description": description "/container:v1beta1/AutoprovisioningNodePoolDefaults": autoprovisioning_node_pool_defaults +"/container:v1beta1/AutoprovisioningNodePoolDefaults/bootDiskKmsKey": boot_disk_kms_key +"/container:v1beta1/AutoprovisioningNodePoolDefaults/diskSizeGb": disk_size_gb +"/container:v1beta1/AutoprovisioningNodePoolDefaults/diskType": disk_type "/container:v1beta1/AutoprovisioningNodePoolDefaults/management": management "/container:v1beta1/AutoprovisioningNodePoolDefaults/minCpuPlatform": min_cpu_platform "/container:v1beta1/AutoprovisioningNodePoolDefaults/oauthScopes": oauth_scopes "/container:v1beta1/AutoprovisioningNodePoolDefaults/oauthScopes/oauth_scope": oauth_scope "/container:v1beta1/AutoprovisioningNodePoolDefaults/serviceAccount": service_account +"/container:v1beta1/AutoprovisioningNodePoolDefaults/shieldedInstanceConfig": shielded_instance_config "/container:v1beta1/AutoprovisioningNodePoolDefaults/upgradeSettings": upgrade_settings "/container:v1beta1/AvailableVersion": available_version "/container:v1beta1/AvailableVersion/reason": reason @@ -51055,6 +51785,7 @@ "/container:v1beta1/ClientCertificateConfig/issueClientCertificate": issue_client_certificate "/container:v1beta1/CloudRunConfig": cloud_run_config "/container:v1beta1/CloudRunConfig/disabled": disabled +"/container:v1beta1/CloudRunConfig/loadBalancerType": load_balancer_type "/container:v1beta1/Cluster": cluster "/container:v1beta1/Cluster/addonsConfig": addons_config "/container:v1beta1/Cluster/authenticatorGroupsConfig": authenticator_groups_config @@ -51917,6 +52648,7 @@ "/containeranalysis:v1alpha1/Basis/fingerprint": fingerprint "/containeranalysis:v1alpha1/Basis/resourceUrl": resource_url "/containeranalysis:v1alpha1/Binding": binding +"/containeranalysis:v1alpha1/Binding/bindingId": binding_id "/containeranalysis:v1alpha1/Binding/condition": condition "/containeranalysis:v1alpha1/Binding/members": members "/containeranalysis:v1alpha1/Binding/members/member": member @@ -52380,6 +53112,7 @@ "/containeranalysis:v1beta1/BatchCreateOccurrencesResponse/occurrences": occurrences "/containeranalysis:v1beta1/BatchCreateOccurrencesResponse/occurrences/occurrence": occurrence "/containeranalysis:v1beta1/Binding": binding +"/containeranalysis:v1beta1/Binding/bindingId": binding_id "/containeranalysis:v1beta1/Binding/condition": condition "/containeranalysis:v1beta1/Binding/members": members "/containeranalysis:v1beta1/Binding/members/member": member @@ -53675,6 +54408,7 @@ "/content:v2.1/OrderreturnsRefundOperation": orderreturns_refund_operation "/content:v2.1/OrderreturnsRefundOperation/fullRefund": full_refund "/content:v2.1/OrderreturnsRefundOperation/partialRefund": partial_refund +"/content:v2.1/OrderreturnsRefundOperation/paymentType": payment_type "/content:v2.1/OrderreturnsRefundOperation/reasonText": reason_text "/content:v2.1/OrderreturnsRefundOperation/returnRefundReason": return_refund_reason "/content:v2.1/OrderreturnsRejectOperation": orderreturns_reject_operation @@ -57999,6 +58733,7 @@ "/customsearch:v1/search.cse.siterestrict.list/start": start "/customsearch:v1/userIp": user_ip "/datacatalog:v1beta1/Binding": binding +"/datacatalog:v1beta1/Binding/bindingId": binding_id "/datacatalog:v1beta1/Binding/condition": condition "/datacatalog:v1beta1/Binding/members": members "/datacatalog:v1beta1/Binding/members/member": member @@ -59535,6 +60270,7 @@ "/datafusion:v1/AuditLogConfig/exemptedMembers/exempted_member": exempted_member "/datafusion:v1/AuditLogConfig/logType": log_type "/datafusion:v1/Binding": binding +"/datafusion:v1/Binding/bindingId": binding_id "/datafusion:v1/Binding/condition": condition "/datafusion:v1/Binding/members": members "/datafusion:v1/Binding/members/member": member @@ -59553,6 +60289,7 @@ "/datafusion:v1/Instance/availableVersion": available_version "/datafusion:v1/Instance/availableVersion/available_version": available_version "/datafusion:v1/Instance/createTime": create_time +"/datafusion:v1/Instance/dataprocServiceAccount": dataproc_service_account "/datafusion:v1/Instance/description": description "/datafusion:v1/Instance/displayName": display_name "/datafusion:v1/Instance/enableStackdriverLogging": enable_stackdriver_logging @@ -59715,6 +60452,7 @@ "/datafusion:v1beta1/AuthorizationLoggingOptions": authorization_logging_options "/datafusion:v1beta1/AuthorizationLoggingOptions/permissionType": permission_type "/datafusion:v1beta1/Binding": binding +"/datafusion:v1beta1/Binding/bindingId": binding_id "/datafusion:v1beta1/Binding/condition": condition "/datafusion:v1beta1/Binding/members": members "/datafusion:v1beta1/Binding/members/member": member @@ -59748,6 +60486,7 @@ "/datafusion:v1beta1/Instance/availableVersion": available_version "/datafusion:v1beta1/Instance/availableVersion/available_version": available_version "/datafusion:v1beta1/Instance/createTime": create_time +"/datafusion:v1beta1/Instance/dataprocServiceAccount": dataproc_service_account "/datafusion:v1beta1/Instance/description": description "/datafusion:v1beta1/Instance/displayName": display_name "/datafusion:v1beta1/Instance/enableStackdriverLogging": enable_stackdriver_logging @@ -59939,6 +60678,7 @@ "/dataproc:v1/BasicYarnAutoscalingConfig/scaleUpFactor": scale_up_factor "/dataproc:v1/BasicYarnAutoscalingConfig/scaleUpMinWorkerFraction": scale_up_min_worker_fraction "/dataproc:v1/Binding": binding +"/dataproc:v1/Binding/bindingId": binding_id "/dataproc:v1/Binding/condition": condition "/dataproc:v1/Binding/members": members "/dataproc:v1/Binding/members/member": member @@ -60029,6 +60769,7 @@ "/dataproc:v1/GceClusterConfig/metadata": metadata "/dataproc:v1/GceClusterConfig/metadata/metadatum": metadatum "/dataproc:v1/GceClusterConfig/networkUri": network_uri +"/dataproc:v1/GceClusterConfig/privateIpv6GoogleAccess": private_ipv6_google_access "/dataproc:v1/GceClusterConfig/reservationAffinity": reservation_affinity "/dataproc:v1/GceClusterConfig/serviceAccount": service_account "/dataproc:v1/GceClusterConfig/serviceAccountScopes": service_account_scopes @@ -60585,6 +61326,7 @@ "/dataproc:v1beta2/BasicYarnAutoscalingConfig/scaleUpFactor": scale_up_factor "/dataproc:v1beta2/BasicYarnAutoscalingConfig/scaleUpMinWorkerFraction": scale_up_min_worker_fraction "/dataproc:v1beta2/Binding": binding +"/dataproc:v1beta2/Binding/bindingId": binding_id "/dataproc:v1beta2/Binding/condition": condition "/dataproc:v1beta2/Binding/members": members "/dataproc:v1beta2/Binding/members/member": member @@ -60678,6 +61420,7 @@ "/dataproc:v1beta2/GceClusterConfig/metadata": metadata "/dataproc:v1beta2/GceClusterConfig/metadata/metadatum": metadatum "/dataproc:v1beta2/GceClusterConfig/networkUri": network_uri +"/dataproc:v1beta2/GceClusterConfig/privateIpv6GoogleAccess": private_ipv6_google_access "/dataproc:v1beta2/GceClusterConfig/reservationAffinity": reservation_affinity "/dataproc:v1beta2/GceClusterConfig/serviceAccount": service_account "/dataproc:v1beta2/GceClusterConfig/serviceAccountScopes": service_account_scopes @@ -81719,6 +82462,7 @@ "/dialogflow:v2/GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment/audio": audio "/dialogflow:v2/GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment/uri": uri "/dialogflow:v2/GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText": google_cloud_dialogflow_cx_v3beta1_response_message_output_audio_text +"/dialogflow:v2/GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText/allowPlaybackInterruption": allow_playback_interruption "/dialogflow:v2/GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText/ssml": ssml "/dialogflow:v2/GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText/text": text "/dialogflow:v2/GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio": google_cloud_dialogflow_cx_v3beta1_response_message_play_audio @@ -82930,6 +83674,7 @@ "/dialogflow:v2beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment/audio": audio "/dialogflow:v2beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment/uri": uri "/dialogflow:v2beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText": google_cloud_dialogflow_cx_v3beta1_response_message_output_audio_text +"/dialogflow:v2beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText/allowPlaybackInterruption": allow_playback_interruption "/dialogflow:v2beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText/ssml": ssml "/dialogflow:v2beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText/text": text "/dialogflow:v2beta1/GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio": google_cloud_dialogflow_cx_v3beta1_response_message_play_audio @@ -85084,6 +85829,7 @@ "/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment/audio": audio "/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment/uri": uri "/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText": google_cloud_dialogflow_cx_v3beta1_response_message_output_audio_text +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText/allowPlaybackInterruption": allow_playback_interruption "/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText/ssml": ssml "/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText/text": text "/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio": google_cloud_dialogflow_cx_v3beta1_response_message_play_audio @@ -87737,6 +88483,77 @@ "/displayvideo:v1/fields": fields "/displayvideo:v1/key": key "/displayvideo:v1/quotaUser": quota_user +"/displayvideo:v1beta/GoogleBytestreamMedia": google_bytestream_media +"/displayvideo:v1beta/GoogleBytestreamMedia/resourceName": resource_name +"/displayvideo:v1beta/Operation": operation +"/displayvideo:v1beta/Operation/done": done +"/displayvideo:v1beta/Operation/error": error +"/displayvideo:v1beta/Operation/metadata": metadata +"/displayvideo:v1beta/Operation/metadata/metadatum": metadatum +"/displayvideo:v1beta/Operation/name": name +"/displayvideo:v1beta/Operation/response": response +"/displayvideo:v1beta/Operation/response/response": response +"/displayvideo:v1beta/Status": status +"/displayvideo:v1beta/Status/code": code +"/displayvideo:v1beta/Status/details": details +"/displayvideo:v1beta/Status/details/detail": detail +"/displayvideo:v1beta/Status/details/detail/detail": detail +"/displayvideo:v1beta/Status/message": message +"/displayvideo:v1beta/displayvideo.media.download": download_medium +"/displayvideo:v1beta/displayvideo.media.download/resourceName": resource_name +"/displayvideo:v1beta/displayvideo.sdfdownloadtask.operations.get": get_sdfdownloadtask_operation +"/displayvideo:v1beta/displayvideo.sdfdownloadtask.operations.get/name": name +"/displayvideo:v1beta/displayvideo.sdfdownloadtasks.operations.get": get_sdfdownloadtasks_operation +"/displayvideo:v1beta/displayvideo.sdfdownloadtasks.operations.get/name": name +"/displayvideo:v1beta/fields": fields +"/displayvideo:v1beta/key": key +"/displayvideo:v1beta/quotaUser": quota_user +"/displayvideo:v1beta2/GoogleBytestreamMedia": google_bytestream_media +"/displayvideo:v1beta2/GoogleBytestreamMedia/resourceName": resource_name +"/displayvideo:v1beta2/Operation": operation +"/displayvideo:v1beta2/Operation/done": done +"/displayvideo:v1beta2/Operation/error": error +"/displayvideo:v1beta2/Operation/metadata": metadata +"/displayvideo:v1beta2/Operation/metadata/metadatum": metadatum +"/displayvideo:v1beta2/Operation/name": name +"/displayvideo:v1beta2/Operation/response": response +"/displayvideo:v1beta2/Operation/response/response": response +"/displayvideo:v1beta2/Status": status +"/displayvideo:v1beta2/Status/code": code +"/displayvideo:v1beta2/Status/details": details +"/displayvideo:v1beta2/Status/details/detail": detail +"/displayvideo:v1beta2/Status/details/detail/detail": detail +"/displayvideo:v1beta2/Status/message": message +"/displayvideo:v1beta2/displayvideo.media.download": download_medium +"/displayvideo:v1beta2/displayvideo.media.download/resourceName": resource_name +"/displayvideo:v1beta2/displayvideo.sdfdownloadtasks.operations.get": get_sdfdownloadtask_operation +"/displayvideo:v1beta2/displayvideo.sdfdownloadtasks.operations.get/name": name +"/displayvideo:v1beta2/fields": fields +"/displayvideo:v1beta2/key": key +"/displayvideo:v1beta2/quotaUser": quota_user +"/displayvideo:v1dev/GoogleBytestreamMedia": google_bytestream_media +"/displayvideo:v1dev/GoogleBytestreamMedia/resourceName": resource_name +"/displayvideo:v1dev/Operation": operation +"/displayvideo:v1dev/Operation/done": done +"/displayvideo:v1dev/Operation/error": error +"/displayvideo:v1dev/Operation/metadata": metadata +"/displayvideo:v1dev/Operation/metadata/metadatum": metadatum +"/displayvideo:v1dev/Operation/name": name +"/displayvideo:v1dev/Operation/response": response +"/displayvideo:v1dev/Operation/response/response": response +"/displayvideo:v1dev/Status": status +"/displayvideo:v1dev/Status/code": code +"/displayvideo:v1dev/Status/details": details +"/displayvideo:v1dev/Status/details/detail": detail +"/displayvideo:v1dev/Status/details/detail/detail": detail +"/displayvideo:v1dev/Status/message": message +"/displayvideo:v1dev/displayvideo.media.download": download_medium +"/displayvideo:v1dev/displayvideo.media.download/resourceName": resource_name +"/displayvideo:v1dev/displayvideo.sdfdownloadtasks.operations.get": get_sdfdownloadtask_operation +"/displayvideo:v1dev/displayvideo.sdfdownloadtasks.operations.get/name": name +"/displayvideo:v1dev/fields": fields +"/displayvideo:v1dev/key": key +"/displayvideo:v1dev/quotaUser": quota_user "/dlp:v2/GooglePrivacyDlpV2Action": google_privacy_dlp_v2_action "/dlp:v2/GooglePrivacyDlpV2Action/jobNotificationEmails": job_notification_emails "/dlp:v2/GooglePrivacyDlpV2Action/pubSub": pub_sub @@ -92095,8 +92912,12 @@ "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1Document/mimeType": mime_type "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1Document/pages": pages "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1Document/pages/page": page +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1Document/revisions": revisions +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1Document/revisions/revision": revision "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1Document/shardInfo": shard_info "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1Document/text": text +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1Document/textChanges": text_changes +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1Document/textChanges/text_change": text_change "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1Document/textStyles": text_styles "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1Document/textStyles/text_style": text_style "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1Document/translations": translations @@ -92104,13 +92925,19 @@ "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1Document/uri": uri "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentEntity": google_cloud_documentai_v1beta1_document_entity "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentEntity/confidence": confidence +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentEntity/id": id "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentEntity/mentionId": mention_id "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentEntity/mentionText": mention_text "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentEntity/normalizedValue": normalized_value +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentEntity/pageAnchor": page_anchor +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentEntity/properties": properties +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentEntity/properties/property": property +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentEntity/provenance": provenance "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentEntity/redacted": redacted "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentEntity/textAnchor": text_anchor "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentEntity/type": type "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue": google_cloud_documentai_v1beta1_document_entity_normalized_value +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue/addressValue": address_value "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue/dateValue": date_value "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue/datetimeValue": datetime_value "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue/moneyValue": money_value @@ -92127,6 +92954,7 @@ "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPage/dimension": dimension "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPage/formFields": form_fields "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPage/formFields/form_field": form_field +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPage/image": image "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPage/layout": layout "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPage/lines": lines "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPage/lines/line": line @@ -92137,12 +92965,23 @@ "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPage/tables/table": table "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPage/tokens": tokens "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPage/tokens/token": token +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPage/transforms": transforms +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPage/transforms/transform": transform "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPage/visualElements": visual_elements "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPage/visualElements/visual_element": visual_element +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageAnchor": google_cloud_documentai_v1beta1_document_page_anchor +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageAnchor/pageRefs": page_refs +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageAnchor/pageRefs/page_ref": page_ref +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef": google_cloud_documentai_v1beta1_document_page_anchor_page_ref +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef/boundingPoly": bounding_poly +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef/layoutId": layout_id +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef/layoutType": layout_type +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef/page": page "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageBlock": google_cloud_documentai_v1beta1_document_page_block "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageBlock/detectedLanguages": detected_languages "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageBlock/detectedLanguages/detected_language": detected_language "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageBlock/layout": layout +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageBlock/provenance": provenance "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage": google_cloud_documentai_v1beta1_document_page_detected_language "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage/confidence": confidence "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage/languageCode": language_code @@ -92157,6 +92996,12 @@ "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageFormField/nameDetectedLanguages/name_detected_language": name_detected_language "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageFormField/valueDetectedLanguages": value_detected_languages "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageFormField/valueDetectedLanguages/value_detected_language": value_detected_language +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageFormField/valueType": value_type +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageImage": google_cloud_documentai_v1beta1_document_page_image +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageImage/content": content +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageImage/height": height +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageImage/mimeType": mime_type +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageImage/width": width "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageLayout": google_cloud_documentai_v1beta1_document_page_layout "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageLayout/boundingPoly": bounding_poly "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageLayout/confidence": confidence @@ -92166,10 +93011,17 @@ "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageLine/detectedLanguages": detected_languages "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageLine/detectedLanguages/detected_language": detected_language "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageLine/layout": layout +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageLine/provenance": provenance +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageMatrix": google_cloud_documentai_v1beta1_document_page_matrix +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageMatrix/cols": cols +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageMatrix/data": data +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageMatrix/rows": rows +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageMatrix/type": type "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageParagraph": google_cloud_documentai_v1beta1_document_page_paragraph "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageParagraph/detectedLanguages": detected_languages "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageParagraph/detectedLanguages/detected_language": detected_language "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageParagraph/layout": layout +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageParagraph/provenance": provenance "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageTable": google_cloud_documentai_v1beta1_document_page_table "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageTable/bodyRows": body_rows "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageTable/bodyRows/body_row": body_row @@ -92192,6 +93044,7 @@ "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageToken/detectedLanguages": detected_languages "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageToken/detectedLanguages/detected_language": detected_language "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageToken/layout": layout +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageToken/provenance": provenance "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak": google_cloud_documentai_v1beta1_document_page_token_detected_break "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak/type": type "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageVisualElement": google_cloud_documentai_v1beta1_document_page_visual_element @@ -92199,6 +93052,26 @@ "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageVisualElement/detectedLanguages/detected_language": detected_language "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageVisualElement/layout": layout "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentPageVisualElement/type": type +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentProvenance": google_cloud_documentai_v1beta1_document_provenance +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentProvenance/id": id +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentProvenance/parents": parents +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentProvenance/parents/parent": parent +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentProvenance/revision": revision +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentProvenance/type": type +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentProvenanceParent": google_cloud_documentai_v1beta1_document_provenance_parent +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentProvenanceParent/id": id +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentProvenanceParent/revision": revision +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentRevision": google_cloud_documentai_v1beta1_document_revision +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentRevision/agent": agent +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentRevision/createTime": create_time +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentRevision/humanReview": human_review +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentRevision/id": id +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentRevision/parent": parent +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentRevision/parent/parent": parent +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentRevision/processor": processor +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview": google_cloud_documentai_v1beta1_document_revision_human_review +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview/state": state +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview/stateMessage": state_message "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentShardInfo": google_cloud_documentai_v1beta1_document_shard_info "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentShardInfo/shardCount": shard_count "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentShardInfo/shardIndex": shard_index @@ -92215,13 +93088,21 @@ "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentStyleFontSize/size": size "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentStyleFontSize/unit": unit "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentTextAnchor": google_cloud_documentai_v1beta1_document_text_anchor +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentTextAnchor/content": content "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentTextAnchor/textSegments": text_segments "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentTextAnchor/textSegments/text_segment": text_segment "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment": google_cloud_documentai_v1beta1_document_text_anchor_text_segment "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment/endIndex": end_index "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment/startIndex": start_index +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentTextChange": google_cloud_documentai_v1beta1_document_text_change +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentTextChange/changedText": changed_text +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentTextChange/provenance": provenance +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentTextChange/provenance/provenance": provenance +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentTextChange/textAnchor": text_anchor "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentTranslation": google_cloud_documentai_v1beta1_document_translation "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentTranslation/languageCode": language_code +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentTranslation/provenance": provenance +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentTranslation/provenance/provenance": provenance "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentTranslation/textAnchor": text_anchor "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1DocumentTranslation/translatedText": translated_text "/documentai:v1beta2/GoogleCloudDocumentaiV1beta1GcsDestination": google_cloud_documentai_v1beta1_gcs_destination @@ -92273,8 +93154,12 @@ "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2Document/mimeType": mime_type "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2Document/pages": pages "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2Document/pages/page": page +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2Document/revisions": revisions +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2Document/revisions/revision": revision "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2Document/shardInfo": shard_info "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2Document/text": text +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2Document/textChanges": text_changes +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2Document/textChanges/text_change": text_change "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2Document/textStyles": text_styles "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2Document/textStyles/text_style": text_style "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2Document/translations": translations @@ -92282,13 +93167,19 @@ "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2Document/uri": uri "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentEntity": google_cloud_documentai_v1beta2_document_entity "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentEntity/confidence": confidence +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentEntity/id": id "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentEntity/mentionId": mention_id "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentEntity/mentionText": mention_text "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentEntity/normalizedValue": normalized_value +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentEntity/pageAnchor": page_anchor +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentEntity/properties": properties +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentEntity/properties/property": property +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentEntity/provenance": provenance "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentEntity/redacted": redacted "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentEntity/textAnchor": text_anchor "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentEntity/type": type "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue": google_cloud_documentai_v1beta2_document_entity_normalized_value +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue/addressValue": address_value "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue/dateValue": date_value "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue/datetimeValue": datetime_value "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue/moneyValue": money_value @@ -92309,6 +93200,7 @@ "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPage/dimension": dimension "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPage/formFields": form_fields "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPage/formFields/form_field": form_field +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPage/image": image "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPage/layout": layout "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPage/lines": lines "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPage/lines/line": line @@ -92319,12 +93211,23 @@ "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPage/tables/table": table "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPage/tokens": tokens "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPage/tokens/token": token +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPage/transforms": transforms +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPage/transforms/transform": transform "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPage/visualElements": visual_elements "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPage/visualElements/visual_element": visual_element +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageAnchor": google_cloud_documentai_v1beta2_document_page_anchor +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageAnchor/pageRefs": page_refs +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageAnchor/pageRefs/page_ref": page_ref +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef": google_cloud_documentai_v1beta2_document_page_anchor_page_ref +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef/boundingPoly": bounding_poly +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef/layoutId": layout_id +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef/layoutType": layout_type +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef/page": page "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageBlock": google_cloud_documentai_v1beta2_document_page_block "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageBlock/detectedLanguages": detected_languages "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageBlock/detectedLanguages/detected_language": detected_language "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageBlock/layout": layout +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageBlock/provenance": provenance "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage": google_cloud_documentai_v1beta2_document_page_detected_language "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage/confidence": confidence "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage/languageCode": language_code @@ -92340,6 +93243,11 @@ "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageFormField/valueDetectedLanguages": value_detected_languages "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageFormField/valueDetectedLanguages/value_detected_language": value_detected_language "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageFormField/valueType": value_type +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageImage": google_cloud_documentai_v1beta2_document_page_image +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageImage/content": content +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageImage/height": height +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageImage/mimeType": mime_type +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageImage/width": width "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageLayout": google_cloud_documentai_v1beta2_document_page_layout "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageLayout/boundingPoly": bounding_poly "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageLayout/confidence": confidence @@ -92349,10 +93257,17 @@ "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageLine/detectedLanguages": detected_languages "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageLine/detectedLanguages/detected_language": detected_language "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageLine/layout": layout +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageLine/provenance": provenance +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageMatrix": google_cloud_documentai_v1beta2_document_page_matrix +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageMatrix/cols": cols +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageMatrix/data": data +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageMatrix/rows": rows +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageMatrix/type": type "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageParagraph": google_cloud_documentai_v1beta2_document_page_paragraph "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageParagraph/detectedLanguages": detected_languages "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageParagraph/detectedLanguages/detected_language": detected_language "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageParagraph/layout": layout +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageParagraph/provenance": provenance "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageTable": google_cloud_documentai_v1beta2_document_page_table "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageTable/bodyRows": body_rows "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageTable/bodyRows/body_row": body_row @@ -92375,6 +93290,7 @@ "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageToken/detectedLanguages": detected_languages "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageToken/detectedLanguages/detected_language": detected_language "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageToken/layout": layout +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageToken/provenance": provenance "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak": google_cloud_documentai_v1beta2_document_page_token_detected_break "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak/type": type "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageVisualElement": google_cloud_documentai_v1beta2_document_page_visual_element @@ -92382,6 +93298,26 @@ "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageVisualElement/detectedLanguages/detected_language": detected_language "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageVisualElement/layout": layout "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentPageVisualElement/type": type +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentProvenance": google_cloud_documentai_v1beta2_document_provenance +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentProvenance/id": id +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentProvenance/parents": parents +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentProvenance/parents/parent": parent +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentProvenance/revision": revision +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentProvenance/type": type +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentProvenanceParent": google_cloud_documentai_v1beta2_document_provenance_parent +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentProvenanceParent/id": id +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentProvenanceParent/revision": revision +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentRevision": google_cloud_documentai_v1beta2_document_revision +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentRevision/agent": agent +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentRevision/createTime": create_time +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentRevision/humanReview": human_review +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentRevision/id": id +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentRevision/parent": parent +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentRevision/parent/parent": parent +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentRevision/processor": processor +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview": google_cloud_documentai_v1beta2_document_revision_human_review +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview/state": state +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview/stateMessage": state_message "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentShardInfo": google_cloud_documentai_v1beta2_document_shard_info "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentShardInfo/shardCount": shard_count "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentShardInfo/shardIndex": shard_index @@ -92398,13 +93334,21 @@ "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentStyleFontSize/size": size "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentStyleFontSize/unit": unit "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentTextAnchor": google_cloud_documentai_v1beta2_document_text_anchor +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentTextAnchor/content": content "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentTextAnchor/textSegments": text_segments "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentTextAnchor/textSegments/text_segment": text_segment "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment": google_cloud_documentai_v1beta2_document_text_anchor_text_segment "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment/endIndex": end_index "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment/startIndex": start_index +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentTextChange": google_cloud_documentai_v1beta2_document_text_change +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentTextChange/changedText": changed_text +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentTextChange/provenance": provenance +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentTextChange/provenance/provenance": provenance +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentTextChange/textAnchor": text_anchor "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentTranslation": google_cloud_documentai_v1beta2_document_translation "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentTranslation/languageCode": language_code +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentTranslation/provenance": provenance +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentTranslation/provenance/provenance": provenance "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentTranslation/textAnchor": text_anchor "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2DocumentTranslation/translatedText": translated_text "/documentai:v1beta2/GoogleCloudDocumentaiV1beta2EntityExtractionParams": google_cloud_documentai_v1beta2_entity_extraction_params @@ -92475,10 +93419,18 @@ "/documentai:v1beta2/GoogleCloudDocumentaiV1beta3BatchProcessMetadata/stateMessage": state_message "/documentai:v1beta2/GoogleCloudDocumentaiV1beta3BatchProcessMetadata/updateTime": update_time "/documentai:v1beta2/GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus": google_cloud_documentai_v1beta3_batch_process_metadata_individual_process_status +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus/humanReviewOperation": human_review_operation "/documentai:v1beta2/GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus/inputGcsSource": input_gcs_source "/documentai:v1beta2/GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus/outputGcsDestination": output_gcs_destination "/documentai:v1beta2/GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus/status": status "/documentai:v1beta2/GoogleCloudDocumentaiV1beta3BatchProcessResponse": google_cloud_documentai_v1beta3_batch_process_response +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata": google_cloud_documentai_v1beta3_review_document_operation_metadata +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata/createTime": create_time +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata/state": state +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata/stateMessage": state_message +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata/updateTime": update_time +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta3ReviewDocumentResponse": google_cloud_documentai_v1beta3_review_document_response +"/documentai:v1beta2/GoogleCloudDocumentaiV1beta3ReviewDocumentResponse/gcsDestination": gcs_destination "/documentai:v1beta2/GoogleLongrunningOperation": google_longrunning_operation "/documentai:v1beta2/GoogleLongrunningOperation/done": done "/documentai:v1beta2/GoogleLongrunningOperation/error": error @@ -92517,6 +93469,20 @@ "/documentai:v1beta2/GoogleTypeMoney/currencyCode": currency_code "/documentai:v1beta2/GoogleTypeMoney/nanos": nanos "/documentai:v1beta2/GoogleTypeMoney/units": units +"/documentai:v1beta2/GoogleTypePostalAddress": google_type_postal_address +"/documentai:v1beta2/GoogleTypePostalAddress/addressLines": address_lines +"/documentai:v1beta2/GoogleTypePostalAddress/addressLines/address_line": address_line +"/documentai:v1beta2/GoogleTypePostalAddress/administrativeArea": administrative_area +"/documentai:v1beta2/GoogleTypePostalAddress/languageCode": language_code +"/documentai:v1beta2/GoogleTypePostalAddress/locality": locality +"/documentai:v1beta2/GoogleTypePostalAddress/organization": organization +"/documentai:v1beta2/GoogleTypePostalAddress/postalCode": postal_code +"/documentai:v1beta2/GoogleTypePostalAddress/recipients": recipients +"/documentai:v1beta2/GoogleTypePostalAddress/recipients/recipient": recipient +"/documentai:v1beta2/GoogleTypePostalAddress/regionCode": region_code +"/documentai:v1beta2/GoogleTypePostalAddress/revision": revision +"/documentai:v1beta2/GoogleTypePostalAddress/sortingCode": sorting_code +"/documentai:v1beta2/GoogleTypePostalAddress/sublocality": sublocality "/documentai:v1beta2/GoogleTypeTimeZone": google_type_time_zone "/documentai:v1beta2/GoogleTypeTimeZone/id": id "/documentai:v1beta2/GoogleTypeTimeZone/version": version @@ -95847,6 +96813,22 @@ "/firebasehosting:v1beta1/CertHttpChallenge": cert_http_challenge "/firebasehosting:v1beta1/CertHttpChallenge/path": path "/firebasehosting:v1beta1/CertHttpChallenge/token": token +"/firebasehosting:v1beta1/Channel": channel +"/firebasehosting:v1beta1/Channel/createTime": create_time +"/firebasehosting:v1beta1/Channel/expireTime": expire_time +"/firebasehosting:v1beta1/Channel/labels": labels +"/firebasehosting:v1beta1/Channel/labels/label": label +"/firebasehosting:v1beta1/Channel/name": name +"/firebasehosting:v1beta1/Channel/release": release +"/firebasehosting:v1beta1/Channel/retainedReleaseCount": retained_release_count +"/firebasehosting:v1beta1/Channel/ttl": ttl +"/firebasehosting:v1beta1/Channel/updateTime": update_time +"/firebasehosting:v1beta1/Channel/url": url +"/firebasehosting:v1beta1/CloneVersionRequest": clone_version_request +"/firebasehosting:v1beta1/CloneVersionRequest/exclude": exclude +"/firebasehosting:v1beta1/CloneVersionRequest/finalize": finalize +"/firebasehosting:v1beta1/CloneVersionRequest/include": include +"/firebasehosting:v1beta1/CloneVersionRequest/sourceVersion": source_version "/firebasehosting:v1beta1/CloudRunRewrite": cloud_run_rewrite "/firebasehosting:v1beta1/CloudRunRewrite/region": region "/firebasehosting:v1beta1/CloudRunRewrite/serviceId": service_id @@ -95880,6 +96862,10 @@ "/firebasehosting:v1beta1/Header/regex": regex "/firebasehosting:v1beta1/I18nConfig": i18n_config "/firebasehosting:v1beta1/I18nConfig/root": root +"/firebasehosting:v1beta1/ListChannelsResponse": list_channels_response +"/firebasehosting:v1beta1/ListChannelsResponse/channels": channels +"/firebasehosting:v1beta1/ListChannelsResponse/channels/channel": channel +"/firebasehosting:v1beta1/ListChannelsResponse/nextPageToken": next_page_token "/firebasehosting:v1beta1/ListDomainsResponse": list_domains_response "/firebasehosting:v1beta1/ListDomainsResponse/domains": domains "/firebasehosting:v1beta1/ListDomainsResponse/domains/domain": domain @@ -95904,6 +96890,9 @@ "/firebasehosting:v1beta1/Operation/name": name "/firebasehosting:v1beta1/Operation/response": response "/firebasehosting:v1beta1/Operation/response/response": response +"/firebasehosting:v1beta1/PathFilter": path_filter +"/firebasehosting:v1beta1/PathFilter/regexes": regexes +"/firebasehosting:v1beta1/PathFilter/regexes/regex": regex "/firebasehosting:v1beta1/PopulateVersionFilesRequest": populate_version_files_request "/firebasehosting:v1beta1/PopulateVersionFilesRequest/files": files "/firebasehosting:v1beta1/PopulateVersionFilesRequest/files/file": file @@ -95975,6 +96964,20 @@ "/firebasehosting:v1beta1/fields": fields "/firebasehosting:v1beta1/firebasehosting.projects.operations.get": get_project_operation "/firebasehosting:v1beta1/firebasehosting.projects.operations.get/name": name +"/firebasehosting:v1beta1/firebasehosting.projects.sites.channels.create": create_project_site_channel +"/firebasehosting:v1beta1/firebasehosting.projects.sites.channels.create/channelId": channel_id +"/firebasehosting:v1beta1/firebasehosting.projects.sites.channels.create/parent": parent +"/firebasehosting:v1beta1/firebasehosting.projects.sites.channels.delete": delete_project_site_channel +"/firebasehosting:v1beta1/firebasehosting.projects.sites.channels.delete/name": name +"/firebasehosting:v1beta1/firebasehosting.projects.sites.channels.get": get_project_site_channel +"/firebasehosting:v1beta1/firebasehosting.projects.sites.channels.get/name": name +"/firebasehosting:v1beta1/firebasehosting.projects.sites.channels.list": list_project_site_channels +"/firebasehosting:v1beta1/firebasehosting.projects.sites.channels.list/pageSize": page_size +"/firebasehosting:v1beta1/firebasehosting.projects.sites.channels.list/pageToken": page_token +"/firebasehosting:v1beta1/firebasehosting.projects.sites.channels.list/parent": parent +"/firebasehosting:v1beta1/firebasehosting.projects.sites.channels.patch": patch_project_site_channel +"/firebasehosting:v1beta1/firebasehosting.projects.sites.channels.patch/name": name +"/firebasehosting:v1beta1/firebasehosting.projects.sites.channels.patch/updateMask": update_mask "/firebasehosting:v1beta1/firebasehosting.projects.sites.channels.releases.create": create_project_site_channel_release "/firebasehosting:v1beta1/firebasehosting.projects.sites.channels.releases.create/parent": parent "/firebasehosting:v1beta1/firebasehosting.projects.sites.channels.releases.create/versionName": version_name @@ -96006,6 +97009,8 @@ "/firebasehosting:v1beta1/firebasehosting.projects.sites.updateConfig": update_project_site_config "/firebasehosting:v1beta1/firebasehosting.projects.sites.updateConfig/name": name "/firebasehosting:v1beta1/firebasehosting.projects.sites.updateConfig/updateMask": update_mask +"/firebasehosting:v1beta1/firebasehosting.projects.sites.versions.clone": clone_project_site_version +"/firebasehosting:v1beta1/firebasehosting.projects.sites.versions.clone/parent": parent "/firebasehosting:v1beta1/firebasehosting.projects.sites.versions.create": create_project_site_version "/firebasehosting:v1beta1/firebasehosting.projects.sites.versions.create/parent": parent "/firebasehosting:v1beta1/firebasehosting.projects.sites.versions.create/sizeBytes": size_bytes @@ -96027,6 +97032,20 @@ "/firebasehosting:v1beta1/firebasehosting.projects.sites.versions.patch/updateMask": update_mask "/firebasehosting:v1beta1/firebasehosting.projects.sites.versions.populateFiles": populate_project_site_version_files "/firebasehosting:v1beta1/firebasehosting.projects.sites.versions.populateFiles/parent": parent +"/firebasehosting:v1beta1/firebasehosting.sites.channels.create": create_site_channel +"/firebasehosting:v1beta1/firebasehosting.sites.channels.create/channelId": channel_id +"/firebasehosting:v1beta1/firebasehosting.sites.channels.create/parent": parent +"/firebasehosting:v1beta1/firebasehosting.sites.channels.delete": delete_site_channel +"/firebasehosting:v1beta1/firebasehosting.sites.channels.delete/name": name +"/firebasehosting:v1beta1/firebasehosting.sites.channels.get": get_site_channel +"/firebasehosting:v1beta1/firebasehosting.sites.channels.get/name": name +"/firebasehosting:v1beta1/firebasehosting.sites.channels.list": list_site_channels +"/firebasehosting:v1beta1/firebasehosting.sites.channels.list/pageSize": page_size +"/firebasehosting:v1beta1/firebasehosting.sites.channels.list/pageToken": page_token +"/firebasehosting:v1beta1/firebasehosting.sites.channels.list/parent": parent +"/firebasehosting:v1beta1/firebasehosting.sites.channels.patch": patch_site_channel +"/firebasehosting:v1beta1/firebasehosting.sites.channels.patch/name": name +"/firebasehosting:v1beta1/firebasehosting.sites.channels.patch/updateMask": update_mask "/firebasehosting:v1beta1/firebasehosting.sites.channels.releases.create": create_site_channel_release "/firebasehosting:v1beta1/firebasehosting.sites.channels.releases.create/parent": parent "/firebasehosting:v1beta1/firebasehosting.sites.channels.releases.create/versionName": version_name @@ -96058,6 +97077,8 @@ "/firebasehosting:v1beta1/firebasehosting.sites.updateConfig": update_site_config "/firebasehosting:v1beta1/firebasehosting.sites.updateConfig/name": name "/firebasehosting:v1beta1/firebasehosting.sites.updateConfig/updateMask": update_mask +"/firebasehosting:v1beta1/firebasehosting.sites.versions.clone": clone_site_version +"/firebasehosting:v1beta1/firebasehosting.sites.versions.clone/parent": parent "/firebasehosting:v1beta1/firebasehosting.sites.versions.create": create_site_version "/firebasehosting:v1beta1/firebasehosting.sites.versions.create/parent": parent "/firebasehosting:v1beta1/firebasehosting.sites.versions.create/sizeBytes": size_bytes @@ -96155,6 +97176,7 @@ "/firebaseml:v1beta2/Status/details/detail/detail": detail "/firebaseml:v1beta2/Status/message": message "/firebaseml:v1beta2/TfLiteModel": tf_lite_model +"/firebaseml:v1beta2/TfLiteModel/automlModel": automl_model "/firebaseml:v1beta2/TfLiteModel/gcsTfliteUri": gcs_tflite_uri "/firebaseml:v1beta2/TfLiteModel/managedUpload": managed_upload "/firebaseml:v1beta2/TfLiteModel/sizeBytes": size_bytes @@ -99121,6 +100143,7 @@ "/gameservices:v1/AuthorizationLoggingOptions": authorization_logging_options "/gameservices:v1/AuthorizationLoggingOptions/permissionType": permission_type "/gameservices:v1/Binding": binding +"/gameservices:v1/Binding/bindingId": binding_id "/gameservices:v1/Binding/condition": condition "/gameservices:v1/Binding/members": members "/gameservices:v1/Binding/members/member": member @@ -99526,6 +100549,7 @@ "/gameservices:v1beta/AuthorizationLoggingOptions": authorization_logging_options "/gameservices:v1beta/AuthorizationLoggingOptions/permissionType": permission_type "/gameservices:v1beta/Binding": binding +"/gameservices:v1beta/Binding/bindingId": binding_id "/gameservices:v1beta/Binding/condition": condition "/gameservices:v1beta/Binding/members": members "/gameservices:v1beta/Binding/members/member": member @@ -101728,6 +102752,10 @@ "/healthcare:v1/ListHl7V2StoresResponse/hl7V2Stores": hl7_v2_stores "/healthcare:v1/ListHl7V2StoresResponse/hl7V2Stores/hl7_v2_store": hl7_v2_store "/healthcare:v1/ListHl7V2StoresResponse/nextPageToken": next_page_token +"/healthcare:v1/ListLocationsResponse": list_locations_response +"/healthcare:v1/ListLocationsResponse/locations": locations +"/healthcare:v1/ListLocationsResponse/locations/location": location +"/healthcare:v1/ListLocationsResponse/nextPageToken": next_page_token "/healthcare:v1/ListMessagesResponse": list_messages_response "/healthcare:v1/ListMessagesResponse/hl7V2Messages": hl7_v2_messages "/healthcare:v1/ListMessagesResponse/hl7V2Messages/hl7_v2_message": hl7_v2_message @@ -101736,6 +102764,14 @@ "/healthcare:v1/ListOperationsResponse/nextPageToken": next_page_token "/healthcare:v1/ListOperationsResponse/operations": operations "/healthcare:v1/ListOperationsResponse/operations/operation": operation +"/healthcare:v1/Location": location +"/healthcare:v1/Location/displayName": display_name +"/healthcare:v1/Location/labels": labels +"/healthcare:v1/Location/labels/label": label +"/healthcare:v1/Location/locationId": location_id +"/healthcare:v1/Location/metadata": metadata +"/healthcare:v1/Location/metadata/metadatum": metadatum +"/healthcare:v1/Location/name": name "/healthcare:v1/Message": message "/healthcare:v1/Message/createTime": create_time "/healthcare:v1/Message/data": data @@ -102050,6 +103086,13 @@ "/healthcare:v1/healthcare.projects.locations.datasets.setIamPolicy/resource": resource "/healthcare:v1/healthcare.projects.locations.datasets.testIamPermissions": test_dataset_iam_permissions "/healthcare:v1/healthcare.projects.locations.datasets.testIamPermissions/resource": resource +"/healthcare:v1/healthcare.projects.locations.get": get_project_location +"/healthcare:v1/healthcare.projects.locations.get/name": name +"/healthcare:v1/healthcare.projects.locations.list": list_project_locations +"/healthcare:v1/healthcare.projects.locations.list/filter": filter +"/healthcare:v1/healthcare.projects.locations.list/name": name +"/healthcare:v1/healthcare.projects.locations.list/pageSize": page_size +"/healthcare:v1/healthcare.projects.locations.list/pageToken": page_token "/healthcare:v1/key": key "/healthcare:v1/quotaUser": quota_user "/healthcare:v1alpha/Annotation": annotation @@ -103714,6 +104757,13 @@ "/healthcare:v1beta1/healthcare.projects.locations.datasets.annotationStores.setIamPolicy/resource": resource "/healthcare:v1beta1/healthcare.projects.locations.datasets.annotationStores.testIamPermissions": test_annotation_store_iam_permissions "/healthcare:v1beta1/healthcare.projects.locations.datasets.annotationStores.testIamPermissions/resource": resource +"/healthcare:v1beta1/healthcare.projects.locations.datasets.consentStores.getIamPolicy": get_project_location_dataset_consent_store_iam_policy +"/healthcare:v1beta1/healthcare.projects.locations.datasets.consentStores.getIamPolicy/options.requestedPolicyVersion": options_requested_policy_version +"/healthcare:v1beta1/healthcare.projects.locations.datasets.consentStores.getIamPolicy/resource": resource +"/healthcare:v1beta1/healthcare.projects.locations.datasets.consentStores.setIamPolicy": set_consent_store_iam_policy +"/healthcare:v1beta1/healthcare.projects.locations.datasets.consentStores.setIamPolicy/resource": resource +"/healthcare:v1beta1/healthcare.projects.locations.datasets.consentStores.testIamPermissions": test_consent_store_iam_permissions +"/healthcare:v1beta1/healthcare.projects.locations.datasets.consentStores.testIamPermissions/resource": resource "/healthcare:v1beta1/healthcare.projects.locations.datasets.create": create_project_location_dataset "/healthcare:v1beta1/healthcare.projects.locations.datasets.create/datasetId": dataset_id "/healthcare:v1beta1/healthcare.projects.locations.datasets.create/parent": parent @@ -104084,6 +105134,7 @@ "/iam:v1/AuditableService": auditable_service "/iam:v1/AuditableService/name": name "/iam:v1/Binding": binding +"/iam:v1/Binding/bindingId": binding_id "/iam:v1/Binding/condition": condition "/iam:v1/Binding/members": members "/iam:v1/Binding/members/member": member @@ -104400,6 +105451,7 @@ "/iap:v1/ApplicationSettings/cookieDomain": cookie_domain "/iap:v1/ApplicationSettings/csmSettings": csm_settings "/iap:v1/Binding": binding +"/iap:v1/Binding/bindingId": binding_id "/iap:v1/Binding/condition": condition "/iap:v1/Binding/members": members "/iap:v1/Binding/members/member": member @@ -104549,6 +105601,7 @@ "/iap:v1beta1/AuditLogConfig/exemptedMembers/exempted_member": exempted_member "/iap:v1beta1/AuditLogConfig/logType": log_type "/iap:v1beta1/Binding": binding +"/iap:v1beta1/Binding/bindingId": binding_id "/iap:v1beta1/Binding/condition": condition "/iap:v1beta1/Binding/members": members "/iap:v1beta1/Binding/members/member": member @@ -108108,6 +109161,7 @@ "/managedidentities:v1alpha1/DetachTrustRequest": detach_trust_request "/managedidentities:v1alpha1/DetachTrustRequest/trust": trust_prop "/managedidentities:v1alpha1/Domain": domain +"/managedidentities:v1alpha1/Domain/auditLogsEnabled": audit_logs_enabled "/managedidentities:v1alpha1/Domain/authorizedNetworks": authorized_networks "/managedidentities:v1alpha1/Domain/authorizedNetworks/authorized_network": authorized_network "/managedidentities:v1alpha1/Domain/createTime": create_time @@ -108348,6 +109402,7 @@ "/managedidentities:v1beta1/DetachTrustRequest/trust": trust_prop "/managedidentities:v1beta1/Domain": domain "/managedidentities:v1beta1/Domain/admin": admin +"/managedidentities:v1beta1/Domain/auditLogsEnabled": audit_logs_enabled "/managedidentities:v1beta1/Domain/authorizedNetworks": authorized_networks "/managedidentities:v1beta1/Domain/authorizedNetworks/authorized_network": authorized_network "/managedidentities:v1beta1/Domain/createTime": create_time @@ -109791,6 +110846,7 @@ "/ml:v1/GoogleIamV1__AuditLogConfig/exemptedMembers/exempted_member": exempted_member "/ml:v1/GoogleIamV1__AuditLogConfig/logType": log_type "/ml:v1/GoogleIamV1__Binding": google_iam_v1__binding +"/ml:v1/GoogleIamV1__Binding/bindingId": binding_id "/ml:v1/GoogleIamV1__Binding/condition": condition "/ml:v1/GoogleIamV1__Binding/members": members "/ml:v1/GoogleIamV1__Binding/members/member": member @@ -116219,6 +117275,8 @@ "/prod_tt_sasportal:v1alpha1/SasPortalListNodesResponse/nextPageToken": next_page_token "/prod_tt_sasportal:v1alpha1/SasPortalListNodesResponse/nodes": nodes "/prod_tt_sasportal:v1alpha1/SasPortalListNodesResponse/nodes/node": node +"/prod_tt_sasportal:v1alpha1/SasPortalMoveDeploymentRequest": sas_portal_move_deployment_request +"/prod_tt_sasportal:v1alpha1/SasPortalMoveDeploymentRequest/destination": destination "/prod_tt_sasportal:v1alpha1/SasPortalMoveDeviceRequest": sas_portal_move_device_request "/prod_tt_sasportal:v1alpha1/SasPortalMoveDeviceRequest/destination": destination "/prod_tt_sasportal:v1alpha1/SasPortalMoveNodeRequest": sas_portal_move_node_request @@ -116272,12 +117330,23 @@ "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.create/parent": parent "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.delete": delete_customer_deployment "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.delete/name": name +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.devices.create": create_customer_deployment_device +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.devices.create/parent": parent +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.devices.createSigned": create_customer_deployment_device_signed +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.devices.createSigned/parent": parent +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.devices.list": list_customer_deployment_devices +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.devices.list/filter": filter +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.devices.list/pageSize": page_size +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.devices.list/pageToken": page_token +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.devices.list/parent": parent "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.get": get_customer_deployment "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.get/name": name "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.list": list_customer_deployments "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.list/pageSize": page_size "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.list/pageToken": page_token "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.list/parent": parent +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.move": move_customer_deployment +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.move/name": name "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.patch": patch_customer_deployment "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.patch/name": name "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.deployments.patch/updateMask": update_mask @@ -116340,18 +117409,42 @@ "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.patch": patch_customer "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.patch/name": name "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.customers.patch/updateMask": update_mask +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.deployments.devices.delete": delete_deployment_device +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.deployments.devices.delete/name": name +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.deployments.devices.get": get_deployment_device +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.deployments.devices.get/name": name +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.deployments.devices.move": move_deployment_device +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.deployments.devices.move/name": name +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.deployments.devices.patch": patch_deployment_device +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.deployments.devices.patch/name": name +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.deployments.devices.patch/updateMask": update_mask +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.deployments.devices.signDevice": sign_deployment_device_device +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.deployments.devices.signDevice/name": name +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.deployments.devices.updateSigned": update_deployment_device_signed +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.deployments.devices.updateSigned/name": name "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.deployments.get": get_deployment "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.deployments.get/name": name "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.installer.generateSecret": generate_installer_secret "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.installer.validate": validate_installer "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.nodes.deployments.delete": delete_node_deployment "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.nodes.deployments.delete/name": name +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.nodes.deployments.devices.create": create_node_deployment_device +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.nodes.deployments.devices.create/parent": parent +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.nodes.deployments.devices.createSigned": create_node_deployment_device_signed +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.nodes.deployments.devices.createSigned/parent": parent +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.nodes.deployments.devices.list": list_node_deployment_devices +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.nodes.deployments.devices.list/filter": filter +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.nodes.deployments.devices.list/pageSize": page_size +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.nodes.deployments.devices.list/pageToken": page_token +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.nodes.deployments.devices.list/parent": parent "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.nodes.deployments.get": get_node_deployment "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.nodes.deployments.get/name": name "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.nodes.deployments.list": list_node_deployments "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.nodes.deployments.list/pageSize": page_size "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.nodes.deployments.list/pageToken": page_token "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.nodes.deployments.list/parent": parent +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.nodes.deployments.move": move_node_deployment +"/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.nodes.deployments.move/name": name "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.nodes.deployments.patch": patch_node_deployment "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.nodes.deployments.patch/name": name "/prod_tt_sasportal:v1alpha1/prod_tt_sasportal.nodes.deployments.patch/updateMask": update_mask @@ -122429,6 +123522,7 @@ "/runtimeconfig:v1/runtimeconfig.operations.list/pageSize": page_size "/runtimeconfig:v1/runtimeconfig.operations.list/pageToken": page_token "/runtimeconfig:v1beta1/Binding": binding +"/runtimeconfig:v1beta1/Binding/bindingId": binding_id "/runtimeconfig:v1beta1/Binding/condition": condition "/runtimeconfig:v1beta1/Binding/members": members "/runtimeconfig:v1beta1/Binding/members/member": member @@ -123298,11 +124392,19 @@ "/secretmanager:v1/AuditLogConfig/exemptedMembers/exempted_member": exempted_member "/secretmanager:v1/AuditLogConfig/logType": log_type "/secretmanager:v1/Automatic": automatic +"/secretmanager:v1/Automatic/customerManagedEncryption": customer_managed_encryption +"/secretmanager:v1/AutomaticStatus": automatic_status +"/secretmanager:v1/AutomaticStatus/customerManagedEncryption": customer_managed_encryption "/secretmanager:v1/Binding": binding +"/secretmanager:v1/Binding/bindingId": binding_id "/secretmanager:v1/Binding/condition": condition "/secretmanager:v1/Binding/members": members "/secretmanager:v1/Binding/members/member": member "/secretmanager:v1/Binding/role": role +"/secretmanager:v1/CustomerManagedEncryption": customer_managed_encryption +"/secretmanager:v1/CustomerManagedEncryption/kmsKeyName": kms_key_name +"/secretmanager:v1/CustomerManagedEncryptionStatus": customer_managed_encryption_status +"/secretmanager:v1/CustomerManagedEncryptionStatus/kmsKeyVersionName": kms_key_version_name "/secretmanager:v1/DestroySecretVersionRequest": destroy_secret_version_request "/secretmanager:v1/DisableSecretVersionRequest": disable_secret_version_request "/secretmanager:v1/Empty": empty @@ -123342,10 +124444,17 @@ "/secretmanager:v1/Policy/etag": etag "/secretmanager:v1/Policy/version": version "/secretmanager:v1/Replica": replica +"/secretmanager:v1/Replica/customerManagedEncryption": customer_managed_encryption "/secretmanager:v1/Replica/location": location +"/secretmanager:v1/ReplicaStatus": replica_status +"/secretmanager:v1/ReplicaStatus/customerManagedEncryption": customer_managed_encryption +"/secretmanager:v1/ReplicaStatus/location": location "/secretmanager:v1/Replication": replication "/secretmanager:v1/Replication/automatic": automatic "/secretmanager:v1/Replication/userManaged": user_managed +"/secretmanager:v1/ReplicationStatus": replication_status +"/secretmanager:v1/ReplicationStatus/automatic": automatic +"/secretmanager:v1/ReplicationStatus/userManaged": user_managed "/secretmanager:v1/Secret": secret "/secretmanager:v1/Secret/createTime": create_time "/secretmanager:v1/Secret/labels": labels @@ -123358,6 +124467,7 @@ "/secretmanager:v1/SecretVersion/createTime": create_time "/secretmanager:v1/SecretVersion/destroyTime": destroy_time "/secretmanager:v1/SecretVersion/name": name +"/secretmanager:v1/SecretVersion/replicationStatus": replication_status "/secretmanager:v1/SecretVersion/state": state "/secretmanager:v1/SetIamPolicyRequest": set_iam_policy_request "/secretmanager:v1/SetIamPolicyRequest/policy": policy @@ -123371,6 +124481,9 @@ "/secretmanager:v1/UserManaged": user_managed "/secretmanager:v1/UserManaged/replicas": replicas "/secretmanager:v1/UserManaged/replicas/replica": replica +"/secretmanager:v1/UserManagedStatus": user_managed_status +"/secretmanager:v1/UserManagedStatus/replicas": replicas +"/secretmanager:v1/UserManagedStatus/replicas/replica": replica "/secretmanager:v1/fields": fields "/secretmanager:v1/key": key "/secretmanager:v1/quotaUser": quota_user @@ -123433,6 +124546,7 @@ "/secretmanager:v1beta1/AuditLogConfig/logType": log_type "/secretmanager:v1beta1/Automatic": automatic "/secretmanager:v1beta1/Binding": binding +"/secretmanager:v1beta1/Binding/bindingId": binding_id "/secretmanager:v1beta1/Binding/condition": condition "/secretmanager:v1beta1/Binding/members": members "/secretmanager:v1beta1/Binding/members/member": member @@ -126843,6 +127957,7 @@ "/servicecontrol:v2/servicecontrol.services.report": report_service "/servicecontrol:v2/servicecontrol.services.report/serviceName": service_name "/servicedirectory:v1beta1/Binding": binding +"/servicedirectory:v1beta1/Binding/bindingId": binding_id "/servicedirectory:v1beta1/Binding/condition": condition "/servicedirectory:v1beta1/Binding/members": members "/servicedirectory:v1beta1/Binding/members/member": member @@ -136093,6 +137208,36 @@ "/streetviewpublish:v1/streetviewpublish.photos.list/pageSize": page_size "/streetviewpublish:v1/streetviewpublish.photos.list/pageToken": page_token "/streetviewpublish:v1/streetviewpublish.photos.list/view": view +"/sts:v1/GoogleIdentityStsV1ExchangeTokenRequest": google_identity_sts_v1_exchange_token_request +"/sts:v1/GoogleIdentityStsV1ExchangeTokenRequest/grantType": grant_type +"/sts:v1/GoogleIdentityStsV1ExchangeTokenRequest/options": options +"/sts:v1/GoogleIdentityStsV1ExchangeTokenRequest/requestedTokenType": requested_token_type +"/sts:v1/GoogleIdentityStsV1ExchangeTokenRequest/subjectToken": subject_token +"/sts:v1/GoogleIdentityStsV1ExchangeTokenRequest/subjectTokenType": subject_token_type +"/sts:v1/GoogleIdentityStsV1ExchangeTokenResponse": google_identity_sts_v1_exchange_token_response +"/sts:v1/GoogleIdentityStsV1ExchangeTokenResponse/access_token": access_token +"/sts:v1/GoogleIdentityStsV1ExchangeTokenResponse/expires_in": expires_in +"/sts:v1/GoogleIdentityStsV1ExchangeTokenResponse/issued_token_type": issued_token_type +"/sts:v1/GoogleIdentityStsV1ExchangeTokenResponse/token_type": token_type +"/sts:v1/fields": fields +"/sts:v1/key": key +"/sts:v1/quotaUser": quota_user +"/sts:v1beta/GoogleIdentityStsV1betaExchangeTokenRequest": google_identity_sts_v1beta_exchange_token_request +"/sts:v1beta/GoogleIdentityStsV1betaExchangeTokenRequest/audience": audience +"/sts:v1beta/GoogleIdentityStsV1betaExchangeTokenRequest/grantType": grant_type +"/sts:v1beta/GoogleIdentityStsV1betaExchangeTokenRequest/options": options +"/sts:v1beta/GoogleIdentityStsV1betaExchangeTokenRequest/requestedTokenType": requested_token_type +"/sts:v1beta/GoogleIdentityStsV1betaExchangeTokenRequest/scope": scope +"/sts:v1beta/GoogleIdentityStsV1betaExchangeTokenRequest/subjectToken": subject_token +"/sts:v1beta/GoogleIdentityStsV1betaExchangeTokenRequest/subjectTokenType": subject_token_type +"/sts:v1beta/GoogleIdentityStsV1betaExchangeTokenResponse": google_identity_sts_v1beta_exchange_token_response +"/sts:v1beta/GoogleIdentityStsV1betaExchangeTokenResponse/access_token": access_token +"/sts:v1beta/GoogleIdentityStsV1betaExchangeTokenResponse/expires_in": expires_in +"/sts:v1beta/GoogleIdentityStsV1betaExchangeTokenResponse/issued_token_type": issued_token_type +"/sts:v1beta/GoogleIdentityStsV1betaExchangeTokenResponse/token_type": token_type +"/sts:v1beta/fields": fields +"/sts:v1beta/key": key +"/sts:v1beta/quotaUser": quota_user "/surveys:v2/FieldMask": field_mask "/surveys:v2/FieldMask/fields": fields "/surveys:v2/FieldMask/fields/field": field @@ -139166,6 +140311,8 @@ "/tpu:v1/Node/schedulingConfig": scheduling_config "/tpu:v1/Node/serviceAccount": service_account "/tpu:v1/Node/state": state +"/tpu:v1/Node/symptoms": symptoms +"/tpu:v1/Node/symptoms/symptom": symptom "/tpu:v1/Node/tensorflowVersion": tensorflow_version "/tpu:v1/Node/useServiceNetworking": use_service_networking "/tpu:v1/Operation": operation @@ -139198,6 +140345,11 @@ "/tpu:v1/Status/details/detail/detail": detail "/tpu:v1/Status/message": message "/tpu:v1/StopNodeRequest": stop_node_request +"/tpu:v1/Symptom": symptom +"/tpu:v1/Symptom/createTime": create_time +"/tpu:v1/Symptom/details": details +"/tpu:v1/Symptom/symptomType": symptom_type +"/tpu:v1/Symptom/workerId": worker_id "/tpu:v1/TensorFlowVersion": tensor_flow_version "/tpu:v1/TensorFlowVersion/name": name "/tpu:v1/TensorFlowVersion/version": version @@ -139316,6 +140468,8 @@ "/tpu:v1alpha1/Node/schedulingConfig": scheduling_config "/tpu:v1alpha1/Node/serviceAccount": service_account "/tpu:v1alpha1/Node/state": state +"/tpu:v1alpha1/Node/symptoms": symptoms +"/tpu:v1alpha1/Node/symptoms/symptom": symptom "/tpu:v1alpha1/Node/tensorflowVersion": tensorflow_version "/tpu:v1alpha1/Node/useServiceNetworking": use_service_networking "/tpu:v1alpha1/Operation": operation @@ -139348,6 +140502,11 @@ "/tpu:v1alpha1/Status/details/detail/detail": detail "/tpu:v1alpha1/Status/message": message "/tpu:v1alpha1/StopNodeRequest": stop_node_request +"/tpu:v1alpha1/Symptom": symptom +"/tpu:v1alpha1/Symptom/createTime": create_time +"/tpu:v1alpha1/Symptom/details": details +"/tpu:v1alpha1/Symptom/symptomType": symptom_type +"/tpu:v1alpha1/Symptom/workerId": worker_id "/tpu:v1alpha1/TensorFlowVersion": tensor_flow_version "/tpu:v1alpha1/TensorFlowVersion/name": name "/tpu:v1alpha1/TensorFlowVersion/version": version @@ -141500,6 +142659,8 @@ "/videointelligence:v1/videointelligence.operations.projects.locations.operations.delete/name": name "/videointelligence:v1/videointelligence.operations.projects.locations.operations.get": get_operation_project_location_operation "/videointelligence:v1/videointelligence.operations.projects.locations.operations.get/name": name +"/videointelligence:v1/videointelligence.projects.locations.corpora.operations.get": get_project_location_corpora_operation +"/videointelligence:v1/videointelligence.projects.locations.corpora.operations.get/name": name "/videointelligence:v1/videointelligence.projects.locations.corpura.operations.get": get_project_location_corpura_operation "/videointelligence:v1/videointelligence.projects.locations.corpura.operations.get/name": name "/videointelligence:v1/videointelligence.projects.locations.operations.cancel": cancel_project_location_operation @@ -151598,6 +152759,38 @@ "/websecurityscanner:v1beta/websecurityscanner.projects.scanConfigs.scanRuns.stop/name": name "/websecurityscanner:v1beta/websecurityscanner.projects.scanConfigs.start": start_scan_config_scan_run "/websecurityscanner:v1beta/websecurityscanner.projects.scanConfigs.start/name": name +"/workflowexecutions:v1beta/CancelExecutionRequest": cancel_execution_request +"/workflowexecutions:v1beta/Error": error +"/workflowexecutions:v1beta/Error/context": context +"/workflowexecutions:v1beta/Error/payload": payload +"/workflowexecutions:v1beta/Execution": execution +"/workflowexecutions:v1beta/Execution/argument": argument +"/workflowexecutions:v1beta/Execution/endTime": end_time +"/workflowexecutions:v1beta/Execution/error": error +"/workflowexecutions:v1beta/Execution/name": name +"/workflowexecutions:v1beta/Execution/result": result +"/workflowexecutions:v1beta/Execution/startTime": start_time +"/workflowexecutions:v1beta/Execution/state": state +"/workflowexecutions:v1beta/Execution/workflowRevisionId": workflow_revision_id +"/workflowexecutions:v1beta/ListExecutionsResponse": list_executions_response +"/workflowexecutions:v1beta/ListExecutionsResponse/executions": executions +"/workflowexecutions:v1beta/ListExecutionsResponse/executions/execution": execution +"/workflowexecutions:v1beta/ListExecutionsResponse/nextPageToken": next_page_token +"/workflowexecutions:v1beta/fields": fields +"/workflowexecutions:v1beta/key": key +"/workflowexecutions:v1beta/quotaUser": quota_user +"/workflowexecutions:v1beta/workflowexecutions.projects.locations.workflows.executions.cancel": cancel_execution +"/workflowexecutions:v1beta/workflowexecutions.projects.locations.workflows.executions.cancel/name": name +"/workflowexecutions:v1beta/workflowexecutions.projects.locations.workflows.executions.create": create_project_location_workflow_execution +"/workflowexecutions:v1beta/workflowexecutions.projects.locations.workflows.executions.create/parent": parent +"/workflowexecutions:v1beta/workflowexecutions.projects.locations.workflows.executions.get": get_project_location_workflow_execution +"/workflowexecutions:v1beta/workflowexecutions.projects.locations.workflows.executions.get/name": name +"/workflowexecutions:v1beta/workflowexecutions.projects.locations.workflows.executions.get/view": view +"/workflowexecutions:v1beta/workflowexecutions.projects.locations.workflows.executions.list": list_project_location_workflow_executions +"/workflowexecutions:v1beta/workflowexecutions.projects.locations.workflows.executions.list/pageSize": page_size +"/workflowexecutions:v1beta/workflowexecutions.projects.locations.workflows.executions.list/pageToken": page_token +"/workflowexecutions:v1beta/workflowexecutions.projects.locations.workflows.executions.list/parent": parent +"/workflowexecutions:v1beta/workflowexecutions.projects.locations.workflows.executions.list/view": view "/workflows:v1beta/Empty": empty "/workflows:v1beta/ListLocationsResponse": list_locations_response "/workflows:v1beta/ListLocationsResponse/locations": locations @@ -153227,6 +154420,14 @@ "/youtube:v3/youtube.i18nRegions.list": list_i18n_regions "/youtube:v3/youtube.i18nRegions.list/hl": hl "/youtube:v3/youtube.i18nRegions.list/part": part +"/youtube:v3/youtube.infocards.list": list_infocards +"/youtube:v3/youtube.infocards.list/onBehalfOfContentOwner": on_behalf_of_content_owner +"/youtube:v3/youtube.infocards.list/part": part +"/youtube:v3/youtube.infocards.list/videoId": video_id +"/youtube:v3/youtube.infocards.update": update_infocard +"/youtube:v3/youtube.infocards.update/onBehalfOfContentOwner": on_behalf_of_content_owner +"/youtube:v3/youtube.infocards.update/part": part +"/youtube:v3/youtube.infocards.update/videoId": video_id "/youtube:v3/youtube.liveBroadcasts.bind": bind_live_broadcast "/youtube:v3/youtube.liveBroadcasts.bind/id": id "/youtube:v3/youtube.liveBroadcasts.bind/onBehalfOfContentOwner": on_behalf_of_content_owner diff --git a/generated/google/apis/accessapproval_v1.rb b/generated/google/apis/accessapproval_v1.rb index 6229e636d..3ee26a5e7 100644 --- a/generated/google/apis/accessapproval_v1.rb +++ b/generated/google/apis/accessapproval_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/access-approval/docs module AccessapprovalV1 VERSION = 'V1' - REVISION = '20200807' + REVISION = '20200903' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/accessapproval_v1/classes.rb b/generated/google/apis/accessapproval_v1/classes.rb index 422f1ef91..377bc388a 100644 --- a/generated/google/apis/accessapproval_v1/classes.rb +++ b/generated/google/apis/accessapproval_v1/classes.rb @@ -317,10 +317,12 @@ module Google include Google::Apis::Core::Hashable # The product for which Access Approval will be enrolled. Allowed values are - # listed below (case-sensitive): 1. all 2. appengine.googleapis.com 3. bigquery. - # googleapis.com 4. bigtable.googleapis.com 5. cloudkms.googleapis.com 6. - # compute.googleapis.com 7. dataflow.googleapis.com 8. iam.googleapis.com 9. - # pubsub.googleapis.com 10. storage.googleapis.com + # listed below (case-sensitive): 1. all 2. ga-only 3. appengine.googleapis.com 4. + # bigquery.googleapis.com 5. bigtable.googleapis.com 6. cloudkms.googleapis.com + # 7. compute.googleapis.com 8. dataflow.googleapis.com 9. iam.googleapis.com 10. + # pubsub.googleapis.com 11. storage.googleapis.com Note: 'all' will enroll the + # resource in all products supported at both 'GA' and 'Preview' levels. 'ga-only' + # will only enroll the resource in products supported at 'GA' level. # Corresponds to the JSON property `cloudProduct` # @return [String] attr_accessor :cloud_product diff --git a/generated/google/apis/accesscontextmanager_v1.rb b/generated/google/apis/accesscontextmanager_v1.rb index f589e19f4..fb1f16e0c 100644 --- a/generated/google/apis/accesscontextmanager_v1.rb +++ b/generated/google/apis/accesscontextmanager_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/access-context-manager/docs/reference/rest/ module AccesscontextmanagerV1 VERSION = 'V1' - REVISION = '20200801' + REVISION = '20200825' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/accesscontextmanager_v1beta.rb b/generated/google/apis/accesscontextmanager_v1beta.rb index f0ff2ec9d..4fcdf365d 100644 --- a/generated/google/apis/accesscontextmanager_v1beta.rb +++ b/generated/google/apis/accesscontextmanager_v1beta.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/access-context-manager/docs/reference/rest/ module AccesscontextmanagerV1beta VERSION = 'V1beta' - REVISION = '20200801' + REVISION = '20200825' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/admin_directory_v1.rb b/generated/google/apis/admin_directory_v1.rb index c55797698..0aeebfb4c 100644 --- a/generated/google/apis/admin_directory_v1.rb +++ b/generated/google/apis/admin_directory_v1.rb @@ -27,7 +27,7 @@ module Google # @see http://developers.google.com/admin-sdk/ module AdminDirectoryV1 VERSION = 'DirectoryV1' - REVISION = '20200819' + REVISION = '20200909' # View and manage customer related information AUTH_ADMIN_DIRECTORY_CUSTOMER = 'https://www.googleapis.com/auth/admin.directory.customer' diff --git a/generated/google/apis/admin_directory_v1/classes.rb b/generated/google/apis/admin_directory_v1/classes.rb index 14aaf252d..c80c80a00 100644 --- a/generated/google/apis/admin_directory_v1/classes.rb +++ b/generated/google/apis/admin_directory_v1/classes.rb @@ -3021,7 +3021,7 @@ module Google # Custom fields of the user. # Corresponds to the JSON property `customSchemas` - # @return [Hash] + # @return [Hash>] attr_accessor :custom_schemas # Output only. CustomerId of User (Read-only) @@ -3407,20 +3407,6 @@ module Google end end - # JSON template for a set of custom properties (i.e. all fields in a particular - # schema) - class UserCustomProperties - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - end - end - # JSON template for an email. class UserEmail include Google::Apis::Core::Hashable diff --git a/generated/google/apis/admin_directory_v1/representations.rb b/generated/google/apis/admin_directory_v1/representations.rb index 7633af91f..d14bea369 100644 --- a/generated/google/apis/admin_directory_v1/representations.rb +++ b/generated/google/apis/admin_directory_v1/representations.rb @@ -394,12 +394,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class UserCustomProperties - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class UserEmail class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1270,8 +1264,7 @@ module Google property :change_password_at_next_login, as: 'changePasswordAtNextLogin' property :creation_time, as: 'creationTime', type: DateTime - hash :custom_schemas, as: 'customSchemas', class: Google::Apis::AdminDirectoryV1::UserCustomProperties, decorator: Google::Apis::AdminDirectoryV1::UserCustomProperties::Representation - + hash :custom_schemas, as: 'customSchemas' property :customer_id, as: 'customerId' property :deletion_time, as: 'deletionTime', type: DateTime @@ -1344,12 +1337,6 @@ module Google end end - class UserCustomProperties - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - class UserEmail # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/admin_directory_v1/service.rb b/generated/google/apis/admin_directory_v1/service.rb index 2fabc82e0..1ee25fc85 100644 --- a/generated/google/apis/admin_directory_v1/service.rb +++ b/generated/google/apis/admin_directory_v1/service.rb @@ -3046,6 +3046,35 @@ module Google execute_or_queue_command(command, &block) end + # Turn off 2-Step Verification for user. + # @param [String] user_key + # Identifies the user in the API request. The value can be the user's primary + # email address, alias email address, or unique user ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def turn_two_step_verification_off(user_key, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/users/{userKey}/twoStepVerification/turnOff', options) + command.params['userKey'] = user_key unless user_key.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Delete user # @param [String] user_key # Email or immutable ID of the user @@ -3273,6 +3302,36 @@ module Google execute_or_queue_command(command, &block) end + # Sign a user out of all web and device sessions and reset their sign-in cookies. + # User will have to sign in by authenticating again. + # @param [String] user_key + # Identifies the target user in the API request. The value can be the user's + # primary email address, alias email address, or unique user ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def sign_user_out(user_key, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/users/{userKey}/signOut', options) + command.params['userKey'] = user_key unless user_key.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Undelete a deleted user # @param [String] user_key # The immutable id of the user @@ -3340,6 +3399,9 @@ module Google # Watch for changes in users list # @param [Google::Apis::AdminDirectoryV1::Channel] channel_object + # @param [String] custom_field_mask + # Comma-separated list of schema names. All fields from these schemas are + # fetched. This should only be set when projection=custom. # @param [String] customer # Immutable ID of the G Suite account. In case of multi-domain, to fetch all # users for a customer, fill this field instead of domain. @@ -3348,6 +3410,23 @@ module Google # return all users in a multi-domain fill customer field instead." # @param [String] event # Event on which subscription is intended + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] order_by + # Column to use for sorting results + # @param [String] page_token + # Token to specify next page in the list + # @param [String] projection + # What subset of fields to fetch for this user. + # @param [String] query + # Query string search. Should be of the form "". Complete documentation is at + # https: //developers.google.com/admin-sdk/directory/v1/guides/search-users + # @param [String] show_deleted + # If set to true, retrieves the list of deleted users. (Default: false) + # @param [String] sort_order + # Whether to return results in ascending or descending order. + # @param [String] view_type + # Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3365,15 +3444,24 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def watch_user(channel_object = nil, customer: nil, domain: nil, event: nil, fields: nil, quota_user: nil, options: nil, &block) + def watch_user(channel_object = nil, custom_field_mask: nil, customer: nil, domain: nil, event: nil, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, show_deleted: nil, sort_order: nil, view_type: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'admin/directory/v1/users/watch', options) command.request_representation = Google::Apis::AdminDirectoryV1::Channel::Representation command.request_object = channel_object command.response_representation = Google::Apis::AdminDirectoryV1::Channel::Representation command.response_class = Google::Apis::AdminDirectoryV1::Channel + command.query['customFieldMask'] = custom_field_mask unless custom_field_mask.nil? command.query['customer'] = customer unless customer.nil? command.query['domain'] = domain unless domain.nil? command.query['event'] = event unless event.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['projection'] = projection unless projection.nil? + command.query['query'] = query unless query.nil? + command.query['showDeleted'] = show_deleted unless show_deleted.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['viewType'] = view_type unless view_type.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) diff --git a/generated/google/apis/admob_v1.rb b/generated/google/apis/admob_v1.rb index 3a7552ef0..93e8e5c36 100644 --- a/generated/google/apis/admob_v1.rb +++ b/generated/google/apis/admob_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/admob/api/ module AdmobV1 VERSION = 'V1' - REVISION = '20200822' + REVISION = '20200905' end end end diff --git a/generated/google/apis/analyticsdata_v1alpha.rb b/generated/google/apis/analyticsdata_v1alpha.rb new file mode 100644 index 000000000..91cf4f040 --- /dev/null +++ b/generated/google/apis/analyticsdata_v1alpha.rb @@ -0,0 +1,37 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/analyticsdata_v1alpha/service.rb' +require 'google/apis/analyticsdata_v1alpha/classes.rb' +require 'google/apis/analyticsdata_v1alpha/representations.rb' + +module Google + module Apis + # Google Analytics Data API + # + # Accesses report data in Google Analytics. + # + # @see https://developers.google.com/analytics/trusted-testing/analytics-data/ + module AnalyticsdataV1alpha + VERSION = 'V1alpha' + REVISION = '20200907' + + # View and manage your Google Analytics data + AUTH_ANALYTICS = 'https://www.googleapis.com/auth/analytics' + + # View your Google Analytics data + AUTH_ANALYTICS_READONLY = 'https://www.googleapis.com/auth/analytics.readonly' + end + end +end diff --git a/generated/google/apis/analyticsdata_v1alpha/classes.rb b/generated/google/apis/analyticsdata_v1alpha/classes.rb new file mode 100644 index 000000000..c2b11df80 --- /dev/null +++ b/generated/google/apis/analyticsdata_v1alpha/classes.rb @@ -0,0 +1,1610 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module AnalyticsdataV1alpha + + # The batch request containing multiple pivot report requests. + class BatchRunPivotReportsRequest + include Google::Apis::Core::Hashable + + # The unique identifier of the property whose events are tracked. + # Corresponds to the JSON property `entity` + # @return [Google::Apis::AnalyticsdataV1alpha::Entity] + attr_accessor :entity + + # Individual requests. Each request has a separate pivot report response. Each + # batch request is allowed up to 5 requests. + # Corresponds to the JSON property `requests` + # @return [Array] + attr_accessor :requests + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @entity = args[:entity] if args.key?(:entity) + @requests = args[:requests] if args.key?(:requests) + end + end + + # The batch response containing multiple pivot reports. + class BatchRunPivotReportsResponse + include Google::Apis::Core::Hashable + + # Individual responses. Each response has a separate pivot report request. + # Corresponds to the JSON property `pivotReports` + # @return [Array] + attr_accessor :pivot_reports + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @pivot_reports = args[:pivot_reports] if args.key?(:pivot_reports) + end + end + + # The batch request containing multiple report requests. + class BatchRunReportsRequest + include Google::Apis::Core::Hashable + + # The unique identifier of the property whose events are tracked. + # Corresponds to the JSON property `entity` + # @return [Google::Apis::AnalyticsdataV1alpha::Entity] + attr_accessor :entity + + # Individual requests. Each request has a separate report response. Each batch + # request is allowed up to 5 requests. + # Corresponds to the JSON property `requests` + # @return [Array] + attr_accessor :requests + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @entity = args[:entity] if args.key?(:entity) + @requests = args[:requests] if args.key?(:requests) + end + end + + # The batch response containing multiple reports. + class BatchRunReportsResponse + include Google::Apis::Core::Hashable + + # Individual responses. Each response has a separate report request. + # Corresponds to the JSON property `reports` + # @return [Array] + attr_accessor :reports + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @reports = args[:reports] if args.key?(:reports) + end + end + + # To express that the result needs to be between two numbers (inclusive). + class BetweenFilter + include Google::Apis::Core::Hashable + + # To represent a number. + # Corresponds to the JSON property `fromValue` + # @return [Google::Apis::AnalyticsdataV1alpha::NumericValue] + attr_accessor :from_value + + # To represent a number. + # Corresponds to the JSON property `toValue` + # @return [Google::Apis::AnalyticsdataV1alpha::NumericValue] + attr_accessor :to_value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @from_value = args[:from_value] if args.key?(:from_value) + @to_value = args[:to_value] if args.key?(:to_value) + end + end + + # Used to convert a dimension value to a single case. + class CaseExpression + include Google::Apis::Core::Hashable + + # Name of a dimension. The name must refer back to a name in dimensions field of + # the request. + # Corresponds to the JSON property `dimensionName` + # @return [String] + attr_accessor :dimension_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension_name = args[:dimension_name] if args.key?(:dimension_name) + end + end + + # Defines a cohort. A cohort is a group of users who share a common + # characteristic. For example, all users with the same acquisition date belong + # to the same cohort. + class Cohort + include Google::Apis::Core::Hashable + + # A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are + # allowed up to 4 date ranges, and the union of the ranges can cover up to 1 + # year. + # Corresponds to the JSON property `dateRange` + # @return [Google::Apis::AnalyticsdataV1alpha::DateRange] + attr_accessor :date_range + + # The dimension used by cohort. Only supports `firstTouchDate` for retention + # report. + # Corresponds to the JSON property `dimension` + # @return [String] + attr_accessor :dimension + + # Assigns a name to this cohort. The dimension `cohort` is valued to this name + # in a report response. If set, cannot begin with `cohort_` or `RESERVED_`. If + # not set, cohorts are named by their zero based index `cohort_0`, `cohort_1`, + # etc. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @date_range = args[:date_range] if args.key?(:date_range) + @dimension = args[:dimension] if args.key?(:dimension) + @name = args[:name] if args.key?(:name) + end + end + + # Settings of a cohort report. + class CohortReportSettings + include Google::Apis::Core::Hashable + + # If true, accumulates the result from first visit day to the end day. Not + # supported in `RunReportRequest`. + # Corresponds to the JSON property `accumulate` + # @return [Boolean] + attr_accessor :accumulate + alias_method :accumulate?, :accumulate + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @accumulate = args[:accumulate] if args.key?(:accumulate) + end + end + + # Specification for a cohort report. + class CohortSpec + include Google::Apis::Core::Hashable + + # Settings of a cohort report. + # Corresponds to the JSON property `cohortReportSettings` + # @return [Google::Apis::AnalyticsdataV1alpha::CohortReportSettings] + attr_accessor :cohort_report_settings + + # The definition for the cohorts. + # Corresponds to the JSON property `cohorts` + # @return [Array] + attr_accessor :cohorts + + # Describes date range for a cohort report. + # Corresponds to the JSON property `cohortsRange` + # @return [Google::Apis::AnalyticsdataV1alpha::CohortsRange] + attr_accessor :cohorts_range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cohort_report_settings = args[:cohort_report_settings] if args.key?(:cohort_report_settings) + @cohorts = args[:cohorts] if args.key?(:cohorts) + @cohorts_range = args[:cohorts_range] if args.key?(:cohorts_range) + end + end + + # Describes date range for a cohort report. + class CohortsRange + include Google::Apis::Core::Hashable + + # For daily cohorts, this will be the end day offset. For weekly cohorts, this + # will be the week offset. + # Corresponds to the JSON property `endOffset` + # @return [Fixnum] + attr_accessor :end_offset + + # Reporting date range for each cohort is calculated based on these three fields. + # Corresponds to the JSON property `granularity` + # @return [String] + attr_accessor :granularity + + # For daily cohorts, this will be the start day offset. For weekly cohorts, this + # will be the week offset. + # Corresponds to the JSON property `startOffset` + # @return [Fixnum] + attr_accessor :start_offset + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_offset = args[:end_offset] if args.key?(:end_offset) + @granularity = args[:granularity] if args.key?(:granularity) + @start_offset = args[:start_offset] if args.key?(:start_offset) + end + end + + # Used to combine dimension values to a single dimension. + class ConcatenateExpression + include Google::Apis::Core::Hashable + + # The delimiter placed between dimension names. Delimiters are often single + # characters such as "|" or "," but can be longer strings. If a dimension value + # contains the delimiter, both will be present in response with no distinction. + # For example if dimension 1 value = "US,FR", dimension 2 value = "JP", and + # delimiter = ",", then the response will contain "US,FR,JP". + # Corresponds to the JSON property `delimiter` + # @return [String] + attr_accessor :delimiter + + # Names of dimensions. The names must refer back to names in the dimensions + # field of the request. + # Corresponds to the JSON property `dimensionNames` + # @return [Array] + attr_accessor :dimension_names + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @delimiter = args[:delimiter] if args.key?(:delimiter) + @dimension_names = args[:dimension_names] if args.key?(:dimension_names) + end + end + + # A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are + # allowed up to 4 date ranges, and the union of the ranges can cover up to 1 + # year. + class DateRange + include Google::Apis::Core::Hashable + + # The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be + # before `start_date`. The format `NdaysAgo`, `yesterday`, or `today` is also + # accepted, and in that case, the date is inferred based on the property's + # reporting time zone. + # Corresponds to the JSON property `endDate` + # @return [String] + attr_accessor :end_date + + # Assigns a name to this date range. The dimension `dateRange` is valued to this + # name in a report response. If set, cannot begin with `date_range_` or ` + # RESERVED_`. If not set, date ranges are named by their zero based index in the + # request: `date_range_0`, `date_range_1`, etc. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be + # after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also + # accepted, and in that case, the date is inferred based on the property's + # reporting time zone. + # Corresponds to the JSON property `startDate` + # @return [String] + attr_accessor :start_date + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_date = args[:end_date] if args.key?(:end_date) + @name = args[:name] if args.key?(:name) + @start_date = args[:start_date] if args.key?(:start_date) + end + end + + # Dimensions are attributes of your data. For example, the dimension City + # indicates the city, for example, "Paris" or "New York", from which an event + # originates. Requests are allowed up to 8 dimensions. + class Dimension + include Google::Apis::Core::Hashable + + # Used to express a dimension which is the result of a formula of multiple + # dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, + # symbol, dimension2). + # Corresponds to the JSON property `dimensionExpression` + # @return [Google::Apis::AnalyticsdataV1alpha::DimensionExpression] + attr_accessor :dimension_expression + + # The name of the dimension. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension_expression = args[:dimension_expression] if args.key?(:dimension_expression) + @name = args[:name] if args.key?(:name) + end + end + + # Used to express a dimension which is the result of a formula of multiple + # dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, + # symbol, dimension2). + class DimensionExpression + include Google::Apis::Core::Hashable + + # Used to combine dimension values to a single dimension. + # Corresponds to the JSON property `concatenate` + # @return [Google::Apis::AnalyticsdataV1alpha::ConcatenateExpression] + attr_accessor :concatenate + + # Used to convert a dimension value to a single case. + # Corresponds to the JSON property `lowerCase` + # @return [Google::Apis::AnalyticsdataV1alpha::CaseExpression] + attr_accessor :lower_case + + # Used to convert a dimension value to a single case. + # Corresponds to the JSON property `upperCase` + # @return [Google::Apis::AnalyticsdataV1alpha::CaseExpression] + attr_accessor :upper_case + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @concatenate = args[:concatenate] if args.key?(:concatenate) + @lower_case = args[:lower_case] if args.key?(:lower_case) + @upper_case = args[:upper_case] if args.key?(:upper_case) + end + end + + # Describes a dimension column in the report. Dimensions requested in a report + # produce column entries within rows and DimensionHeaders. However, dimensions + # used exclusively within filters or expressions do not produce columns in a + # report; correspondingly, those dimensions do not produce headers. + class DimensionHeader + include Google::Apis::Core::Hashable + + # The dimension's name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + end + end + + # Explains a dimension. + class DimensionMetadata + include Google::Apis::Core::Hashable + + # This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For + # example, `eventName`. + # Corresponds to the JSON property `apiName` + # @return [String] + attr_accessor :api_name + + # Still usable but deprecated names for this dimension. If populated, this + # dimension is available by either `apiName` or one of `deprecatedApiNames` for + # a period of time. After the deprecation period, the dimension will be + # available only by `apiName`. + # Corresponds to the JSON property `deprecatedApiNames` + # @return [Array] + attr_accessor :deprecated_api_names + + # Description of how this dimension is used and calculated. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # This dimension's name within the Google Analytics user interface. For example, + # `Event name`. + # Corresponds to the JSON property `uiName` + # @return [String] + attr_accessor :ui_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @api_name = args[:api_name] if args.key?(:api_name) + @deprecated_api_names = args[:deprecated_api_names] if args.key?(:deprecated_api_names) + @description = args[:description] if args.key?(:description) + @ui_name = args[:ui_name] if args.key?(:ui_name) + end + end + + # Sorts by dimension values. + class DimensionOrderBy + include Google::Apis::Core::Hashable + + # A dimension name in the request to order by. + # Corresponds to the JSON property `dimensionName` + # @return [String] + attr_accessor :dimension_name + + # Controls the rule for dimension value ordering. + # Corresponds to the JSON property `orderType` + # @return [String] + attr_accessor :order_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension_name = args[:dimension_name] if args.key?(:dimension_name) + @order_type = args[:order_type] if args.key?(:order_type) + end + end + + # The value of a dimension. + class DimensionValue + include Google::Apis::Core::Hashable + + # Value as a string if the dimension type is a string. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @value = args[:value] if args.key?(:value) + end + end + + # The unique identifier of the property whose events are tracked. + class Entity + include Google::Apis::Core::Hashable + + # A Google Analytics App + Web property id. + # Corresponds to the JSON property `propertyId` + # @return [String] + attr_accessor :property_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @property_id = args[:property_id] if args.key?(:property_id) + end + end + + # An expression to filter dimension or metric values. + class Filter + include Google::Apis::Core::Hashable + + # To express that the result needs to be between two numbers (inclusive). + # Corresponds to the JSON property `betweenFilter` + # @return [Google::Apis::AnalyticsdataV1alpha::BetweenFilter] + attr_accessor :between_filter + + # The dimension name or metric name. Must be a name defined in dimensions or + # metrics. + # Corresponds to the JSON property `fieldName` + # @return [String] + attr_accessor :field_name + + # The result needs to be in a list of string values. + # Corresponds to the JSON property `inListFilter` + # @return [Google::Apis::AnalyticsdataV1alpha::InListFilter] + attr_accessor :in_list_filter + + # A filter for null values. + # Corresponds to the JSON property `nullFilter` + # @return [Boolean] + attr_accessor :null_filter + alias_method :null_filter?, :null_filter + + # Filters for numeric or date values. + # Corresponds to the JSON property `numericFilter` + # @return [Google::Apis::AnalyticsdataV1alpha::NumericFilter] + attr_accessor :numeric_filter + + # The filter for string + # Corresponds to the JSON property `stringFilter` + # @return [Google::Apis::AnalyticsdataV1alpha::StringFilter] + attr_accessor :string_filter + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @between_filter = args[:between_filter] if args.key?(:between_filter) + @field_name = args[:field_name] if args.key?(:field_name) + @in_list_filter = args[:in_list_filter] if args.key?(:in_list_filter) + @null_filter = args[:null_filter] if args.key?(:null_filter) + @numeric_filter = args[:numeric_filter] if args.key?(:numeric_filter) + @string_filter = args[:string_filter] if args.key?(:string_filter) + end + end + + # To express dimension or metric filters. The fields in the same + # FilterExpression need to be either all dimensions or all metrics. + class FilterExpression + include Google::Apis::Core::Hashable + + # A list of filter expressions. + # Corresponds to the JSON property `andGroup` + # @return [Google::Apis::AnalyticsdataV1alpha::FilterExpressionList] + attr_accessor :and_group + + # An expression to filter dimension or metric values. + # Corresponds to the JSON property `filter` + # @return [Google::Apis::AnalyticsdataV1alpha::Filter] + attr_accessor :filter + + # To express dimension or metric filters. The fields in the same + # FilterExpression need to be either all dimensions or all metrics. + # Corresponds to the JSON property `notExpression` + # @return [Google::Apis::AnalyticsdataV1alpha::FilterExpression] + attr_accessor :not_expression + + # A list of filter expressions. + # Corresponds to the JSON property `orGroup` + # @return [Google::Apis::AnalyticsdataV1alpha::FilterExpressionList] + attr_accessor :or_group + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @and_group = args[:and_group] if args.key?(:and_group) + @filter = args[:filter] if args.key?(:filter) + @not_expression = args[:not_expression] if args.key?(:not_expression) + @or_group = args[:or_group] if args.key?(:or_group) + end + end + + # A list of filter expressions. + class FilterExpressionList + include Google::Apis::Core::Hashable + + # A list of filter expressions. + # Corresponds to the JSON property `expressions` + # @return [Array] + attr_accessor :expressions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @expressions = args[:expressions] if args.key?(:expressions) + end + end + + # The result needs to be in a list of string values. + class InListFilter + include Google::Apis::Core::Hashable + + # If true, the string value is case sensitive. + # Corresponds to the JSON property `caseSensitive` + # @return [Boolean] + attr_accessor :case_sensitive + alias_method :case_sensitive?, :case_sensitive + + # The list of string values. Must be non-empty. + # Corresponds to the JSON property `values` + # @return [Array] + attr_accessor :values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive) + @values = args[:values] if args.key?(:values) + end + end + + # The quantitative measurements of a report. For example, the metric eventCount + # is the total number of events. Requests are allowed up to 10 metrics. + class Metric + include Google::Apis::Core::Hashable + + # A mathematical expression for derived metrics. For example, the metric Event + # count per user is eventCount/totalUsers. + # Corresponds to the JSON property `expression` + # @return [String] + attr_accessor :expression + + # Indicates if a metric is invisible. If a metric is invisible, the metric is + # not in the response, but can be used in filters, order_bys or being referred + # to in a metric expression. + # Corresponds to the JSON property `invisible` + # @return [Boolean] + attr_accessor :invisible + alias_method :invisible?, :invisible + + # The name of the metric. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @expression = args[:expression] if args.key?(:expression) + @invisible = args[:invisible] if args.key?(:invisible) + @name = args[:name] if args.key?(:name) + end + end + + # Describes a metric column in the report. Visible metrics requested in a report + # produce column entries within rows and MetricHeaders. However, metrics used + # exclusively within filters or expressions do not produce columns in a report; + # correspondingly, those metrics do not produce headers. + class MetricHeader + include Google::Apis::Core::Hashable + + # The metric's name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The metric's data type. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @type = args[:type] if args.key?(:type) + end + end + + # Explains a metric. + class MetricMetadata + include Google::Apis::Core::Hashable + + # A metric name. Useable in [Metric](#Metric)'s `name`. For example, `eventCount` + # . + # Corresponds to the JSON property `apiName` + # @return [String] + attr_accessor :api_name + + # Still usable but deprecated names for this metric. If populated, this metric + # is available by either `apiName` or one of `deprecatedApiNames` for a period + # of time. After the deprecation period, the metric will be available only by ` + # apiName`. + # Corresponds to the JSON property `deprecatedApiNames` + # @return [Array] + attr_accessor :deprecated_api_names + + # Description of how this metric is used and calculated. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The mathematical expression for this derived metric. Can be used in [Metric](# + # Metric)'s `expression` field for equivalent reports. Most metrics are not + # expressions, and for non-expressions, this field is empty. + # Corresponds to the JSON property `expression` + # @return [String] + attr_accessor :expression + + # The type of this metric. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # This metric's name within the Google Analytics user interface. For example, ` + # Event count`. + # Corresponds to the JSON property `uiName` + # @return [String] + attr_accessor :ui_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @api_name = args[:api_name] if args.key?(:api_name) + @deprecated_api_names = args[:deprecated_api_names] if args.key?(:deprecated_api_names) + @description = args[:description] if args.key?(:description) + @expression = args[:expression] if args.key?(:expression) + @type = args[:type] if args.key?(:type) + @ui_name = args[:ui_name] if args.key?(:ui_name) + end + end + + # Sorts by metric values. + class MetricOrderBy + include Google::Apis::Core::Hashable + + # A metric name in the request to order by. + # Corresponds to the JSON property `metricName` + # @return [String] + attr_accessor :metric_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @metric_name = args[:metric_name] if args.key?(:metric_name) + end + end + + # The value of a metric. + class MetricValue + include Google::Apis::Core::Hashable + + # Measurement value. See MetricHeader for type. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @value = args[:value] if args.key?(:value) + end + end + + # Filters for numeric or date values. + class NumericFilter + include Google::Apis::Core::Hashable + + # The operation type for this filter. + # Corresponds to the JSON property `operation` + # @return [String] + attr_accessor :operation + + # To represent a number. + # Corresponds to the JSON property `value` + # @return [Google::Apis::AnalyticsdataV1alpha::NumericValue] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @operation = args[:operation] if args.key?(:operation) + @value = args[:value] if args.key?(:value) + end + end + + # To represent a number. + class NumericValue + include Google::Apis::Core::Hashable + + # Double value + # Corresponds to the JSON property `doubleValue` + # @return [Float] + attr_accessor :double_value + + # Integer value + # Corresponds to the JSON property `int64Value` + # @return [Fixnum] + attr_accessor :int64_value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @double_value = args[:double_value] if args.key?(:double_value) + @int64_value = args[:int64_value] if args.key?(:int64_value) + end + end + + # The sort options. + class OrderBy + include Google::Apis::Core::Hashable + + # If true, sorts by descending order. + # Corresponds to the JSON property `desc` + # @return [Boolean] + attr_accessor :desc + alias_method :desc?, :desc + + # Sorts by dimension values. + # Corresponds to the JSON property `dimension` + # @return [Google::Apis::AnalyticsdataV1alpha::DimensionOrderBy] + attr_accessor :dimension + + # Sorts by metric values. + # Corresponds to the JSON property `metric` + # @return [Google::Apis::AnalyticsdataV1alpha::MetricOrderBy] + attr_accessor :metric + + # Sorts by a pivot column group. + # Corresponds to the JSON property `pivot` + # @return [Google::Apis::AnalyticsdataV1alpha::PivotOrderBy] + attr_accessor :pivot + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @desc = args[:desc] if args.key?(:desc) + @dimension = args[:dimension] if args.key?(:dimension) + @metric = args[:metric] if args.key?(:metric) + @pivot = args[:pivot] if args.key?(:pivot) + end + end + + # Describes the visible dimension columns and rows in the report response. + class Pivot + include Google::Apis::Core::Hashable + + # Dimension names for visible columns in the report response. Including " + # dateRange" produces a date range column; for each row in the response, + # dimension values in the date range column will indicate the corresponding date + # range from the request. + # Corresponds to the JSON property `fieldNames` + # @return [Array] + attr_accessor :field_names + + # The number of rows to return in this pivot. If unspecified, 10 rows are + # returned. If -1, all rows are returned. + # Corresponds to the JSON property `limit` + # @return [Fixnum] + attr_accessor :limit + + # Aggregate the metrics by dimensions in this pivot using the specified + # metric_aggregations. + # Corresponds to the JSON property `metricAggregations` + # @return [Array] + attr_accessor :metric_aggregations + + # The row count of the start row. The first row is counted as row 0. + # Corresponds to the JSON property `offset` + # @return [Fixnum] + attr_accessor :offset + + # Specifies how dimensions are ordered in the pivot. In the first Pivot, the + # OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, + # the OrderBys determine only PivotDimensionHeader ordering. Dimensions + # specified in these OrderBys must be a subset of Pivot.field_names. + # Corresponds to the JSON property `orderBys` + # @return [Array] + attr_accessor :order_bys + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @field_names = args[:field_names] if args.key?(:field_names) + @limit = args[:limit] if args.key?(:limit) + @metric_aggregations = args[:metric_aggregations] if args.key?(:metric_aggregations) + @offset = args[:offset] if args.key?(:offset) + @order_bys = args[:order_bys] if args.key?(:order_bys) + end + end + + # Summarizes dimension values from a row for this pivot. + class PivotDimensionHeader + include Google::Apis::Core::Hashable + + # Values of multiple dimensions in a pivot. + # Corresponds to the JSON property `dimensionValues` + # @return [Array] + attr_accessor :dimension_values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension_values = args[:dimension_values] if args.key?(:dimension_values) + end + end + + # Dimensions' values in a single pivot. + class PivotHeader + include Google::Apis::Core::Hashable + + # The size is the same as the cardinality of the corresponding dimension + # combinations. + # Corresponds to the JSON property `pivotDimensionHeaders` + # @return [Array] + attr_accessor :pivot_dimension_headers + + # The cardinality of the pivot as if offset = 0 and limit = -1. The total number + # of rows for this pivot's fields regardless of how the parameters offset and + # limit are specified in the request. + # Corresponds to the JSON property `rowCount` + # @return [Fixnum] + attr_accessor :row_count + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @pivot_dimension_headers = args[:pivot_dimension_headers] if args.key?(:pivot_dimension_headers) + @row_count = args[:row_count] if args.key?(:row_count) + end + end + + # Sorts by a pivot column group. + class PivotOrderBy + include Google::Apis::Core::Hashable + + # In the response to order by, order rows by this column. Must be a metric name + # from the request. + # Corresponds to the JSON property `metricName` + # @return [String] + attr_accessor :metric_name + + # Used to select a dimension name and value pivot. If multiple pivot selections + # are given, the sort occurs on rows where all pivot selection dimension name + # and value pairs match the row's dimension name and value pair. + # Corresponds to the JSON property `pivotSelections` + # @return [Array] + attr_accessor :pivot_selections + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @metric_name = args[:metric_name] if args.key?(:metric_name) + @pivot_selections = args[:pivot_selections] if args.key?(:pivot_selections) + end + end + + # A pair of dimension names and values. Rows with this dimension pivot pair are + # ordered by the metric's value. For example if pivots = ``"browser", "Chrome"`` + # and metric_name = "Sessions", then the rows will be sorted based on Sessions + # in Chrome. ---------|----------|----------------|----------|---------------- | + # Chrome | Chrome | Safari | Safari ---------|----------|----------------|------- + # ---|---------------- Country | Sessions | Pages/Sessions | Sessions | Pages/ + # Sessions ---------|----------|----------------|----------|---------------- US | + # 2 | 2 | 3 | 1 ---------|----------|----------------|----------|--------------- + # - Canada | 3 | 1 | 4 | 1 ---------|----------|----------------|----------|----- + # ----------- + class PivotSelection + include Google::Apis::Core::Hashable + + # Must be a dimension name from the request. + # Corresponds to the JSON property `dimensionName` + # @return [String] + attr_accessor :dimension_name + + # Order by only when the named dimension is this value. + # Corresponds to the JSON property `dimensionValue` + # @return [String] + attr_accessor :dimension_value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension_name = args[:dimension_name] if args.key?(:dimension_name) + @dimension_value = args[:dimension_value] if args.key?(:dimension_value) + end + end + + # Current state of all quotas for this Analytics Property. If any quota for a + # property is exhausted, all requests to that property will return Resource + # Exhausted errors. + class PropertyQuota + include Google::Apis::Core::Hashable + + # Current state for a particular quota group. + # Corresponds to the JSON property `concurrentRequests` + # @return [Google::Apis::AnalyticsdataV1alpha::QuotaStatus] + attr_accessor :concurrent_requests + + # Current state for a particular quota group. + # Corresponds to the JSON property `serverErrorsPerProjectPerHour` + # @return [Google::Apis::AnalyticsdataV1alpha::QuotaStatus] + attr_accessor :server_errors_per_project_per_hour + + # Current state for a particular quota group. + # Corresponds to the JSON property `tokensPerDay` + # @return [Google::Apis::AnalyticsdataV1alpha::QuotaStatus] + attr_accessor :tokens_per_day + + # Current state for a particular quota group. + # Corresponds to the JSON property `tokensPerHour` + # @return [Google::Apis::AnalyticsdataV1alpha::QuotaStatus] + attr_accessor :tokens_per_hour + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @concurrent_requests = args[:concurrent_requests] if args.key?(:concurrent_requests) + @server_errors_per_project_per_hour = args[:server_errors_per_project_per_hour] if args.key?(:server_errors_per_project_per_hour) + @tokens_per_day = args[:tokens_per_day] if args.key?(:tokens_per_day) + @tokens_per_hour = args[:tokens_per_hour] if args.key?(:tokens_per_hour) + end + end + + # Current state for a particular quota group. + class QuotaStatus + include Google::Apis::Core::Hashable + + # Quota consumed by this request. + # Corresponds to the JSON property `consumed` + # @return [Fixnum] + attr_accessor :consumed + + # Quota remaining after this request. + # Corresponds to the JSON property `remaining` + # @return [Fixnum] + attr_accessor :remaining + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @consumed = args[:consumed] if args.key?(:consumed) + @remaining = args[:remaining] if args.key?(:remaining) + end + end + + # Response's metadata carrying additional information about the report content. + class ResponseMetaData + include Google::Apis::Core::Hashable + + # If true, indicates some buckets of dimension combinations are rolled into "( + # other)" row. This can happen for high cardinality reports. + # Corresponds to the JSON property `dataLossFromOtherRow` + # @return [Boolean] + attr_accessor :data_loss_from_other_row + alias_method :data_loss_from_other_row?, :data_loss_from_other_row + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @data_loss_from_other_row = args[:data_loss_from_other_row] if args.key?(:data_loss_from_other_row) + end + end + + # Report data for each row. For example if RunReportRequest contains: ```none + # dimensions ` name: "eventName" ` dimensions ` name: "countryId" ` metrics ` + # name: "eventCount" ` ``` One row with 'in_app_purchase' as the eventName, 'us' + # as the countryId, and 15 as the eventCount, would be: ```none dimension_values + # ` name: 'in_app_purchase' name: 'us' ` metric_values ` int64_value: 15 ` ``` + class Row + include Google::Apis::Core::Hashable + + # List of requested dimension values. In a PivotReport, dimension_values are + # only listed for dimensions included in a pivot. + # Corresponds to the JSON property `dimensionValues` + # @return [Array] + attr_accessor :dimension_values + + # List of requested visible metric values. + # Corresponds to the JSON property `metricValues` + # @return [Array] + attr_accessor :metric_values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension_values = args[:dimension_values] if args.key?(:dimension_values) + @metric_values = args[:metric_values] if args.key?(:metric_values) + end + end + + # The request to generate a pivot report. + class RunPivotReportRequest + include Google::Apis::Core::Hashable + + # Specification for a cohort report. + # Corresponds to the JSON property `cohortSpec` + # @return [Google::Apis::AnalyticsdataV1alpha::CohortSpec] + attr_accessor :cohort_spec + + # A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field + # is empty, the report uses the entity's default currency. + # Corresponds to the JSON property `currencyCode` + # @return [String] + attr_accessor :currency_code + + # The date range to retrieve event data for the report. If multiple date ranges + # are specified, event data from each date range is used in the report. A + # special dimension with field name "dateRange" can be included in a Pivot's + # field names; if included, the report compares between date ranges. In a cohort + # request, this `dateRanges` must be unspecified. + # Corresponds to the JSON property `dateRanges` + # @return [Array] + attr_accessor :date_ranges + + # To express dimension or metric filters. The fields in the same + # FilterExpression need to be either all dimensions or all metrics. + # Corresponds to the JSON property `dimensionFilter` + # @return [Google::Apis::AnalyticsdataV1alpha::FilterExpression] + attr_accessor :dimension_filter + + # The dimensions requested. All defined dimensions must be used by one of the + # following: dimension_expression, dimension_filter, pivots, order_bys. + # Corresponds to the JSON property `dimensions` + # @return [Array] + attr_accessor :dimensions + + # The unique identifier of the property whose events are tracked. + # Corresponds to the JSON property `entity` + # @return [Google::Apis::AnalyticsdataV1alpha::Entity] + attr_accessor :entity + + # If false or unspecified, each row with all metrics equal to 0 will not be + # returned. If true, these rows will be returned if they are not separately + # removed by a filter. + # Corresponds to the JSON property `keepEmptyRows` + # @return [Boolean] + attr_accessor :keep_empty_rows + alias_method :keep_empty_rows?, :keep_empty_rows + + # To express dimension or metric filters. The fields in the same + # FilterExpression need to be either all dimensions or all metrics. + # Corresponds to the JSON property `metricFilter` + # @return [Google::Apis::AnalyticsdataV1alpha::FilterExpression] + attr_accessor :metric_filter + + # The metrics requested, at least one metric needs to be specified. All defined + # metrics must be used by one of the following: metric_expression, metric_filter, + # order_bys. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # Describes the visual format of the report's dimensions in columns or rows. The + # union of the fieldNames (dimension names) in all pivots must be a subset of + # dimension names defined in Dimensions. No two pivots can share a dimension. A + # dimension is only visible if it appears in a pivot. + # Corresponds to the JSON property `pivots` + # @return [Array] + attr_accessor :pivots + + # Toggles whether to return the current state of this Analytics Property's quota. + # Quota is returned in [PropertyQuota](#PropertyQuota). + # Corresponds to the JSON property `returnPropertyQuota` + # @return [Boolean] + attr_accessor :return_property_quota + alias_method :return_property_quota?, :return_property_quota + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cohort_spec = args[:cohort_spec] if args.key?(:cohort_spec) + @currency_code = args[:currency_code] if args.key?(:currency_code) + @date_ranges = args[:date_ranges] if args.key?(:date_ranges) + @dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @entity = args[:entity] if args.key?(:entity) + @keep_empty_rows = args[:keep_empty_rows] if args.key?(:keep_empty_rows) + @metric_filter = args[:metric_filter] if args.key?(:metric_filter) + @metrics = args[:metrics] if args.key?(:metrics) + @pivots = args[:pivots] if args.key?(:pivots) + @return_property_quota = args[:return_property_quota] if args.key?(:return_property_quota) + end + end + + # The response pivot report table corresponding to a pivot request. + class RunPivotReportResponse + include Google::Apis::Core::Hashable + + # Aggregation of metric values. Can be totals, minimums, or maximums. The + # returned aggregations are controlled by the metric_aggregations in the pivot. + # The type of aggregation returned in each row is shown by the dimension_values + # which are set to "RESERVED_". + # Corresponds to the JSON property `aggregates` + # @return [Array] + attr_accessor :aggregates + + # Describes dimension columns. The number of DimensionHeaders and ordering of + # DimensionHeaders matches the dimensions present in rows. + # Corresponds to the JSON property `dimensionHeaders` + # @return [Array] + attr_accessor :dimension_headers + + # Response's metadata carrying additional information about the report content. + # Corresponds to the JSON property `metadata` + # @return [Google::Apis::AnalyticsdataV1alpha::ResponseMetaData] + attr_accessor :metadata + + # Describes metric columns. The number of MetricHeaders and ordering of + # MetricHeaders matches the metrics present in rows. + # Corresponds to the JSON property `metricHeaders` + # @return [Array] + attr_accessor :metric_headers + + # Summarizes the columns and rows created by a pivot. Each pivot in the request + # produces one header in the response. If we have a request like this: "pivots": + # [` "fieldNames": ["country", "city"] `, ` "fieldNames": "eventName" `] We will + # have the following `pivotHeaders` in the response: "pivotHeaders" : [` " + # dimensionHeaders": [` "dimensionValues": [ ` "value": "United Kingdom" `, ` " + # value": "London" ` ] `, ` "dimensionValues": [ ` "value": "Japan" `, ` "value": + # "Osaka" ` ] `] `, ` "dimensionHeaders": [` "dimensionValues": [` "value": " + # session_start" `] `, ` "dimensionValues": [` "value": "scroll" `] `] `] + # Corresponds to the JSON property `pivotHeaders` + # @return [Array] + attr_accessor :pivot_headers + + # Current state of all quotas for this Analytics Property. If any quota for a + # property is exhausted, all requests to that property will return Resource + # Exhausted errors. + # Corresponds to the JSON property `propertyQuota` + # @return [Google::Apis::AnalyticsdataV1alpha::PropertyQuota] + attr_accessor :property_quota + + # Rows of dimension value combinations and metric values in the report. + # Corresponds to the JSON property `rows` + # @return [Array] + attr_accessor :rows + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @aggregates = args[:aggregates] if args.key?(:aggregates) + @dimension_headers = args[:dimension_headers] if args.key?(:dimension_headers) + @metadata = args[:metadata] if args.key?(:metadata) + @metric_headers = args[:metric_headers] if args.key?(:metric_headers) + @pivot_headers = args[:pivot_headers] if args.key?(:pivot_headers) + @property_quota = args[:property_quota] if args.key?(:property_quota) + @rows = args[:rows] if args.key?(:rows) + end + end + + # The request to generate a report. + class RunReportRequest + include Google::Apis::Core::Hashable + + # Specification for a cohort report. + # Corresponds to the JSON property `cohortSpec` + # @return [Google::Apis::AnalyticsdataV1alpha::CohortSpec] + attr_accessor :cohort_spec + + # A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field + # is empty, the report uses the entity's default currency. + # Corresponds to the JSON property `currencyCode` + # @return [String] + attr_accessor :currency_code + + # Date ranges of data to read. If multiple date ranges are requested, each + # response row will contain a zero based date range index. If two date ranges + # overlap, the event data for the overlapping days is included in the response + # rows for both date ranges. In a cohort request, this `dateRanges` must be + # unspecified. + # Corresponds to the JSON property `dateRanges` + # @return [Array] + attr_accessor :date_ranges + + # To express dimension or metric filters. The fields in the same + # FilterExpression need to be either all dimensions or all metrics. + # Corresponds to the JSON property `dimensionFilter` + # @return [Google::Apis::AnalyticsdataV1alpha::FilterExpression] + attr_accessor :dimension_filter + + # The dimensions requested and displayed. + # Corresponds to the JSON property `dimensions` + # @return [Array] + attr_accessor :dimensions + + # The unique identifier of the property whose events are tracked. + # Corresponds to the JSON property `entity` + # @return [Google::Apis::AnalyticsdataV1alpha::Entity] + attr_accessor :entity + + # If false or unspecified, each row with all metrics equal to 0 will not be + # returned. If true, these rows will be returned if they are not separately + # removed by a filter. + # Corresponds to the JSON property `keepEmptyRows` + # @return [Boolean] + attr_accessor :keep_empty_rows + alias_method :keep_empty_rows?, :keep_empty_rows + + # The number of rows to return. If unspecified, 10 rows are returned. If -1, all + # rows are returned. + # Corresponds to the JSON property `limit` + # @return [Fixnum] + attr_accessor :limit + + # Aggregation of metrics. Aggregated metric values will be shown in rows where + # the dimension_values are set to "RESERVED_(MetricAggregation)". + # Corresponds to the JSON property `metricAggregations` + # @return [Array] + attr_accessor :metric_aggregations + + # To express dimension or metric filters. The fields in the same + # FilterExpression need to be either all dimensions or all metrics. + # Corresponds to the JSON property `metricFilter` + # @return [Google::Apis::AnalyticsdataV1alpha::FilterExpression] + attr_accessor :metric_filter + + # The metrics requested and displayed. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # The row count of the start row. The first row is counted as row 0. + # Corresponds to the JSON property `offset` + # @return [Fixnum] + attr_accessor :offset + + # Specifies how rows are ordered in the response. + # Corresponds to the JSON property `orderBys` + # @return [Array] + attr_accessor :order_bys + + # Toggles whether to return the current state of this Analytics Property's quota. + # Quota is returned in [PropertyQuota](#PropertyQuota). + # Corresponds to the JSON property `returnPropertyQuota` + # @return [Boolean] + attr_accessor :return_property_quota + alias_method :return_property_quota?, :return_property_quota + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cohort_spec = args[:cohort_spec] if args.key?(:cohort_spec) + @currency_code = args[:currency_code] if args.key?(:currency_code) + @date_ranges = args[:date_ranges] if args.key?(:date_ranges) + @dimension_filter = args[:dimension_filter] if args.key?(:dimension_filter) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @entity = args[:entity] if args.key?(:entity) + @keep_empty_rows = args[:keep_empty_rows] if args.key?(:keep_empty_rows) + @limit = args[:limit] if args.key?(:limit) + @metric_aggregations = args[:metric_aggregations] if args.key?(:metric_aggregations) + @metric_filter = args[:metric_filter] if args.key?(:metric_filter) + @metrics = args[:metrics] if args.key?(:metrics) + @offset = args[:offset] if args.key?(:offset) + @order_bys = args[:order_bys] if args.key?(:order_bys) + @return_property_quota = args[:return_property_quota] if args.key?(:return_property_quota) + end + end + + # The response report table corresponding to a request. + class RunReportResponse + include Google::Apis::Core::Hashable + + # Describes dimension columns. The number of DimensionHeaders and ordering of + # DimensionHeaders matches the dimensions present in rows. + # Corresponds to the JSON property `dimensionHeaders` + # @return [Array] + attr_accessor :dimension_headers + + # If requested, the maximum values of metrics. + # Corresponds to the JSON property `maximums` + # @return [Array] + attr_accessor :maximums + + # Response's metadata carrying additional information about the report content. + # Corresponds to the JSON property `metadata` + # @return [Google::Apis::AnalyticsdataV1alpha::ResponseMetaData] + attr_accessor :metadata + + # Describes metric columns. The number of MetricHeaders and ordering of + # MetricHeaders matches the metrics present in rows. + # Corresponds to the JSON property `metricHeaders` + # @return [Array] + attr_accessor :metric_headers + + # If requested, the minimum values of metrics. + # Corresponds to the JSON property `minimums` + # @return [Array] + attr_accessor :minimums + + # Current state of all quotas for this Analytics Property. If any quota for a + # property is exhausted, all requests to that property will return Resource + # Exhausted errors. + # Corresponds to the JSON property `propertyQuota` + # @return [Google::Apis::AnalyticsdataV1alpha::PropertyQuota] + attr_accessor :property_quota + + # The total number of rows in the query result, regardless of the number of rows + # returned in the response. For example if a query returns 175 rows and includes + # limit = 50 in the API request, the response will contain row_count = 175 but + # only 50 rows. + # Corresponds to the JSON property `rowCount` + # @return [Fixnum] + attr_accessor :row_count + + # Rows of dimension value combinations and metric values in the report. + # Corresponds to the JSON property `rows` + # @return [Array] + attr_accessor :rows + + # If requested, the totaled values of metrics. + # Corresponds to the JSON property `totals` + # @return [Array] + attr_accessor :totals + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension_headers = args[:dimension_headers] if args.key?(:dimension_headers) + @maximums = args[:maximums] if args.key?(:maximums) + @metadata = args[:metadata] if args.key?(:metadata) + @metric_headers = args[:metric_headers] if args.key?(:metric_headers) + @minimums = args[:minimums] if args.key?(:minimums) + @property_quota = args[:property_quota] if args.key?(:property_quota) + @row_count = args[:row_count] if args.key?(:row_count) + @rows = args[:rows] if args.key?(:rows) + @totals = args[:totals] if args.key?(:totals) + end + end + + # The filter for string + class StringFilter + include Google::Apis::Core::Hashable + + # If true, the string value is case sensitive. + # Corresponds to the JSON property `caseSensitive` + # @return [Boolean] + attr_accessor :case_sensitive + alias_method :case_sensitive?, :case_sensitive + + # The match type for this filter. + # Corresponds to the JSON property `matchType` + # @return [String] + attr_accessor :match_type + + # The string value used for the matching. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @case_sensitive = args[:case_sensitive] if args.key?(:case_sensitive) + @match_type = args[:match_type] if args.key?(:match_type) + @value = args[:value] if args.key?(:value) + end + end + + # The dimensions and metrics currently accepted in reporting methods. + class UniversalMetadata + include Google::Apis::Core::Hashable + + # The dimensions descriptions. + # Corresponds to the JSON property `dimensions` + # @return [Array] + attr_accessor :dimensions + + # The metric descriptions. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @metrics = args[:metrics] if args.key?(:metrics) + end + end + end + end +end diff --git a/generated/google/apis/analyticsdata_v1alpha/representations.rb b/generated/google/apis/analyticsdata_v1alpha/representations.rb new file mode 100644 index 000000000..74ca76afc --- /dev/null +++ b/generated/google/apis/analyticsdata_v1alpha/representations.rb @@ -0,0 +1,789 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module AnalyticsdataV1alpha + + class BatchRunPivotReportsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BatchRunPivotReportsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BatchRunReportsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BatchRunReportsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BetweenFilter + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CaseExpression + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Cohort + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CohortReportSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CohortSpec + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CohortsRange + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ConcatenateExpression + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DateRange + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Dimension + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DimensionExpression + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DimensionHeader + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DimensionMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DimensionOrderBy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DimensionValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Entity + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Filter + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FilterExpression + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FilterExpressionList + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InListFilter + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Metric + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MetricHeader + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MetricMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MetricOrderBy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MetricValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class NumericFilter + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class NumericValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OrderBy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Pivot + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PivotDimensionHeader + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PivotHeader + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PivotOrderBy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PivotSelection + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PropertyQuota + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class QuotaStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ResponseMetaData + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Row + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RunPivotReportRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RunPivotReportResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RunReportRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RunReportResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class StringFilter + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UniversalMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BatchRunPivotReportsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :entity, as: 'entity', class: Google::Apis::AnalyticsdataV1alpha::Entity, decorator: Google::Apis::AnalyticsdataV1alpha::Entity::Representation + + collection :requests, as: 'requests', class: Google::Apis::AnalyticsdataV1alpha::RunPivotReportRequest, decorator: Google::Apis::AnalyticsdataV1alpha::RunPivotReportRequest::Representation + + end + end + + class BatchRunPivotReportsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :pivot_reports, as: 'pivotReports', class: Google::Apis::AnalyticsdataV1alpha::RunPivotReportResponse, decorator: Google::Apis::AnalyticsdataV1alpha::RunPivotReportResponse::Representation + + end + end + + class BatchRunReportsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :entity, as: 'entity', class: Google::Apis::AnalyticsdataV1alpha::Entity, decorator: Google::Apis::AnalyticsdataV1alpha::Entity::Representation + + collection :requests, as: 'requests', class: Google::Apis::AnalyticsdataV1alpha::RunReportRequest, decorator: Google::Apis::AnalyticsdataV1alpha::RunReportRequest::Representation + + end + end + + class BatchRunReportsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :reports, as: 'reports', class: Google::Apis::AnalyticsdataV1alpha::RunReportResponse, decorator: Google::Apis::AnalyticsdataV1alpha::RunReportResponse::Representation + + end + end + + class BetweenFilter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :from_value, as: 'fromValue', class: Google::Apis::AnalyticsdataV1alpha::NumericValue, decorator: Google::Apis::AnalyticsdataV1alpha::NumericValue::Representation + + property :to_value, as: 'toValue', class: Google::Apis::AnalyticsdataV1alpha::NumericValue, decorator: Google::Apis::AnalyticsdataV1alpha::NumericValue::Representation + + end + end + + class CaseExpression + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dimension_name, as: 'dimensionName' + end + end + + class Cohort + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :date_range, as: 'dateRange', class: Google::Apis::AnalyticsdataV1alpha::DateRange, decorator: Google::Apis::AnalyticsdataV1alpha::DateRange::Representation + + property :dimension, as: 'dimension' + property :name, as: 'name' + end + end + + class CohortReportSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :accumulate, as: 'accumulate' + end + end + + class CohortSpec + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cohort_report_settings, as: 'cohortReportSettings', class: Google::Apis::AnalyticsdataV1alpha::CohortReportSettings, decorator: Google::Apis::AnalyticsdataV1alpha::CohortReportSettings::Representation + + collection :cohorts, as: 'cohorts', class: Google::Apis::AnalyticsdataV1alpha::Cohort, decorator: Google::Apis::AnalyticsdataV1alpha::Cohort::Representation + + property :cohorts_range, as: 'cohortsRange', class: Google::Apis::AnalyticsdataV1alpha::CohortsRange, decorator: Google::Apis::AnalyticsdataV1alpha::CohortsRange::Representation + + end + end + + class CohortsRange + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_offset, as: 'endOffset' + property :granularity, as: 'granularity' + property :start_offset, as: 'startOffset' + end + end + + class ConcatenateExpression + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :delimiter, as: 'delimiter' + collection :dimension_names, as: 'dimensionNames' + end + end + + class DateRange + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_date, as: 'endDate' + property :name, as: 'name' + property :start_date, as: 'startDate' + end + end + + class Dimension + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dimension_expression, as: 'dimensionExpression', class: Google::Apis::AnalyticsdataV1alpha::DimensionExpression, decorator: Google::Apis::AnalyticsdataV1alpha::DimensionExpression::Representation + + property :name, as: 'name' + end + end + + class DimensionExpression + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :concatenate, as: 'concatenate', class: Google::Apis::AnalyticsdataV1alpha::ConcatenateExpression, decorator: Google::Apis::AnalyticsdataV1alpha::ConcatenateExpression::Representation + + property :lower_case, as: 'lowerCase', class: Google::Apis::AnalyticsdataV1alpha::CaseExpression, decorator: Google::Apis::AnalyticsdataV1alpha::CaseExpression::Representation + + property :upper_case, as: 'upperCase', class: Google::Apis::AnalyticsdataV1alpha::CaseExpression, decorator: Google::Apis::AnalyticsdataV1alpha::CaseExpression::Representation + + end + end + + class DimensionHeader + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + end + end + + class DimensionMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :api_name, as: 'apiName' + collection :deprecated_api_names, as: 'deprecatedApiNames' + property :description, as: 'description' + property :ui_name, as: 'uiName' + end + end + + class DimensionOrderBy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dimension_name, as: 'dimensionName' + property :order_type, as: 'orderType' + end + end + + class DimensionValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :value, as: 'value' + end + end + + class Entity + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :property_id, as: 'propertyId' + end + end + + class Filter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :between_filter, as: 'betweenFilter', class: Google::Apis::AnalyticsdataV1alpha::BetweenFilter, decorator: Google::Apis::AnalyticsdataV1alpha::BetweenFilter::Representation + + property :field_name, as: 'fieldName' + property :in_list_filter, as: 'inListFilter', class: Google::Apis::AnalyticsdataV1alpha::InListFilter, decorator: Google::Apis::AnalyticsdataV1alpha::InListFilter::Representation + + property :null_filter, as: 'nullFilter' + property :numeric_filter, as: 'numericFilter', class: Google::Apis::AnalyticsdataV1alpha::NumericFilter, decorator: Google::Apis::AnalyticsdataV1alpha::NumericFilter::Representation + + property :string_filter, as: 'stringFilter', class: Google::Apis::AnalyticsdataV1alpha::StringFilter, decorator: Google::Apis::AnalyticsdataV1alpha::StringFilter::Representation + + end + end + + class FilterExpression + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :and_group, as: 'andGroup', class: Google::Apis::AnalyticsdataV1alpha::FilterExpressionList, decorator: Google::Apis::AnalyticsdataV1alpha::FilterExpressionList::Representation + + property :filter, as: 'filter', class: Google::Apis::AnalyticsdataV1alpha::Filter, decorator: Google::Apis::AnalyticsdataV1alpha::Filter::Representation + + property :not_expression, as: 'notExpression', class: Google::Apis::AnalyticsdataV1alpha::FilterExpression, decorator: Google::Apis::AnalyticsdataV1alpha::FilterExpression::Representation + + property :or_group, as: 'orGroup', class: Google::Apis::AnalyticsdataV1alpha::FilterExpressionList, decorator: Google::Apis::AnalyticsdataV1alpha::FilterExpressionList::Representation + + end + end + + class FilterExpressionList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :expressions, as: 'expressions', class: Google::Apis::AnalyticsdataV1alpha::FilterExpression, decorator: Google::Apis::AnalyticsdataV1alpha::FilterExpression::Representation + + end + end + + class InListFilter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :case_sensitive, as: 'caseSensitive' + collection :values, as: 'values' + end + end + + class Metric + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :expression, as: 'expression' + property :invisible, as: 'invisible' + property :name, as: 'name' + end + end + + class MetricHeader + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :type, as: 'type' + end + end + + class MetricMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :api_name, as: 'apiName' + collection :deprecated_api_names, as: 'deprecatedApiNames' + property :description, as: 'description' + property :expression, as: 'expression' + property :type, as: 'type' + property :ui_name, as: 'uiName' + end + end + + class MetricOrderBy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :metric_name, as: 'metricName' + end + end + + class MetricValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :value, as: 'value' + end + end + + class NumericFilter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :operation, as: 'operation' + property :value, as: 'value', class: Google::Apis::AnalyticsdataV1alpha::NumericValue, decorator: Google::Apis::AnalyticsdataV1alpha::NumericValue::Representation + + end + end + + class NumericValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :double_value, as: 'doubleValue' + property :int64_value, :numeric_string => true, as: 'int64Value' + end + end + + class OrderBy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :desc, as: 'desc' + property :dimension, as: 'dimension', class: Google::Apis::AnalyticsdataV1alpha::DimensionOrderBy, decorator: Google::Apis::AnalyticsdataV1alpha::DimensionOrderBy::Representation + + property :metric, as: 'metric', class: Google::Apis::AnalyticsdataV1alpha::MetricOrderBy, decorator: Google::Apis::AnalyticsdataV1alpha::MetricOrderBy::Representation + + property :pivot, as: 'pivot', class: Google::Apis::AnalyticsdataV1alpha::PivotOrderBy, decorator: Google::Apis::AnalyticsdataV1alpha::PivotOrderBy::Representation + + end + end + + class Pivot + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :field_names, as: 'fieldNames' + property :limit, :numeric_string => true, as: 'limit' + collection :metric_aggregations, as: 'metricAggregations' + property :offset, :numeric_string => true, as: 'offset' + collection :order_bys, as: 'orderBys', class: Google::Apis::AnalyticsdataV1alpha::OrderBy, decorator: Google::Apis::AnalyticsdataV1alpha::OrderBy::Representation + + end + end + + class PivotDimensionHeader + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :dimension_values, as: 'dimensionValues', class: Google::Apis::AnalyticsdataV1alpha::DimensionValue, decorator: Google::Apis::AnalyticsdataV1alpha::DimensionValue::Representation + + end + end + + class PivotHeader + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :pivot_dimension_headers, as: 'pivotDimensionHeaders', class: Google::Apis::AnalyticsdataV1alpha::PivotDimensionHeader, decorator: Google::Apis::AnalyticsdataV1alpha::PivotDimensionHeader::Representation + + property :row_count, as: 'rowCount' + end + end + + class PivotOrderBy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :metric_name, as: 'metricName' + collection :pivot_selections, as: 'pivotSelections', class: Google::Apis::AnalyticsdataV1alpha::PivotSelection, decorator: Google::Apis::AnalyticsdataV1alpha::PivotSelection::Representation + + end + end + + class PivotSelection + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dimension_name, as: 'dimensionName' + property :dimension_value, as: 'dimensionValue' + end + end + + class PropertyQuota + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :concurrent_requests, as: 'concurrentRequests', class: Google::Apis::AnalyticsdataV1alpha::QuotaStatus, decorator: Google::Apis::AnalyticsdataV1alpha::QuotaStatus::Representation + + property :server_errors_per_project_per_hour, as: 'serverErrorsPerProjectPerHour', class: Google::Apis::AnalyticsdataV1alpha::QuotaStatus, decorator: Google::Apis::AnalyticsdataV1alpha::QuotaStatus::Representation + + property :tokens_per_day, as: 'tokensPerDay', class: Google::Apis::AnalyticsdataV1alpha::QuotaStatus, decorator: Google::Apis::AnalyticsdataV1alpha::QuotaStatus::Representation + + property :tokens_per_hour, as: 'tokensPerHour', class: Google::Apis::AnalyticsdataV1alpha::QuotaStatus, decorator: Google::Apis::AnalyticsdataV1alpha::QuotaStatus::Representation + + end + end + + class QuotaStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :consumed, as: 'consumed' + property :remaining, as: 'remaining' + end + end + + class ResponseMetaData + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :data_loss_from_other_row, as: 'dataLossFromOtherRow' + end + end + + class Row + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :dimension_values, as: 'dimensionValues', class: Google::Apis::AnalyticsdataV1alpha::DimensionValue, decorator: Google::Apis::AnalyticsdataV1alpha::DimensionValue::Representation + + collection :metric_values, as: 'metricValues', class: Google::Apis::AnalyticsdataV1alpha::MetricValue, decorator: Google::Apis::AnalyticsdataV1alpha::MetricValue::Representation + + end + end + + class RunPivotReportRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cohort_spec, as: 'cohortSpec', class: Google::Apis::AnalyticsdataV1alpha::CohortSpec, decorator: Google::Apis::AnalyticsdataV1alpha::CohortSpec::Representation + + property :currency_code, as: 'currencyCode' + collection :date_ranges, as: 'dateRanges', class: Google::Apis::AnalyticsdataV1alpha::DateRange, decorator: Google::Apis::AnalyticsdataV1alpha::DateRange::Representation + + property :dimension_filter, as: 'dimensionFilter', class: Google::Apis::AnalyticsdataV1alpha::FilterExpression, decorator: Google::Apis::AnalyticsdataV1alpha::FilterExpression::Representation + + collection :dimensions, as: 'dimensions', class: Google::Apis::AnalyticsdataV1alpha::Dimension, decorator: Google::Apis::AnalyticsdataV1alpha::Dimension::Representation + + property :entity, as: 'entity', class: Google::Apis::AnalyticsdataV1alpha::Entity, decorator: Google::Apis::AnalyticsdataV1alpha::Entity::Representation + + property :keep_empty_rows, as: 'keepEmptyRows' + property :metric_filter, as: 'metricFilter', class: Google::Apis::AnalyticsdataV1alpha::FilterExpression, decorator: Google::Apis::AnalyticsdataV1alpha::FilterExpression::Representation + + collection :metrics, as: 'metrics', class: Google::Apis::AnalyticsdataV1alpha::Metric, decorator: Google::Apis::AnalyticsdataV1alpha::Metric::Representation + + collection :pivots, as: 'pivots', class: Google::Apis::AnalyticsdataV1alpha::Pivot, decorator: Google::Apis::AnalyticsdataV1alpha::Pivot::Representation + + property :return_property_quota, as: 'returnPropertyQuota' + end + end + + class RunPivotReportResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :aggregates, as: 'aggregates', class: Google::Apis::AnalyticsdataV1alpha::Row, decorator: Google::Apis::AnalyticsdataV1alpha::Row::Representation + + collection :dimension_headers, as: 'dimensionHeaders', class: Google::Apis::AnalyticsdataV1alpha::DimensionHeader, decorator: Google::Apis::AnalyticsdataV1alpha::DimensionHeader::Representation + + property :metadata, as: 'metadata', class: Google::Apis::AnalyticsdataV1alpha::ResponseMetaData, decorator: Google::Apis::AnalyticsdataV1alpha::ResponseMetaData::Representation + + collection :metric_headers, as: 'metricHeaders', class: Google::Apis::AnalyticsdataV1alpha::MetricHeader, decorator: Google::Apis::AnalyticsdataV1alpha::MetricHeader::Representation + + collection :pivot_headers, as: 'pivotHeaders', class: Google::Apis::AnalyticsdataV1alpha::PivotHeader, decorator: Google::Apis::AnalyticsdataV1alpha::PivotHeader::Representation + + property :property_quota, as: 'propertyQuota', class: Google::Apis::AnalyticsdataV1alpha::PropertyQuota, decorator: Google::Apis::AnalyticsdataV1alpha::PropertyQuota::Representation + + collection :rows, as: 'rows', class: Google::Apis::AnalyticsdataV1alpha::Row, decorator: Google::Apis::AnalyticsdataV1alpha::Row::Representation + + end + end + + class RunReportRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cohort_spec, as: 'cohortSpec', class: Google::Apis::AnalyticsdataV1alpha::CohortSpec, decorator: Google::Apis::AnalyticsdataV1alpha::CohortSpec::Representation + + property :currency_code, as: 'currencyCode' + collection :date_ranges, as: 'dateRanges', class: Google::Apis::AnalyticsdataV1alpha::DateRange, decorator: Google::Apis::AnalyticsdataV1alpha::DateRange::Representation + + property :dimension_filter, as: 'dimensionFilter', class: Google::Apis::AnalyticsdataV1alpha::FilterExpression, decorator: Google::Apis::AnalyticsdataV1alpha::FilterExpression::Representation + + collection :dimensions, as: 'dimensions', class: Google::Apis::AnalyticsdataV1alpha::Dimension, decorator: Google::Apis::AnalyticsdataV1alpha::Dimension::Representation + + property :entity, as: 'entity', class: Google::Apis::AnalyticsdataV1alpha::Entity, decorator: Google::Apis::AnalyticsdataV1alpha::Entity::Representation + + property :keep_empty_rows, as: 'keepEmptyRows' + property :limit, :numeric_string => true, as: 'limit' + collection :metric_aggregations, as: 'metricAggregations' + property :metric_filter, as: 'metricFilter', class: Google::Apis::AnalyticsdataV1alpha::FilterExpression, decorator: Google::Apis::AnalyticsdataV1alpha::FilterExpression::Representation + + collection :metrics, as: 'metrics', class: Google::Apis::AnalyticsdataV1alpha::Metric, decorator: Google::Apis::AnalyticsdataV1alpha::Metric::Representation + + property :offset, :numeric_string => true, as: 'offset' + collection :order_bys, as: 'orderBys', class: Google::Apis::AnalyticsdataV1alpha::OrderBy, decorator: Google::Apis::AnalyticsdataV1alpha::OrderBy::Representation + + property :return_property_quota, as: 'returnPropertyQuota' + end + end + + class RunReportResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :dimension_headers, as: 'dimensionHeaders', class: Google::Apis::AnalyticsdataV1alpha::DimensionHeader, decorator: Google::Apis::AnalyticsdataV1alpha::DimensionHeader::Representation + + collection :maximums, as: 'maximums', class: Google::Apis::AnalyticsdataV1alpha::Row, decorator: Google::Apis::AnalyticsdataV1alpha::Row::Representation + + property :metadata, as: 'metadata', class: Google::Apis::AnalyticsdataV1alpha::ResponseMetaData, decorator: Google::Apis::AnalyticsdataV1alpha::ResponseMetaData::Representation + + collection :metric_headers, as: 'metricHeaders', class: Google::Apis::AnalyticsdataV1alpha::MetricHeader, decorator: Google::Apis::AnalyticsdataV1alpha::MetricHeader::Representation + + collection :minimums, as: 'minimums', class: Google::Apis::AnalyticsdataV1alpha::Row, decorator: Google::Apis::AnalyticsdataV1alpha::Row::Representation + + property :property_quota, as: 'propertyQuota', class: Google::Apis::AnalyticsdataV1alpha::PropertyQuota, decorator: Google::Apis::AnalyticsdataV1alpha::PropertyQuota::Representation + + property :row_count, as: 'rowCount' + collection :rows, as: 'rows', class: Google::Apis::AnalyticsdataV1alpha::Row, decorator: Google::Apis::AnalyticsdataV1alpha::Row::Representation + + collection :totals, as: 'totals', class: Google::Apis::AnalyticsdataV1alpha::Row, decorator: Google::Apis::AnalyticsdataV1alpha::Row::Representation + + end + end + + class StringFilter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :case_sensitive, as: 'caseSensitive' + property :match_type, as: 'matchType' + property :value, as: 'value' + end + end + + class UniversalMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :dimensions, as: 'dimensions', class: Google::Apis::AnalyticsdataV1alpha::DimensionMetadata, decorator: Google::Apis::AnalyticsdataV1alpha::DimensionMetadata::Representation + + collection :metrics, as: 'metrics', class: Google::Apis::AnalyticsdataV1alpha::MetricMetadata, decorator: Google::Apis::AnalyticsdataV1alpha::MetricMetadata::Representation + + end + end + end + end +end diff --git a/generated/google/apis/analyticsdata_v1alpha/service.rb b/generated/google/apis/analyticsdata_v1alpha/service.rb new file mode 100644 index 000000000..c501cd720 --- /dev/null +++ b/generated/google/apis/analyticsdata_v1alpha/service.rb @@ -0,0 +1,220 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module AnalyticsdataV1alpha + # Google Analytics Data API + # + # Accesses report data in Google Analytics. + # + # @example + # require 'google/apis/analyticsdata_v1alpha' + # + # Analyticsdata = Google::Apis::AnalyticsdataV1alpha # Alias the module + # service = Analyticsdata::AnalyticsDataService.new + # + # @see https://developers.google.com/analytics/trusted-testing/analytics-data/ + class AnalyticsDataService < Google::Apis::Core::BaseService + # @return [String] + # 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. + attr_accessor :key + + # @return [String] + # 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. + attr_accessor :quota_user + + def initialize + super('https://analyticsdata.googleapis.com/', '') + @batch_path = 'batch' + end + + # Returns multiple pivot reports in a batch. All reports must be for the same + # Entity. + # @param [Google::Apis::AnalyticsdataV1alpha::BatchRunPivotReportsRequest] batch_run_pivot_reports_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AnalyticsdataV1alpha::BatchRunPivotReportsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AnalyticsdataV1alpha::BatchRunPivotReportsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def batch_run_pivot_reports(batch_run_pivot_reports_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha:batchRunPivotReports', options) + command.request_representation = Google::Apis::AnalyticsdataV1alpha::BatchRunPivotReportsRequest::Representation + command.request_object = batch_run_pivot_reports_request_object + command.response_representation = Google::Apis::AnalyticsdataV1alpha::BatchRunPivotReportsResponse::Representation + command.response_class = Google::Apis::AnalyticsdataV1alpha::BatchRunPivotReportsResponse + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns multiple reports in a batch. All reports must be for the same Entity. + # @param [Google::Apis::AnalyticsdataV1alpha::BatchRunReportsRequest] batch_run_reports_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AnalyticsdataV1alpha::BatchRunReportsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AnalyticsdataV1alpha::BatchRunReportsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def batch_run_reports(batch_run_reports_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha:batchRunReports', options) + command.request_representation = Google::Apis::AnalyticsdataV1alpha::BatchRunReportsRequest::Representation + command.request_object = batch_run_reports_request_object + command.response_representation = Google::Apis::AnalyticsdataV1alpha::BatchRunReportsResponse::Representation + command.response_class = Google::Apis::AnalyticsdataV1alpha::BatchRunReportsResponse + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns metadata for dimensions and metrics available in reporting methods. + # Used to explore the dimensions and metrics. Dimensions and metrics will be + # mostly added over time, but renames and deletions may occur. This method + # returns Universal Metadata. Universal Metadata are dimensions and metrics + # applicable to any property such as `country` and `totalUsers`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AnalyticsdataV1alpha::UniversalMetadata] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AnalyticsdataV1alpha::UniversalMetadata] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_universal_metadata(fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha/universalMetadata', options) + command.response_representation = Google::Apis::AnalyticsdataV1alpha::UniversalMetadata::Representation + command.response_class = Google::Apis::AnalyticsdataV1alpha::UniversalMetadata + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns a customized pivot report of your Google Analytics event data. Pivot + # reports are more advanced and expressive formats than regular reports. In a + # pivot report, dimensions are only visible if they are included in a pivot. + # Multiple pivots can be specified to further dissect your data. + # @param [Google::Apis::AnalyticsdataV1alpha::RunPivotReportRequest] run_pivot_report_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AnalyticsdataV1alpha::RunPivotReportResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AnalyticsdataV1alpha::RunPivotReportResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def run_pivot_report(run_pivot_report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha:runPivotReport', options) + command.request_representation = Google::Apis::AnalyticsdataV1alpha::RunPivotReportRequest::Representation + command.request_object = run_pivot_report_request_object + command.response_representation = Google::Apis::AnalyticsdataV1alpha::RunPivotReportResponse::Representation + command.response_class = Google::Apis::AnalyticsdataV1alpha::RunPivotReportResponse + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns a customized report of your Google Analytics event data. Reports + # contain statistics derived from data collected by the Google Analytics + # tracking code. The data returned from the API is as a table with columns for + # the requested dimensions and metrics. Metrics are individual 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. + # @param [Google::Apis::AnalyticsdataV1alpha::RunReportRequest] run_report_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AnalyticsdataV1alpha::RunReportResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AnalyticsdataV1alpha::RunReportResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def run_report(run_report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha:runReport', options) + command.request_representation = Google::Apis::AnalyticsdataV1alpha::RunReportRequest::Representation + command.request_object = run_report_request_object + command.response_representation = Google::Apis::AnalyticsdataV1alpha::RunReportResponse::Representation + command.response_class = Google::Apis::AnalyticsdataV1alpha::RunReportResponse + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/analyticsreporting_v4.rb b/generated/google/apis/analyticsreporting_v4.rb index 676f0b019..81234c4c0 100644 --- a/generated/google/apis/analyticsreporting_v4.rb +++ b/generated/google/apis/analyticsreporting_v4.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/analytics/devguides/reporting/core/v4/ module AnalyticsreportingV4 VERSION = 'V4' - REVISION = '20200803' + REVISION = '20200902' # View and manage your Google Analytics data AUTH_ANALYTICS = 'https://www.googleapis.com/auth/analytics' diff --git a/generated/google/apis/androidpublisher_v3.rb b/generated/google/apis/androidpublisher_v3.rb index c8daecd54..88e699e1f 100644 --- a/generated/google/apis/androidpublisher_v3.rb +++ b/generated/google/apis/androidpublisher_v3.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/android-publisher module AndroidpublisherV3 VERSION = 'V3' - REVISION = '20200817' + REVISION = '20200909' # View and manage your Google Play Developer account AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher' diff --git a/generated/google/apis/apigateway_v1alpha1.rb b/generated/google/apis/apigateway_v1alpha1.rb new file mode 100644 index 000000000..4fe41902b --- /dev/null +++ b/generated/google/apis/apigateway_v1alpha1.rb @@ -0,0 +1,34 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/apigateway_v1alpha1/service.rb' +require 'google/apis/apigateway_v1alpha1/classes.rb' +require 'google/apis/apigateway_v1alpha1/representations.rb' + +module Google + module Apis + # API Gateway API + # + # + # + # @see https://cloud.google.com/api-gateway/docs + module ApigatewayV1alpha1 + VERSION = 'V1alpha1' + REVISION = '20200901' + + # View and manage your data across Google Cloud Platform services + AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' + end + end +end diff --git a/generated/google/apis/apigateway_v1alpha1/classes.rb b/generated/google/apis/apigateway_v1alpha1/classes.rb new file mode 100644 index 000000000..cef673cef --- /dev/null +++ b/generated/google/apis/apigateway_v1alpha1/classes.rb @@ -0,0 +1,633 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module ApigatewayV1alpha1 + + # 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. + class ApigatewayAuditConfig + include Google::Apis::Core::Hashable + + # The configuration for logging of each type of permission. + # Corresponds to the JSON property `auditLogConfigs` + # @return [Array] + attr_accessor :audit_log_configs + + # 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. + # Corresponds to the JSON property `service` + # @return [String] + attr_accessor :service + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audit_log_configs = args[:audit_log_configs] if args.key?(:audit_log_configs) + @service = args[:service] if args.key?(:service) + end + end + + # 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. + class ApigatewayAuditLogConfig + include Google::Apis::Core::Hashable + + # Specifies the identities that do not cause logging for this type of permission. + # Follows the same format of Binding.members. + # Corresponds to the JSON property `exemptedMembers` + # @return [Array] + attr_accessor :exempted_members + + # The log type that this config enables. + # Corresponds to the JSON property `logType` + # @return [String] + attr_accessor :log_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @exempted_members = args[:exempted_members] if args.key?(:exempted_members) + @log_type = args[:log_type] if args.key?(:log_type) + end + end + + # Associates `members` with a `role`. + class ApigatewayBinding + include Google::Apis::Core::Hashable + + # Represents a textual expression in the Common Expression Language (CEL) syntax. + # CEL is a C-like expression language. The syntax and semantics of CEL are + # documented at https://github.com/google/cel-spec. Example (Comparison): title: + # "Summary size limit" description: "Determines if a summary is less than 100 + # chars" expression: "document.summary.size() < 100" Example (Equality): title: " + # Requestor is owner" description: "Determines if requestor is the document + # owner" expression: "document.owner == request.auth.claims.email" Example ( + # Logic): title: "Public documents" description: "Determine whether the document + # should be publicly visible" expression: "document.type != 'private' && + # document.type != 'internal'" Example (Data Manipulation): title: "Notification + # string" description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" The + # exact variables and functions that may be referenced within an expression are + # determined by the service that evaluates it. See the service documentation for + # additional information. + # Corresponds to the JSON property `condition` + # @return [Google::Apis::ApigatewayV1alpha1::ApigatewayExpr] + attr_accessor :condition + + # Specifies the identities requesting access for a Cloud Platform resource. ` + # members` can have the following values: * `allUsers`: A special identifier + # that represents anyone who is on the internet; with or without a Google + # account. * `allAuthenticatedUsers`: A special identifier that represents + # anyone who is authenticated with a Google account or a service account. * ` + # user:`emailid``: An email address that represents a specific Google account. + # For example, `alice@example.com` . * `serviceAccount:`emailid``: An email + # address that represents a service account. For example, `my-other-app@appspot. + # gserviceaccount.com`. * `group:`emailid``: An email address that represents a + # Google group. For example, `admins@example.com`. * `deleted:user:`emailid`?uid= + # `uniqueid``: An email address (plus unique identifier) representing a user + # that has been recently deleted. For example, `alice@example.com?uid= + # 123456789012345678901`. If the user is recovered, this value reverts to `user:` + # emailid`` and the recovered user retains the role in the binding. * `deleted: + # serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus unique + # identifier) representing a service account that has been recently deleted. For + # example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + # If the service account is undeleted, this value reverts to `serviceAccount:` + # emailid`` and the undeleted service account retains the role in the binding. * + # `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique + # identifier) representing a Google group that has been recently deleted. For + # example, `admins@example.com?uid=123456789012345678901`. If the group is + # recovered, this value reverts to `group:`emailid`` and the recovered group + # retains the role in the binding. * `domain:`domain``: The G Suite domain ( + # primary) that represents all the users of that domain. For example, `google. + # com` or `example.com`. + # Corresponds to the JSON property `members` + # @return [Array] + attr_accessor :members + + # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor` + # , or `roles/owner`. + # Corresponds to the JSON property `role` + # @return [String] + attr_accessor :role + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @condition = args[:condition] if args.key?(:condition) + @members = args[:members] if args.key?(:members) + @role = args[:role] if args.key?(:role) + end + end + + # The request message for Operations.CancelOperation. + class ApigatewayCancelOperationRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Represents a textual expression in the Common Expression Language (CEL) syntax. + # CEL is a C-like expression language. The syntax and semantics of CEL are + # documented at https://github.com/google/cel-spec. Example (Comparison): title: + # "Summary size limit" description: "Determines if a summary is less than 100 + # chars" expression: "document.summary.size() < 100" Example (Equality): title: " + # Requestor is owner" description: "Determines if requestor is the document + # owner" expression: "document.owner == request.auth.claims.email" Example ( + # Logic): title: "Public documents" description: "Determine whether the document + # should be publicly visible" expression: "document.type != 'private' && + # document.type != 'internal'" Example (Data Manipulation): title: "Notification + # string" description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" The + # exact variables and functions that may be referenced within an expression are + # determined by the service that evaluates it. See the service documentation for + # additional information. + class ApigatewayExpr + include Google::Apis::Core::Hashable + + # Optional. Description of the expression. This is a longer text which describes + # the expression, e.g. when hovered over it in a UI. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Textual representation of an expression in Common Expression Language syntax. + # Corresponds to the JSON property `expression` + # @return [String] + attr_accessor :expression + + # Optional. String indicating the location of the expression for error reporting, + # e.g. a file name and a position in the file. + # Corresponds to the JSON property `location` + # @return [String] + attr_accessor :location + + # 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. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @expression = args[:expression] if args.key?(:expression) + @location = args[:location] if args.key?(:location) + @title = args[:title] if args.key?(:title) + end + end + + # The response message for Locations.ListLocations. + class ApigatewayListLocationsResponse + include Google::Apis::Core::Hashable + + # A list of locations that matches the specified filter in the request. + # Corresponds to the JSON property `locations` + # @return [Array] + attr_accessor :locations + + # The standard List next-page token. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @locations = args[:locations] if args.key?(:locations) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # The response message for Operations.ListOperations. + class ApigatewayListOperationsResponse + include Google::Apis::Core::Hashable + + # The standard List next-page token. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # A list of operations that matches the specified filter in the request. + # Corresponds to the JSON property `operations` + # @return [Array] + attr_accessor :operations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @operations = args[:operations] if args.key?(:operations) + end + end + + # A resource that represents Google Cloud Platform location. + class ApigatewayLocation + include Google::Apis::Core::Hashable + + # The friendly name for this location, typically a nearby city name. For example, + # "Tokyo". + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Cross-service attributes for the location. For example `"cloud.googleapis.com/ + # region": "us-east1"` + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # The canonical id for this location. For example: `"us-east1"`. + # Corresponds to the JSON property `locationId` + # @return [String] + attr_accessor :location_id + + # Service-specific metadata. For example the available capacity at the given + # location. + # Corresponds to the JSON property `metadata` + # @return [Hash] + attr_accessor :metadata + + # Resource name for the location, which may vary between implementations. For + # example: `"projects/example-project/locations/us-east1"` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + @labels = args[:labels] if args.key?(:labels) + @location_id = args[:location_id] if args.key?(:location_id) + @metadata = args[:metadata] if args.key?(:metadata) + @name = args[:name] if args.key?(:name) + end + end + + # This resource represents a long-running operation that is the result of a + # network API call. + class ApigatewayOperation + include Google::Apis::Core::Hashable + + # If the value is `false`, it means the operation is still in progress. If `true` + # , the operation is completed, and either `error` or `response` is available. + # Corresponds to the JSON property `done` + # @return [Boolean] + attr_accessor :done + alias_method :done?, :done + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). + # Corresponds to the JSON property `error` + # @return [Google::Apis::ApigatewayV1alpha1::ApigatewayStatus] + attr_accessor :error + + # Service-specific metadata associated with the operation. It typically contains + # progress information and common metadata such as create time. Some services + # might not provide such metadata. Any method that returns a long-running + # operation should document the metadata type, if any. + # Corresponds to the JSON property `metadata` + # @return [Hash] + attr_accessor :metadata + + # The server-assigned name, which is only unique within the same service that + # originally returns it. If you use the default HTTP mapping, the `name` should + # be a resource name ending with `operations/`unique_id``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The normal response of the operation in case of success. If the original + # method returns no data on success, such as `Delete`, the response is `google. + # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, + # the response should be the resource. For other methods, the response should + # have the type `XxxResponse`, where `Xxx` is the original method name. For + # example, if the original method name is `TakeSnapshot()`, the inferred + # response type is `TakeSnapshotResponse`. + # Corresponds to the JSON property `response` + # @return [Hash] + attr_accessor :response + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @done = args[:done] if args.key?(:done) + @error = args[:error] if args.key?(:error) + @metadata = args[:metadata] if args.key?(:metadata) + @name = args[:name] if args.key?(:name) + @response = args[:response] if args.key?(:response) + end + end + + # An Identity and Access Management (IAM) policy, which specifies access + # controls for Google Cloud resources. A `Policy` is a collection of `bindings`. + # A `binding` binds one or more `members` to a single `role`. Members can be + # user accounts, service accounts, Google groups, and domains (such as G Suite). + # A `role` is a named list of permissions; each `role` can be an IAM predefined + # role or a user-created custom role. For some types of Google Cloud resources, + # a `binding` can also specify a `condition`, which is a logical expression that + # allows access to a resource only if the expression evaluates to `true`. A + # condition can add constraints based on attributes of the request, the resource, + # or both. To learn which resources support conditions in their IAM policies, + # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/ + # resource-policies). **JSON example:** ` "bindings": [ ` "role": "roles/ + # resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", " + # group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@ + # appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager. + # organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` " + # title": "expirable access", "description": "Does not grant access after Sep + # 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", ` + # ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: - + # members: - user:mike@example.com - group:admins@example.com - domain:google. + # com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/ + # resourcemanager.organizationAdmin - members: - user:eve@example.com role: + # roles/resourcemanager.organizationViewer condition: title: expirable access + # description: Does not grant access after Sep 2020 expression: request.time < + # timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a + # description of IAM and its features, see the [IAM documentation](https://cloud. + # google.com/iam/docs/). + class ApigatewayPolicy + include Google::Apis::Core::Hashable + + # Specifies cloud audit logging configuration for this policy. + # Corresponds to the JSON property `auditConfigs` + # @return [Array] + attr_accessor :audit_configs + + # Associates a list of `members` to a `role`. Optionally, may specify a ` + # condition` that determines how and when the `bindings` are applied. Each of + # the `bindings` must contain at least one member. + # Corresponds to the JSON property `bindings` + # @return [Array] + attr_accessor :bindings + + # `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. + # Corresponds to the JSON property `etag` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :etag + + # 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). + # Corresponds to the JSON property `version` + # @return [Fixnum] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audit_configs = args[:audit_configs] if args.key?(:audit_configs) + @bindings = args[:bindings] if args.key?(:bindings) + @etag = args[:etag] if args.key?(:etag) + @version = args[:version] if args.key?(:version) + end + end + + # Request message for `SetIamPolicy` method. + class ApigatewaySetIamPolicyRequest + include Google::Apis::Core::Hashable + + # An Identity and Access Management (IAM) policy, which specifies access + # controls for Google Cloud resources. A `Policy` is a collection of `bindings`. + # A `binding` binds one or more `members` to a single `role`. Members can be + # user accounts, service accounts, Google groups, and domains (such as G Suite). + # A `role` is a named list of permissions; each `role` can be an IAM predefined + # role or a user-created custom role. For some types of Google Cloud resources, + # a `binding` can also specify a `condition`, which is a logical expression that + # allows access to a resource only if the expression evaluates to `true`. A + # condition can add constraints based on attributes of the request, the resource, + # or both. To learn which resources support conditions in their IAM policies, + # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/ + # resource-policies). **JSON example:** ` "bindings": [ ` "role": "roles/ + # resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", " + # group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@ + # appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager. + # organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` " + # title": "expirable access", "description": "Does not grant access after Sep + # 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", ` + # ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: - + # members: - user:mike@example.com - group:admins@example.com - domain:google. + # com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/ + # resourcemanager.organizationAdmin - members: - user:eve@example.com role: + # roles/resourcemanager.organizationViewer condition: title: expirable access + # description: Does not grant access after Sep 2020 expression: request.time < + # timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a + # description of IAM and its features, see the [IAM documentation](https://cloud. + # google.com/iam/docs/). + # Corresponds to the JSON property `policy` + # @return [Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy] + attr_accessor :policy + + # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only + # the fields in the mask will be modified. If no mask is provided, the following + # default mask is used: `paths: "bindings, etag"` + # Corresponds to the JSON property `updateMask` + # @return [String] + attr_accessor :update_mask + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @policy = args[:policy] if args.key?(:policy) + @update_mask = args[:update_mask] if args.key?(:update_mask) + end + end + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). + class ApigatewayStatus + include Google::Apis::Core::Hashable + + # The status code, which should be an enum value of google.rpc.Code. + # Corresponds to the JSON property `code` + # @return [Fixnum] + attr_accessor :code + + # A list of messages that carry the error details. There is a common set of + # message types for APIs to use. + # Corresponds to the JSON property `details` + # @return [Array>] + attr_accessor :details + + # A developer-facing error message, which should be in English. Any user-facing + # error message should be localized and sent in the google.rpc.Status.details + # field, or localized by the client. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @details = args[:details] if args.key?(:details) + @message = args[:message] if args.key?(:message) + end + end + + # Request message for `TestIamPermissions` method. + class ApigatewayTestIamPermissionsRequest + include Google::Apis::Core::Hashable + + # The set of permissions to check for the `resource`. Permissions with wildcards + # (such as '*' or 'storage.*') are not allowed. For more information see [IAM + # Overview](https://cloud.google.com/iam/docs/overview#permissions). + # Corresponds to the JSON property `permissions` + # @return [Array] + attr_accessor :permissions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @permissions = args[:permissions] if args.key?(:permissions) + end + end + + # Response message for `TestIamPermissions` method. + class ApigatewayTestIamPermissionsResponse + include Google::Apis::Core::Hashable + + # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. + # Corresponds to the JSON property `permissions` + # @return [Array] + attr_accessor :permissions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @permissions = args[:permissions] if args.key?(:permissions) + end + end + + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. + class Empty + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + end + end +end diff --git a/generated/google/apis/apigateway_v1alpha1/representations.rb b/generated/google/apis/apigateway_v1alpha1/representations.rb new file mode 100644 index 000000000..5b03c1491 --- /dev/null +++ b/generated/google/apis/apigateway_v1alpha1/representations.rb @@ -0,0 +1,250 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module ApigatewayV1alpha1 + + class ApigatewayAuditConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayAuditLogConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayBinding + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayCancelOperationRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayExpr + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayListLocationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayListOperationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayLocation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayOperation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayPolicy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewaySetIamPolicyRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayTestIamPermissionsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayTestIamPermissionsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Empty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayAuditConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::ApigatewayV1alpha1::ApigatewayAuditLogConfig, decorator: Google::Apis::ApigatewayV1alpha1::ApigatewayAuditLogConfig::Representation + + property :service, as: 'service' + end + end + + class ApigatewayAuditLogConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :exempted_members, as: 'exemptedMembers' + property :log_type, as: 'logType' + end + end + + class ApigatewayBinding + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :condition, as: 'condition', class: Google::Apis::ApigatewayV1alpha1::ApigatewayExpr, decorator: Google::Apis::ApigatewayV1alpha1::ApigatewayExpr::Representation + + collection :members, as: 'members' + property :role, as: 'role' + end + end + + class ApigatewayCancelOperationRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class ApigatewayExpr + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :expression, as: 'expression' + property :location, as: 'location' + property :title, as: 'title' + end + end + + class ApigatewayListLocationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :locations, as: 'locations', class: Google::Apis::ApigatewayV1alpha1::ApigatewayLocation, decorator: Google::Apis::ApigatewayV1alpha1::ApigatewayLocation::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ApigatewayListOperationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :operations, as: 'operations', class: Google::Apis::ApigatewayV1alpha1::ApigatewayOperation, decorator: Google::Apis::ApigatewayV1alpha1::ApigatewayOperation::Representation + + end + end + + class ApigatewayLocation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + hash :labels, as: 'labels' + property :location_id, as: 'locationId' + hash :metadata, as: 'metadata' + property :name, as: 'name' + end + end + + class ApigatewayOperation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :done, as: 'done' + property :error, as: 'error', class: Google::Apis::ApigatewayV1alpha1::ApigatewayStatus, decorator: Google::Apis::ApigatewayV1alpha1::ApigatewayStatus::Representation + + hash :metadata, as: 'metadata' + property :name, as: 'name' + hash :response, as: 'response' + end + end + + class ApigatewayPolicy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audit_configs, as: 'auditConfigs', class: Google::Apis::ApigatewayV1alpha1::ApigatewayAuditConfig, decorator: Google::Apis::ApigatewayV1alpha1::ApigatewayAuditConfig::Representation + + collection :bindings, as: 'bindings', class: Google::Apis::ApigatewayV1alpha1::ApigatewayBinding, decorator: Google::Apis::ApigatewayV1alpha1::ApigatewayBinding::Representation + + property :etag, :base64 => true, as: 'etag' + property :version, as: 'version' + end + end + + class ApigatewaySetIamPolicyRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :policy, as: 'policy', class: Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy, decorator: Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy::Representation + + property :update_mask, as: 'updateMask' + end + end + + class ApigatewayStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :details, as: 'details' + property :message, as: 'message' + end + end + + class ApigatewayTestIamPermissionsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end + + class ApigatewayTestIamPermissionsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end + + class Empty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + end + end +end diff --git a/generated/google/apis/apigateway_v1alpha1/service.rb b/generated/google/apis/apigateway_v1alpha1/service.rb new file mode 100644 index 000000000..b557a855a --- /dev/null +++ b/generated/google/apis/apigateway_v1alpha1/service.rb @@ -0,0 +1,623 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module ApigatewayV1alpha1 + # API Gateway API + # + # + # + # @example + # require 'google/apis/apigateway_v1alpha1' + # + # Apigateway = Google::Apis::ApigatewayV1alpha1 # Alias the module + # service = Apigateway::ApigatewayService.new + # + # @see https://cloud.google.com/api-gateway/docs + class ApigatewayService < Google::Apis::Core::BaseService + # @return [String] + # 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. + attr_accessor :key + + # @return [String] + # 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. + attr_accessor :quota_user + + def initialize + super('https://apigateway.googleapis.com/', '') + @batch_path = 'batch' + end + + # Gets information about a location. + # @param [String] name + # Resource name for the location. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1alpha1::ApigatewayLocation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1alpha1::ApigatewayLocation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha1/{+name}', options) + command.response_representation = Google::Apis::ApigatewayV1alpha1::ApigatewayLocation::Representation + command.response_class = Google::Apis::ApigatewayV1alpha1::ApigatewayLocation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists information about the supported locations for this service. + # @param [String] name + # The resource that owns the locations collection, if applicable. + # @param [String] filter + # The standard list filter. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] page_token + # The standard list page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1alpha1::ApigatewayListLocationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1alpha1::ApigatewayListLocationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha1/{+name}/locations', options) + command.response_representation = Google::Apis::ApigatewayV1alpha1::ApigatewayListLocationsResponse::Representation + command.response_class = Google::Apis::ApigatewayV1alpha1::ApigatewayListLocationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. + # @param [Fixnum] options_requested_policy_version + # Optional. The policy format version to be returned. Valid values are 0, 1, and + # 3. Requests specifying an invalid value will be rejected. Requests for + # policies with any conditional bindings must specify version 3. Policies + # without any conditional bindings may specify any valid value or leave the + # field unset. To learn which resources support conditions in their IAM policies, + # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/ + # resource-policies). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_api_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha1/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy::Representation + command.response_class = Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy + command.params['resource'] = resource unless resource.nil? + command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy on the specified resource. Replaces any + # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` + # PERMISSION_DENIED` errors. + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. + # @param [Google::Apis::ApigatewayV1alpha1::ApigatewaySetIamPolicyRequest] apigateway_set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_project_location_api_iam_policy(resource, apigateway_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::ApigatewayV1alpha1::ApigatewaySetIamPolicyRequest::Representation + command.request_object = apigateway_set_iam_policy_request_object + command.response_representation = Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy::Representation + command.response_class = Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # 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. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. + # @param [Google::Apis::ApigatewayV1alpha1::ApigatewayTestIamPermissionsRequest] apigateway_test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1alpha1::ApigatewayTestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1alpha1::ApigatewayTestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_project_location_api_iam_permissions(resource, apigateway_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::ApigatewayV1alpha1::ApigatewayTestIamPermissionsRequest::Representation + command.request_object = apigateway_test_iam_permissions_request_object + command.response_representation = Google::Apis::ApigatewayV1alpha1::ApigatewayTestIamPermissionsResponse::Representation + command.response_class = Google::Apis::ApigatewayV1alpha1::ApigatewayTestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. + # @param [Fixnum] options_requested_policy_version + # Optional. The policy format version to be returned. Valid values are 0, 1, and + # 3. Requests specifying an invalid value will be rejected. Requests for + # policies with any conditional bindings must specify version 3. Policies + # without any conditional bindings may specify any valid value or leave the + # field unset. To learn which resources support conditions in their IAM policies, + # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/ + # resource-policies). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_api_config_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha1/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy::Representation + command.response_class = Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy + command.params['resource'] = resource unless resource.nil? + command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy on the specified resource. Replaces any + # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` + # PERMISSION_DENIED` errors. + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. + # @param [Google::Apis::ApigatewayV1alpha1::ApigatewaySetIamPolicyRequest] apigateway_set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_project_location_api_config_iam_policy(resource, apigateway_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::ApigatewayV1alpha1::ApigatewaySetIamPolicyRequest::Representation + command.request_object = apigateway_set_iam_policy_request_object + command.response_representation = Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy::Representation + command.response_class = Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # 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. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. + # @param [Google::Apis::ApigatewayV1alpha1::ApigatewayTestIamPermissionsRequest] apigateway_test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1alpha1::ApigatewayTestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1alpha1::ApigatewayTestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_project_location_api_config_iam_permissions(resource, apigateway_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::ApigatewayV1alpha1::ApigatewayTestIamPermissionsRequest::Representation + command.request_object = apigateway_test_iam_permissions_request_object + command.response_representation = Google::Apis::ApigatewayV1alpha1::ApigatewayTestIamPermissionsResponse::Representation + command.response_class = Google::Apis::ApigatewayV1alpha1::ApigatewayTestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. + # @param [Fixnum] options_requested_policy_version + # Optional. The policy format version to be returned. Valid values are 0, 1, and + # 3. Requests specifying an invalid value will be rejected. Requests for + # policies with any conditional bindings must specify version 3. Policies + # without any conditional bindings may specify any valid value or leave the + # field unset. To learn which resources support conditions in their IAM policies, + # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/ + # resource-policies). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_gateway_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha1/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy::Representation + command.response_class = Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy + command.params['resource'] = resource unless resource.nil? + command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy on the specified resource. Replaces any + # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` + # PERMISSION_DENIED` errors. + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. + # @param [Google::Apis::ApigatewayV1alpha1::ApigatewaySetIamPolicyRequest] apigateway_set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_project_location_gateway_iam_policy(resource, apigateway_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::ApigatewayV1alpha1::ApigatewaySetIamPolicyRequest::Representation + command.request_object = apigateway_set_iam_policy_request_object + command.response_representation = Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy::Representation + command.response_class = Google::Apis::ApigatewayV1alpha1::ApigatewayPolicy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # 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. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. + # @param [Google::Apis::ApigatewayV1alpha1::ApigatewayTestIamPermissionsRequest] apigateway_test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1alpha1::ApigatewayTestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1alpha1::ApigatewayTestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_project_location_gateway_iam_permissions(resource, apigateway_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::ApigatewayV1alpha1::ApigatewayTestIamPermissionsRequest::Representation + command.request_object = apigateway_test_iam_permissions_request_object + command.response_representation = Google::Apis::ApigatewayV1alpha1::ApigatewayTestIamPermissionsResponse::Representation + command.response_class = Google::Apis::ApigatewayV1alpha1::ApigatewayTestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Starts asynchronous cancellation on a long-running operation. The server makes + # a best effort to cancel the operation, but success is not guaranteed. If the + # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + # Clients can use Operations.GetOperation or other methods to check whether the + # cancellation succeeded or whether the operation completed despite cancellation. + # On successful cancellation, the operation is not deleted; instead, it becomes + # an operation with an Operation.error value with a google.rpc.Status.code of 1, + # corresponding to `Code.CANCELLED`. + # @param [String] name + # The name of the operation resource to be cancelled. + # @param [Google::Apis::ApigatewayV1alpha1::ApigatewayCancelOperationRequest] apigateway_cancel_operation_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1alpha1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1alpha1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def cancel_project_location_operation(name, apigateway_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+name}:cancel', options) + command.request_representation = Google::Apis::ApigatewayV1alpha1::ApigatewayCancelOperationRequest::Representation + command.request_object = apigateway_cancel_operation_request_object + command.response_representation = Google::Apis::ApigatewayV1alpha1::Empty::Representation + command.response_class = Google::Apis::ApigatewayV1alpha1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a long-running operation. This method indicates that the client is no + # longer interested in the operation result. It does not cancel the operation. + # If the server doesn't support this method, it returns `google.rpc.Code. + # UNIMPLEMENTED`. + # @param [String] name + # The name of the operation resource to be deleted. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1alpha1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1alpha1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1alpha1/{+name}', options) + command.response_representation = Google::Apis::ApigatewayV1alpha1::Empty::Representation + command.response_class = Google::Apis::ApigatewayV1alpha1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the latest state of a long-running operation. Clients can use this method + # to poll the operation result at intervals as recommended by the API service. + # @param [String] name + # The name of the operation resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1alpha1::ApigatewayOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1alpha1::ApigatewayOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha1/{+name}', options) + command.response_representation = Google::Apis::ApigatewayV1alpha1::ApigatewayOperation::Representation + command.response_class = Google::Apis::ApigatewayV1alpha1::ApigatewayOperation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists operations that match the specified filter in the request. If the server + # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` + # binding allows API services to override the binding to use different resource + # name schemes, such as `users/*/operations`. To override the binding, API + # services can add a binding such as `"/v1/`name=users/*`/operations"` to their + # service configuration. For backwards compatibility, the default name includes + # the operations collection id, however overriding users must ensure the name + # binding is the parent resource, without the operations collection id. + # @param [String] name + # The name of the operation's parent resource. + # @param [String] filter + # The standard list filter. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] page_token + # The standard list page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1alpha1::ApigatewayListOperationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1alpha1::ApigatewayListOperationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha1/{+name}/operations', options) + command.response_representation = Google::Apis::ApigatewayV1alpha1::ApigatewayListOperationsResponse::Representation + command.response_class = Google::Apis::ApigatewayV1alpha1::ApigatewayListOperationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/apigateway_v1beta.rb b/generated/google/apis/apigateway_v1beta.rb new file mode 100644 index 000000000..e97d855f0 --- /dev/null +++ b/generated/google/apis/apigateway_v1beta.rb @@ -0,0 +1,34 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/apigateway_v1beta/service.rb' +require 'google/apis/apigateway_v1beta/classes.rb' +require 'google/apis/apigateway_v1beta/representations.rb' + +module Google + module Apis + # API Gateway API + # + # + # + # @see https://cloud.google.com/api-gateway/docs + module ApigatewayV1beta + VERSION = 'V1beta' + REVISION = '20200901' + + # View and manage your data across Google Cloud Platform services + AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' + end + end +end diff --git a/generated/google/apis/apigateway_v1beta/classes.rb b/generated/google/apis/apigateway_v1beta/classes.rb new file mode 100644 index 000000000..b46cd01bb --- /dev/null +++ b/generated/google/apis/apigateway_v1beta/classes.rb @@ -0,0 +1,1162 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module ApigatewayV1beta + + # A consumable API that can be used by multiple Gateways. + class ApigatewayApi + include Google::Apis::Core::Hashable + + # Output only. Created time. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Optional. Display name. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Optional. Resource labels to represent user-provided metadata. Refer to cloud + # documentation on labels for more details. https://cloud.google.com/compute/ + # docs/labeling-resources + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # Optional. Immutable. The name of a Google Managed Service ( https://cloud. + # google.com/service-infrastructure/docs/glossary#managed). If not specified, a + # new Service will automatically be created in the same project as this API. + # Corresponds to the JSON property `managedService` + # @return [String] + attr_accessor :managed_service + + # Output only. Resource name of the API. Format: projects/`project`/locations/ + # global/apis/`api` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. State of the API. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # Output only. Updated time. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @create_time = args[:create_time] if args.key?(:create_time) + @display_name = args[:display_name] if args.key?(:display_name) + @labels = args[:labels] if args.key?(:labels) + @managed_service = args[:managed_service] if args.key?(:managed_service) + @name = args[:name] if args.key?(:name) + @state = args[:state] if args.key?(:state) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + + # An API Configuration is an association of an API Controller Config and a + # Gateway Config. For APIs with a Managed Service API Controller, this resource + # is associated with one or more Service Configs and a Service Rollout. + # Initially, this resource will extract the Gateway Config from the API + # Controller Config. + class ApigatewayApiConfig + include Google::Apis::Core::Hashable + + # Output only. Created time. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Optional. Display name. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Configuration settings for Gateways. + # Corresponds to the JSON property `gatewayConfig` + # @return [Google::Apis::ApigatewayV1beta::ApigatewayGatewayConfig] + attr_accessor :gateway_config + + # Optional. gRPC service definition files. If specified, openapi_documents must + # not be included. + # Corresponds to the JSON property `grpcServices` + # @return [Array] + attr_accessor :grpc_services + + # Optional. Resource labels to represent user-provided metadata. Refer to cloud + # documentation on labels for more details. https://cloud.google.com/compute/ + # docs/labeling-resources + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # Optional. Service Configuration files. At least one must be included when + # using gRPC service definitions. See https: //cloud.google.com/endpoints/docs/ + # grpc/g // rpc-service-config#service_configuration_overview for the expected + # file contents. If multiple files are specified, the files are merged with the + # following rules: * All singular scalar fields are merged using "last one wins" + # semantics in the order of the files uploaded. * Repeated fields are + # concatenated. * Singular embedded messages are merged using these rules for + # nested fields. + # Corresponds to the JSON property `managedServiceConfigs` + # @return [Array] + attr_accessor :managed_service_configs + + # Output only. Resource name of the API Config. Format: projects/`project`/ + # locations/global/apis/`api`/configs/`api_config` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Optional. OpenAPI specification documents. If specified, grpc_services and + # managed_service_config must not be included. + # Corresponds to the JSON property `openapiDocuments` + # @return [Array] + attr_accessor :openapi_documents + + # Output only. The ID of the associated Service Config ( https://cloud.google. + # com/service-infrastructure/docs/glossary#config). + # Corresponds to the JSON property `serviceConfigId` + # @return [String] + attr_accessor :service_config_id + + # Output only. State of the API Config. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # Output only. Updated time. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @create_time = args[:create_time] if args.key?(:create_time) + @display_name = args[:display_name] if args.key?(:display_name) + @gateway_config = args[:gateway_config] if args.key?(:gateway_config) + @grpc_services = args[:grpc_services] if args.key?(:grpc_services) + @labels = args[:labels] if args.key?(:labels) + @managed_service_configs = args[:managed_service_configs] if args.key?(:managed_service_configs) + @name = args[:name] if args.key?(:name) + @openapi_documents = args[:openapi_documents] if args.key?(:openapi_documents) + @service_config_id = args[:service_config_id] if args.key?(:service_config_id) + @state = args[:state] if args.key?(:state) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + + # A lightweight description of a file. + class ApigatewayApiConfigFile + include Google::Apis::Core::Hashable + + # The bytes that constitute the file. + # Corresponds to the JSON property `contents` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :contents + + # The file path (full or relative path). This is typically the path of the file + # when it is uploaded. + # Corresponds to the JSON property `path` + # @return [String] + attr_accessor :path + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @contents = args[:contents] if args.key?(:contents) + @path = args[:path] if args.key?(:path) + end + end + + # A gRPC service definition. + class ApigatewayApiConfigGrpcServiceDefinition + include Google::Apis::Core::Hashable + + # A lightweight description of a file. + # Corresponds to the JSON property `fileDescriptorSet` + # @return [Google::Apis::ApigatewayV1beta::ApigatewayApiConfigFile] + attr_accessor :file_descriptor_set + + # Optional. Uncompiled proto files associated with the descriptor set, used for + # display purposes (server-side compilation is not supported). These should + # match the inputs to 'protoc' command used to generate file_descriptor_set. + # Corresponds to the JSON property `source` + # @return [Array] + attr_accessor :source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @file_descriptor_set = args[:file_descriptor_set] if args.key?(:file_descriptor_set) + @source = args[:source] if args.key?(:source) + end + end + + # An OpenAPI Specification Document describing an API. + class ApigatewayApiConfigOpenApiDocument + include Google::Apis::Core::Hashable + + # A lightweight description of a file. + # Corresponds to the JSON property `document` + # @return [Google::Apis::ApigatewayV1beta::ApigatewayApiConfigFile] + attr_accessor :document + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @document = args[:document] if args.key?(:document) + end + end + + # 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. + class ApigatewayAuditConfig + include Google::Apis::Core::Hashable + + # The configuration for logging of each type of permission. + # Corresponds to the JSON property `auditLogConfigs` + # @return [Array] + attr_accessor :audit_log_configs + + # 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. + # Corresponds to the JSON property `service` + # @return [String] + attr_accessor :service + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audit_log_configs = args[:audit_log_configs] if args.key?(:audit_log_configs) + @service = args[:service] if args.key?(:service) + end + end + + # 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. + class ApigatewayAuditLogConfig + include Google::Apis::Core::Hashable + + # Specifies the identities that do not cause logging for this type of permission. + # Follows the same format of Binding.members. + # Corresponds to the JSON property `exemptedMembers` + # @return [Array] + attr_accessor :exempted_members + + # The log type that this config enables. + # Corresponds to the JSON property `logType` + # @return [String] + attr_accessor :log_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @exempted_members = args[:exempted_members] if args.key?(:exempted_members) + @log_type = args[:log_type] if args.key?(:log_type) + end + end + + # Configuration for a backend. + class ApigatewayBackendConfig + include Google::Apis::Core::Hashable + + # Google Cloud IAM service account used to sign OIDC tokens for backends that + # have authentication configured (https: //cloud.google.com/service- + # infrastructur // e/docs/service-management/reference/rest/v1/services.configs# + # backend). This may either be the Service Account's email (i.e. "`ACCOUNT_ID`@` + # PROJECT`.iam.gserviceaccount.com") or its full resource name (i.e. "projects/` + # PROJECT`/accounts/`UNIQUE_ID`"). This is most often used when the backend is a + # GCP resource such as a Cloud Run Service or an IAP-secured service. Note that + # this token is always sent as an authorization header bearer token. The + # audience of the OIDC token is configured in the associated Service Config in + # the BackendRule option (https: //github.com/googleapis/googleapis/blob/ // + # master/google/api/backend.proto#L125). + # Corresponds to the JSON property `googleServiceAccount` + # @return [String] + attr_accessor :google_service_account + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @google_service_account = args[:google_service_account] if args.key?(:google_service_account) + end + end + + # Associates `members` with a `role`. + class ApigatewayBinding + include Google::Apis::Core::Hashable + + # Represents a textual expression in the Common Expression Language (CEL) syntax. + # CEL is a C-like expression language. The syntax and semantics of CEL are + # documented at https://github.com/google/cel-spec. Example (Comparison): title: + # "Summary size limit" description: "Determines if a summary is less than 100 + # chars" expression: "document.summary.size() < 100" Example (Equality): title: " + # Requestor is owner" description: "Determines if requestor is the document + # owner" expression: "document.owner == request.auth.claims.email" Example ( + # Logic): title: "Public documents" description: "Determine whether the document + # should be publicly visible" expression: "document.type != 'private' && + # document.type != 'internal'" Example (Data Manipulation): title: "Notification + # string" description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" The + # exact variables and functions that may be referenced within an expression are + # determined by the service that evaluates it. See the service documentation for + # additional information. + # Corresponds to the JSON property `condition` + # @return [Google::Apis::ApigatewayV1beta::ApigatewayExpr] + attr_accessor :condition + + # Specifies the identities requesting access for a Cloud Platform resource. ` + # members` can have the following values: * `allUsers`: A special identifier + # that represents anyone who is on the internet; with or without a Google + # account. * `allAuthenticatedUsers`: A special identifier that represents + # anyone who is authenticated with a Google account or a service account. * ` + # user:`emailid``: An email address that represents a specific Google account. + # For example, `alice@example.com` . * `serviceAccount:`emailid``: An email + # address that represents a service account. For example, `my-other-app@appspot. + # gserviceaccount.com`. * `group:`emailid``: An email address that represents a + # Google group. For example, `admins@example.com`. * `deleted:user:`emailid`?uid= + # `uniqueid``: An email address (plus unique identifier) representing a user + # that has been recently deleted. For example, `alice@example.com?uid= + # 123456789012345678901`. If the user is recovered, this value reverts to `user:` + # emailid`` and the recovered user retains the role in the binding. * `deleted: + # serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus unique + # identifier) representing a service account that has been recently deleted. For + # example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + # If the service account is undeleted, this value reverts to `serviceAccount:` + # emailid`` and the undeleted service account retains the role in the binding. * + # `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique + # identifier) representing a Google group that has been recently deleted. For + # example, `admins@example.com?uid=123456789012345678901`. If the group is + # recovered, this value reverts to `group:`emailid`` and the recovered group + # retains the role in the binding. * `domain:`domain``: The G Suite domain ( + # primary) that represents all the users of that domain. For example, `google. + # com` or `example.com`. + # Corresponds to the JSON property `members` + # @return [Array] + attr_accessor :members + + # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor` + # , or `roles/owner`. + # Corresponds to the JSON property `role` + # @return [String] + attr_accessor :role + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @condition = args[:condition] if args.key?(:condition) + @members = args[:members] if args.key?(:members) + @role = args[:role] if args.key?(:role) + end + end + + # The request message for Operations.CancelOperation. + class ApigatewayCancelOperationRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Represents a textual expression in the Common Expression Language (CEL) syntax. + # CEL is a C-like expression language. The syntax and semantics of CEL are + # documented at https://github.com/google/cel-spec. Example (Comparison): title: + # "Summary size limit" description: "Determines if a summary is less than 100 + # chars" expression: "document.summary.size() < 100" Example (Equality): title: " + # Requestor is owner" description: "Determines if requestor is the document + # owner" expression: "document.owner == request.auth.claims.email" Example ( + # Logic): title: "Public documents" description: "Determine whether the document + # should be publicly visible" expression: "document.type != 'private' && + # document.type != 'internal'" Example (Data Manipulation): title: "Notification + # string" description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" The + # exact variables and functions that may be referenced within an expression are + # determined by the service that evaluates it. See the service documentation for + # additional information. + class ApigatewayExpr + include Google::Apis::Core::Hashable + + # Optional. Description of the expression. This is a longer text which describes + # the expression, e.g. when hovered over it in a UI. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Textual representation of an expression in Common Expression Language syntax. + # Corresponds to the JSON property `expression` + # @return [String] + attr_accessor :expression + + # Optional. String indicating the location of the expression for error reporting, + # e.g. a file name and a position in the file. + # Corresponds to the JSON property `location` + # @return [String] + attr_accessor :location + + # 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. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @expression = args[:expression] if args.key?(:expression) + @location = args[:location] if args.key?(:location) + @title = args[:title] if args.key?(:title) + end + end + + # A Gateway is an API-aware HTTP proxy. It performs API-Method and/or API- + # Consumer specific actions based on an API Config such as authentication, + # policy enforcement, and backend selection. + class ApigatewayGateway + include Google::Apis::Core::Hashable + + # Required. Resource name of the API Config for this Gateway. Format: projects/` + # project`/locations/global/apis/`api`/configs/`apiConfig` + # Corresponds to the JSON property `apiConfig` + # @return [String] + attr_accessor :api_config + + # Output only. Created time. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Output only. The default API Gateway host name of the form ``gateway_id`-`hash` + # .`region_code`.gateway.dev`. + # Corresponds to the JSON property `defaultHostname` + # @return [String] + attr_accessor :default_hostname + + # Optional. Display name. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Optional. Resource labels to represent user-provided metadata. Refer to cloud + # documentation on labels for more details. https://cloud.google.com/compute/ + # docs/labeling-resources + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # Output only. Resource name of the Gateway. Format: projects/`project`/ + # locations/`location`/gateways/`gateway` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. The current state of the Gateway. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # Output only. Updated time. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @api_config = args[:api_config] if args.key?(:api_config) + @create_time = args[:create_time] if args.key?(:create_time) + @default_hostname = args[:default_hostname] if args.key?(:default_hostname) + @display_name = args[:display_name] if args.key?(:display_name) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + @state = args[:state] if args.key?(:state) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + + # Configuration settings for Gateways. + class ApigatewayGatewayConfig + include Google::Apis::Core::Hashable + + # Configuration for a backend. + # Corresponds to the JSON property `backendConfig` + # @return [Google::Apis::ApigatewayV1beta::ApigatewayBackendConfig] + attr_accessor :backend_config + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @backend_config = args[:backend_config] if args.key?(:backend_config) + end + end + + # Response message for ApiGatewayService.ListApiConfigs + class ApigatewayListApiConfigsResponse + include Google::Apis::Core::Hashable + + # API Configs. + # Corresponds to the JSON property `apiConfigs` + # @return [Array] + attr_accessor :api_configs + + # Next page token. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Locations that could not be reached. + # Corresponds to the JSON property `unreachableLocations` + # @return [Array] + attr_accessor :unreachable_locations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @api_configs = args[:api_configs] if args.key?(:api_configs) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @unreachable_locations = args[:unreachable_locations] if args.key?(:unreachable_locations) + end + end + + # Response message for ApiGatewayService.ListApis + class ApigatewayListApisResponse + include Google::Apis::Core::Hashable + + # APIs. + # Corresponds to the JSON property `apis` + # @return [Array] + attr_accessor :apis + + # Next page token. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Locations that could not be reached. + # Corresponds to the JSON property `unreachableLocations` + # @return [Array] + attr_accessor :unreachable_locations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @apis = args[:apis] if args.key?(:apis) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @unreachable_locations = args[:unreachable_locations] if args.key?(:unreachable_locations) + end + end + + # Response message for ApiGatewayService.ListGateways + class ApigatewayListGatewaysResponse + include Google::Apis::Core::Hashable + + # Gateways. + # Corresponds to the JSON property `gateways` + # @return [Array] + attr_accessor :gateways + + # Next page token. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Locations that could not be reached. + # Corresponds to the JSON property `unreachableLocations` + # @return [Array] + attr_accessor :unreachable_locations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @gateways = args[:gateways] if args.key?(:gateways) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @unreachable_locations = args[:unreachable_locations] if args.key?(:unreachable_locations) + end + end + + # The response message for Locations.ListLocations. + class ApigatewayListLocationsResponse + include Google::Apis::Core::Hashable + + # A list of locations that matches the specified filter in the request. + # Corresponds to the JSON property `locations` + # @return [Array] + attr_accessor :locations + + # The standard List next-page token. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @locations = args[:locations] if args.key?(:locations) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # The response message for Operations.ListOperations. + class ApigatewayListOperationsResponse + include Google::Apis::Core::Hashable + + # The standard List next-page token. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # A list of operations that matches the specified filter in the request. + # Corresponds to the JSON property `operations` + # @return [Array] + attr_accessor :operations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @operations = args[:operations] if args.key?(:operations) + end + end + + # A resource that represents Google Cloud Platform location. + class ApigatewayLocation + include Google::Apis::Core::Hashable + + # The friendly name for this location, typically a nearby city name. For example, + # "Tokyo". + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Cross-service attributes for the location. For example `"cloud.googleapis.com/ + # region": "us-east1"` + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # The canonical id for this location. For example: `"us-east1"`. + # Corresponds to the JSON property `locationId` + # @return [String] + attr_accessor :location_id + + # Service-specific metadata. For example the available capacity at the given + # location. + # Corresponds to the JSON property `metadata` + # @return [Hash] + attr_accessor :metadata + + # Resource name for the location, which may vary between implementations. For + # example: `"projects/example-project/locations/us-east1"` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + @labels = args[:labels] if args.key?(:labels) + @location_id = args[:location_id] if args.key?(:location_id) + @metadata = args[:metadata] if args.key?(:metadata) + @name = args[:name] if args.key?(:name) + end + end + + # This resource represents a long-running operation that is the result of a + # network API call. + class ApigatewayOperation + include Google::Apis::Core::Hashable + + # If the value is `false`, it means the operation is still in progress. If `true` + # , the operation is completed, and either `error` or `response` is available. + # Corresponds to the JSON property `done` + # @return [Boolean] + attr_accessor :done + alias_method :done?, :done + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). + # Corresponds to the JSON property `error` + # @return [Google::Apis::ApigatewayV1beta::ApigatewayStatus] + attr_accessor :error + + # Service-specific metadata associated with the operation. It typically contains + # progress information and common metadata such as create time. Some services + # might not provide such metadata. Any method that returns a long-running + # operation should document the metadata type, if any. + # Corresponds to the JSON property `metadata` + # @return [Hash] + attr_accessor :metadata + + # The server-assigned name, which is only unique within the same service that + # originally returns it. If you use the default HTTP mapping, the `name` should + # be a resource name ending with `operations/`unique_id``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The normal response of the operation in case of success. If the original + # method returns no data on success, such as `Delete`, the response is `google. + # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, + # the response should be the resource. For other methods, the response should + # have the type `XxxResponse`, where `Xxx` is the original method name. For + # example, if the original method name is `TakeSnapshot()`, the inferred + # response type is `TakeSnapshotResponse`. + # Corresponds to the JSON property `response` + # @return [Hash] + attr_accessor :response + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @done = args[:done] if args.key?(:done) + @error = args[:error] if args.key?(:error) + @metadata = args[:metadata] if args.key?(:metadata) + @name = args[:name] if args.key?(:name) + @response = args[:response] if args.key?(:response) + end + end + + # Represents the metadata of the long-running operation. + class ApigatewayOperationMetadata + include Google::Apis::Core::Hashable + + # Output only. API version used to start the operation. + # Corresponds to the JSON property `apiVersion` + # @return [String] + attr_accessor :api_version + + # Output only. The time the operation was created. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Output only. Diagnostics generated during processing of configuration source + # files. + # Corresponds to the JSON property `diagnostics` + # @return [Array] + attr_accessor :diagnostics + + # Output only. The time the operation finished running. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # 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 of 1, corresponding to `Code. + # CANCELLED`. + # Corresponds to the JSON property `requestedCancellation` + # @return [Boolean] + attr_accessor :requested_cancellation + alias_method :requested_cancellation?, :requested_cancellation + + # Output only. Human-readable status of the operation, if any. + # Corresponds to the JSON property `statusMessage` + # @return [String] + attr_accessor :status_message + + # Output only. Server-defined resource path for the target of the operation. + # Corresponds to the JSON property `target` + # @return [String] + attr_accessor :target + + # Output only. Name of the verb executed by the operation. + # Corresponds to the JSON property `verb` + # @return [String] + attr_accessor :verb + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @api_version = args[:api_version] if args.key?(:api_version) + @create_time = args[:create_time] if args.key?(:create_time) + @diagnostics = args[:diagnostics] if args.key?(:diagnostics) + @end_time = args[:end_time] if args.key?(:end_time) + @requested_cancellation = args[:requested_cancellation] if args.key?(:requested_cancellation) + @status_message = args[:status_message] if args.key?(:status_message) + @target = args[:target] if args.key?(:target) + @verb = args[:verb] if args.key?(:verb) + end + end + + # Diagnostic information from configuration processing. + class ApigatewayOperationMetadataDiagnostic + include Google::Apis::Core::Hashable + + # Location of the diagnostic. + # Corresponds to the JSON property `location` + # @return [String] + attr_accessor :location + + # The diagnostic message. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @location = args[:location] if args.key?(:location) + @message = args[:message] if args.key?(:message) + end + end + + # An Identity and Access Management (IAM) policy, which specifies access + # controls for Google Cloud resources. A `Policy` is a collection of `bindings`. + # A `binding` binds one or more `members` to a single `role`. Members can be + # user accounts, service accounts, Google groups, and domains (such as G Suite). + # A `role` is a named list of permissions; each `role` can be an IAM predefined + # role or a user-created custom role. For some types of Google Cloud resources, + # a `binding` can also specify a `condition`, which is a logical expression that + # allows access to a resource only if the expression evaluates to `true`. A + # condition can add constraints based on attributes of the request, the resource, + # or both. To learn which resources support conditions in their IAM policies, + # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/ + # resource-policies). **JSON example:** ` "bindings": [ ` "role": "roles/ + # resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", " + # group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@ + # appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager. + # organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` " + # title": "expirable access", "description": "Does not grant access after Sep + # 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", ` + # ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: - + # members: - user:mike@example.com - group:admins@example.com - domain:google. + # com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/ + # resourcemanager.organizationAdmin - members: - user:eve@example.com role: + # roles/resourcemanager.organizationViewer condition: title: expirable access + # description: Does not grant access after Sep 2020 expression: request.time < + # timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a + # description of IAM and its features, see the [IAM documentation](https://cloud. + # google.com/iam/docs/). + class ApigatewayPolicy + include Google::Apis::Core::Hashable + + # Specifies cloud audit logging configuration for this policy. + # Corresponds to the JSON property `auditConfigs` + # @return [Array] + attr_accessor :audit_configs + + # Associates a list of `members` to a `role`. Optionally, may specify a ` + # condition` that determines how and when the `bindings` are applied. Each of + # the `bindings` must contain at least one member. + # Corresponds to the JSON property `bindings` + # @return [Array] + attr_accessor :bindings + + # `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. + # Corresponds to the JSON property `etag` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :etag + + # 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). + # Corresponds to the JSON property `version` + # @return [Fixnum] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audit_configs = args[:audit_configs] if args.key?(:audit_configs) + @bindings = args[:bindings] if args.key?(:bindings) + @etag = args[:etag] if args.key?(:etag) + @version = args[:version] if args.key?(:version) + end + end + + # Request message for `SetIamPolicy` method. + class ApigatewaySetIamPolicyRequest + include Google::Apis::Core::Hashable + + # An Identity and Access Management (IAM) policy, which specifies access + # controls for Google Cloud resources. A `Policy` is a collection of `bindings`. + # A `binding` binds one or more `members` to a single `role`. Members can be + # user accounts, service accounts, Google groups, and domains (such as G Suite). + # A `role` is a named list of permissions; each `role` can be an IAM predefined + # role or a user-created custom role. For some types of Google Cloud resources, + # a `binding` can also specify a `condition`, which is a logical expression that + # allows access to a resource only if the expression evaluates to `true`. A + # condition can add constraints based on attributes of the request, the resource, + # or both. To learn which resources support conditions in their IAM policies, + # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/ + # resource-policies). **JSON example:** ` "bindings": [ ` "role": "roles/ + # resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", " + # group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@ + # appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager. + # organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` " + # title": "expirable access", "description": "Does not grant access after Sep + # 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", ` + # ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: - + # members: - user:mike@example.com - group:admins@example.com - domain:google. + # com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/ + # resourcemanager.organizationAdmin - members: - user:eve@example.com role: + # roles/resourcemanager.organizationViewer condition: title: expirable access + # description: Does not grant access after Sep 2020 expression: request.time < + # timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a + # description of IAM and its features, see the [IAM documentation](https://cloud. + # google.com/iam/docs/). + # Corresponds to the JSON property `policy` + # @return [Google::Apis::ApigatewayV1beta::ApigatewayPolicy] + attr_accessor :policy + + # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only + # the fields in the mask will be modified. If no mask is provided, the following + # default mask is used: `paths: "bindings, etag"` + # Corresponds to the JSON property `updateMask` + # @return [String] + attr_accessor :update_mask + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @policy = args[:policy] if args.key?(:policy) + @update_mask = args[:update_mask] if args.key?(:update_mask) + end + end + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). + class ApigatewayStatus + include Google::Apis::Core::Hashable + + # The status code, which should be an enum value of google.rpc.Code. + # Corresponds to the JSON property `code` + # @return [Fixnum] + attr_accessor :code + + # A list of messages that carry the error details. There is a common set of + # message types for APIs to use. + # Corresponds to the JSON property `details` + # @return [Array>] + attr_accessor :details + + # A developer-facing error message, which should be in English. Any user-facing + # error message should be localized and sent in the google.rpc.Status.details + # field, or localized by the client. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @details = args[:details] if args.key?(:details) + @message = args[:message] if args.key?(:message) + end + end + + # Request message for `TestIamPermissions` method. + class ApigatewayTestIamPermissionsRequest + include Google::Apis::Core::Hashable + + # The set of permissions to check for the `resource`. Permissions with wildcards + # (such as '*' or 'storage.*') are not allowed. For more information see [IAM + # Overview](https://cloud.google.com/iam/docs/overview#permissions). + # Corresponds to the JSON property `permissions` + # @return [Array] + attr_accessor :permissions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @permissions = args[:permissions] if args.key?(:permissions) + end + end + + # Response message for `TestIamPermissions` method. + class ApigatewayTestIamPermissionsResponse + include Google::Apis::Core::Hashable + + # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. + # Corresponds to the JSON property `permissions` + # @return [Array] + attr_accessor :permissions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @permissions = args[:permissions] if args.key?(:permissions) + end + end + + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. + class Empty + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + end + end +end diff --git a/generated/google/apis/apigateway_v1beta/representations.rb b/generated/google/apis/apigateway_v1beta/representations.rb new file mode 100644 index 000000000..0b553d3d3 --- /dev/null +++ b/generated/google/apis/apigateway_v1beta/representations.rb @@ -0,0 +1,470 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module ApigatewayV1beta + + class ApigatewayApi + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayApiConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayApiConfigFile + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayApiConfigGrpcServiceDefinition + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayApiConfigOpenApiDocument + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayAuditConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayAuditLogConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayBackendConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayBinding + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayCancelOperationRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayExpr + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayGateway + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayGatewayConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayListApiConfigsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayListApisResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayListGatewaysResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayListLocationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayListOperationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayLocation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayOperation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayOperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayOperationMetadataDiagnostic + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayPolicy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewaySetIamPolicyRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayTestIamPermissionsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayTestIamPermissionsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Empty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApigatewayApi + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :create_time, as: 'createTime' + property :display_name, as: 'displayName' + hash :labels, as: 'labels' + property :managed_service, as: 'managedService' + property :name, as: 'name' + property :state, as: 'state' + property :update_time, as: 'updateTime' + end + end + + class ApigatewayApiConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :create_time, as: 'createTime' + property :display_name, as: 'displayName' + property :gateway_config, as: 'gatewayConfig', class: Google::Apis::ApigatewayV1beta::ApigatewayGatewayConfig, decorator: Google::Apis::ApigatewayV1beta::ApigatewayGatewayConfig::Representation + + collection :grpc_services, as: 'grpcServices', class: Google::Apis::ApigatewayV1beta::ApigatewayApiConfigGrpcServiceDefinition, decorator: Google::Apis::ApigatewayV1beta::ApigatewayApiConfigGrpcServiceDefinition::Representation + + hash :labels, as: 'labels' + collection :managed_service_configs, as: 'managedServiceConfigs', class: Google::Apis::ApigatewayV1beta::ApigatewayApiConfigFile, decorator: Google::Apis::ApigatewayV1beta::ApigatewayApiConfigFile::Representation + + property :name, as: 'name' + collection :openapi_documents, as: 'openapiDocuments', class: Google::Apis::ApigatewayV1beta::ApigatewayApiConfigOpenApiDocument, decorator: Google::Apis::ApigatewayV1beta::ApigatewayApiConfigOpenApiDocument::Representation + + property :service_config_id, as: 'serviceConfigId' + property :state, as: 'state' + property :update_time, as: 'updateTime' + end + end + + class ApigatewayApiConfigFile + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :contents, :base64 => true, as: 'contents' + property :path, as: 'path' + end + end + + class ApigatewayApiConfigGrpcServiceDefinition + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :file_descriptor_set, as: 'fileDescriptorSet', class: Google::Apis::ApigatewayV1beta::ApigatewayApiConfigFile, decorator: Google::Apis::ApigatewayV1beta::ApigatewayApiConfigFile::Representation + + collection :source, as: 'source', class: Google::Apis::ApigatewayV1beta::ApigatewayApiConfigFile, decorator: Google::Apis::ApigatewayV1beta::ApigatewayApiConfigFile::Representation + + end + end + + class ApigatewayApiConfigOpenApiDocument + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :document, as: 'document', class: Google::Apis::ApigatewayV1beta::ApigatewayApiConfigFile, decorator: Google::Apis::ApigatewayV1beta::ApigatewayApiConfigFile::Representation + + end + end + + class ApigatewayAuditConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::ApigatewayV1beta::ApigatewayAuditLogConfig, decorator: Google::Apis::ApigatewayV1beta::ApigatewayAuditLogConfig::Representation + + property :service, as: 'service' + end + end + + class ApigatewayAuditLogConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :exempted_members, as: 'exemptedMembers' + property :log_type, as: 'logType' + end + end + + class ApigatewayBackendConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :google_service_account, as: 'googleServiceAccount' + end + end + + class ApigatewayBinding + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :condition, as: 'condition', class: Google::Apis::ApigatewayV1beta::ApigatewayExpr, decorator: Google::Apis::ApigatewayV1beta::ApigatewayExpr::Representation + + collection :members, as: 'members' + property :role, as: 'role' + end + end + + class ApigatewayCancelOperationRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class ApigatewayExpr + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :expression, as: 'expression' + property :location, as: 'location' + property :title, as: 'title' + end + end + + class ApigatewayGateway + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :api_config, as: 'apiConfig' + property :create_time, as: 'createTime' + property :default_hostname, as: 'defaultHostname' + property :display_name, as: 'displayName' + hash :labels, as: 'labels' + property :name, as: 'name' + property :state, as: 'state' + property :update_time, as: 'updateTime' + end + end + + class ApigatewayGatewayConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :backend_config, as: 'backendConfig', class: Google::Apis::ApigatewayV1beta::ApigatewayBackendConfig, decorator: Google::Apis::ApigatewayV1beta::ApigatewayBackendConfig::Representation + + end + end + + class ApigatewayListApiConfigsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :api_configs, as: 'apiConfigs', class: Google::Apis::ApigatewayV1beta::ApigatewayApiConfig, decorator: Google::Apis::ApigatewayV1beta::ApigatewayApiConfig::Representation + + property :next_page_token, as: 'nextPageToken' + collection :unreachable_locations, as: 'unreachableLocations' + end + end + + class ApigatewayListApisResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :apis, as: 'apis', class: Google::Apis::ApigatewayV1beta::ApigatewayApi, decorator: Google::Apis::ApigatewayV1beta::ApigatewayApi::Representation + + property :next_page_token, as: 'nextPageToken' + collection :unreachable_locations, as: 'unreachableLocations' + end + end + + class ApigatewayListGatewaysResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :gateways, as: 'gateways', class: Google::Apis::ApigatewayV1beta::ApigatewayGateway, decorator: Google::Apis::ApigatewayV1beta::ApigatewayGateway::Representation + + property :next_page_token, as: 'nextPageToken' + collection :unreachable_locations, as: 'unreachableLocations' + end + end + + class ApigatewayListLocationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :locations, as: 'locations', class: Google::Apis::ApigatewayV1beta::ApigatewayLocation, decorator: Google::Apis::ApigatewayV1beta::ApigatewayLocation::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ApigatewayListOperationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :operations, as: 'operations', class: Google::Apis::ApigatewayV1beta::ApigatewayOperation, decorator: Google::Apis::ApigatewayV1beta::ApigatewayOperation::Representation + + end + end + + class ApigatewayLocation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + hash :labels, as: 'labels' + property :location_id, as: 'locationId' + hash :metadata, as: 'metadata' + property :name, as: 'name' + end + end + + class ApigatewayOperation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :done, as: 'done' + property :error, as: 'error', class: Google::Apis::ApigatewayV1beta::ApigatewayStatus, decorator: Google::Apis::ApigatewayV1beta::ApigatewayStatus::Representation + + hash :metadata, as: 'metadata' + property :name, as: 'name' + hash :response, as: 'response' + end + end + + class ApigatewayOperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :api_version, as: 'apiVersion' + property :create_time, as: 'createTime' + collection :diagnostics, as: 'diagnostics', class: Google::Apis::ApigatewayV1beta::ApigatewayOperationMetadataDiagnostic, decorator: Google::Apis::ApigatewayV1beta::ApigatewayOperationMetadataDiagnostic::Representation + + property :end_time, as: 'endTime' + property :requested_cancellation, as: 'requestedCancellation' + property :status_message, as: 'statusMessage' + property :target, as: 'target' + property :verb, as: 'verb' + end + end + + class ApigatewayOperationMetadataDiagnostic + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :location, as: 'location' + property :message, as: 'message' + end + end + + class ApigatewayPolicy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audit_configs, as: 'auditConfigs', class: Google::Apis::ApigatewayV1beta::ApigatewayAuditConfig, decorator: Google::Apis::ApigatewayV1beta::ApigatewayAuditConfig::Representation + + collection :bindings, as: 'bindings', class: Google::Apis::ApigatewayV1beta::ApigatewayBinding, decorator: Google::Apis::ApigatewayV1beta::ApigatewayBinding::Representation + + property :etag, :base64 => true, as: 'etag' + property :version, as: 'version' + end + end + + class ApigatewaySetIamPolicyRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :policy, as: 'policy', class: Google::Apis::ApigatewayV1beta::ApigatewayPolicy, decorator: Google::Apis::ApigatewayV1beta::ApigatewayPolicy::Representation + + property :update_mask, as: 'updateMask' + end + end + + class ApigatewayStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :details, as: 'details' + property :message, as: 'message' + end + end + + class ApigatewayTestIamPermissionsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end + + class ApigatewayTestIamPermissionsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end + + class Empty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + end + end +end diff --git a/generated/google/apis/apigateway_v1beta/service.rb b/generated/google/apis/apigateway_v1beta/service.rb new file mode 100644 index 000000000..b6fbf4498 --- /dev/null +++ b/generated/google/apis/apigateway_v1beta/service.rb @@ -0,0 +1,1172 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module ApigatewayV1beta + # API Gateway API + # + # + # + # @example + # require 'google/apis/apigateway_v1beta' + # + # Apigateway = Google::Apis::ApigatewayV1beta # Alias the module + # service = Apigateway::ApigatewayService.new + # + # @see https://cloud.google.com/api-gateway/docs + class ApigatewayService < Google::Apis::Core::BaseService + # @return [String] + # 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. + attr_accessor :key + + # @return [String] + # 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. + attr_accessor :quota_user + + def initialize + super('https://apigateway.googleapis.com/', '') + @batch_path = 'batch' + end + + # Gets information about a location. + # @param [String] name + # Resource name for the location. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayLocation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayLocation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayLocation::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayLocation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists information about the supported locations for this service. + # @param [String] name + # The resource that owns the locations collection, if applicable. + # @param [String] filter + # The standard list filter. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] page_token + # The standard list page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayListLocationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayListLocationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+name}/locations', options) + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayListLocationsResponse::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayListLocationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new Api in a given project and location. + # @param [String] parent + # Required. Parent resource of the API, of the form: `projects/*/locations/ + # global` + # @param [Google::Apis::ApigatewayV1beta::ApigatewayApi] apigateway_api_object + # @param [String] api_id + # Required. Identifier to assign to the API. Must be unique within scope of the + # parent resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_api(parent, apigateway_api_object = nil, api_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta/{+parent}/apis', options) + command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewayApi::Representation + command.request_object = apigateway_api_object + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayOperation::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayOperation + command.params['parent'] = parent unless parent.nil? + command.query['apiId'] = api_id unless api_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a single Api. + # @param [String] name + # Required. Resource name of the form: `projects/*/locations/global/apis/*` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_api(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayOperation::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayOperation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets details of a single Api. + # @param [String] name + # Required. Resource name of the form: `projects/*/locations/global/apis/*` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayApi] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayApi] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_api(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayApi::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayApi + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. + # @param [Fixnum] options_requested_policy_version + # Optional. The policy format version to be returned. Valid values are 0, 1, and + # 3. Requests specifying an invalid value will be rejected. Requests for + # policies with any conditional bindings must specify version 3. Policies + # without any conditional bindings may specify any valid value or leave the + # field unset. To learn which resources support conditions in their IAM policies, + # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/ + # resource-policies). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayPolicy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayPolicy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_api_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayPolicy::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayPolicy + command.params['resource'] = resource unless resource.nil? + command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists Apis in a given project and location. + # @param [String] parent + # Required. Parent resource of the API, of the form: `projects/*/locations/ + # global` + # @param [String] filter + # Filter. + # @param [String] order_by + # Order by parameters. + # @param [Fixnum] page_size + # Page size. + # @param [String] page_token + # Page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayListApisResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayListApisResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_apis(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+parent}/apis', options) + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayListApisResponse::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayListApisResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the parameters of a single Api. + # @param [String] name + # Output only. Resource name of the API. Format: projects/`project`/locations/ + # global/apis/`api` + # @param [Google::Apis::ApigatewayV1beta::ApigatewayApi] apigateway_api_object + # @param [String] update_mask + # Field mask is used to specify the fields to be overwritten in the Api 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_api(name, apigateway_api_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta/{+name}', options) + command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewayApi::Representation + command.request_object = apigateway_api_object + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayOperation::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayOperation + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy on the specified resource. Replaces any + # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` + # PERMISSION_DENIED` errors. + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. + # @param [Google::Apis::ApigatewayV1beta::ApigatewaySetIamPolicyRequest] apigateway_set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayPolicy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayPolicy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_project_location_api_iam_policy(resource, apigateway_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewaySetIamPolicyRequest::Representation + command.request_object = apigateway_set_iam_policy_request_object + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayPolicy::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayPolicy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # 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. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. + # @param [Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsRequest] apigateway_test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_project_location_api_iam_permissions(resource, apigateway_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsRequest::Representation + command.request_object = apigateway_test_iam_permissions_request_object + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new ApiConfig in a given project and location. + # @param [String] parent + # Required. Parent resource of the API Config, of the form: `projects/*/ + # locations/global/apis/*` + # @param [Google::Apis::ApigatewayV1beta::ApigatewayApiConfig] apigateway_api_config_object + # @param [String] api_config_id + # Required. Identifier to assign to the API Config. Must be unique within scope + # of the parent resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_api_config(parent, apigateway_api_config_object = nil, api_config_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta/{+parent}/configs', options) + command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewayApiConfig::Representation + command.request_object = apigateway_api_config_object + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayOperation::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayOperation + command.params['parent'] = parent unless parent.nil? + command.query['apiConfigId'] = api_config_id unless api_config_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a single ApiConfig. + # @param [String] name + # Required. Resource name of the form: `projects/*/locations/global/apis/*/ + # configs/*` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_api_config(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayOperation::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayOperation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets details of a single ApiConfig. + # @param [String] name + # Required. Resource name of the form: `projects/*/locations/global/apis/*/ + # configs/*` + # @param [String] view + # Specifies which fields of the API Config are returned in the response. + # Defaults to `BASIC` view. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayApiConfig] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayApiConfig] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_api_config(name, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayApiConfig::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayApiConfig + command.params['name'] = name unless name.nil? + command.query['view'] = view unless view.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. + # @param [Fixnum] options_requested_policy_version + # Optional. The policy format version to be returned. Valid values are 0, 1, and + # 3. Requests specifying an invalid value will be rejected. Requests for + # policies with any conditional bindings must specify version 3. Policies + # without any conditional bindings may specify any valid value or leave the + # field unset. To learn which resources support conditions in their IAM policies, + # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/ + # resource-policies). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayPolicy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayPolicy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_api_config_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayPolicy::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayPolicy + command.params['resource'] = resource unless resource.nil? + command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists ApiConfigs in a given project and location. + # @param [String] parent + # Required. Parent resource of the API Config, of the form: `projects/*/ + # locations/global/apis/*` + # @param [String] filter + # Filter. + # @param [String] order_by + # Order by parameters. + # @param [Fixnum] page_size + # Page size. + # @param [String] page_token + # Page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayListApiConfigsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayListApiConfigsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_api_configs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+parent}/configs', options) + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayListApiConfigsResponse::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayListApiConfigsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the parameters of a single ApiConfig. + # @param [String] name + # Output only. Resource name of the API Config. Format: projects/`project`/ + # locations/global/apis/`api`/configs/`api_config` + # @param [Google::Apis::ApigatewayV1beta::ApigatewayApiConfig] apigateway_api_config_object + # @param [String] update_mask + # Field mask is used to specify the fields to be overwritten in the ApiConfig + # 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_api_config(name, apigateway_api_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta/{+name}', options) + command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewayApiConfig::Representation + command.request_object = apigateway_api_config_object + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayOperation::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayOperation + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy on the specified resource. Replaces any + # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` + # PERMISSION_DENIED` errors. + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. + # @param [Google::Apis::ApigatewayV1beta::ApigatewaySetIamPolicyRequest] apigateway_set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayPolicy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayPolicy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_project_location_api_config_iam_policy(resource, apigateway_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewaySetIamPolicyRequest::Representation + command.request_object = apigateway_set_iam_policy_request_object + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayPolicy::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayPolicy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # 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. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. + # @param [Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsRequest] apigateway_test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_project_location_api_config_iam_permissions(resource, apigateway_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsRequest::Representation + command.request_object = apigateway_test_iam_permissions_request_object + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new Gateway in a given project and location. + # @param [String] parent + # Required. Parent resource of the Gateway, of the form: `projects/*/locations/*` + # @param [Google::Apis::ApigatewayV1beta::ApigatewayGateway] apigateway_gateway_object + # @param [String] gateway_id + # Required. Identifier to assign to the Gateway. Must be unique within scope of + # the parent resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_gateway(parent, apigateway_gateway_object = nil, gateway_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta/{+parent}/gateways', options) + command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewayGateway::Representation + command.request_object = apigateway_gateway_object + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayOperation::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayOperation + command.params['parent'] = parent unless parent.nil? + command.query['gatewayId'] = gateway_id unless gateway_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a single Gateway. + # @param [String] name + # Required. Resource name of the form: `projects/*/locations/*/gateways/*` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_gateway(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayOperation::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayOperation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets details of a single Gateway. + # @param [String] name + # Required. Resource name of the form: `projects/*/locations/*/gateways/*` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayGateway] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayGateway] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_gateway(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayGateway::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayGateway + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. + # @param [Fixnum] options_requested_policy_version + # Optional. The policy format version to be returned. Valid values are 0, 1, and + # 3. Requests specifying an invalid value will be rejected. Requests for + # policies with any conditional bindings must specify version 3. Policies + # without any conditional bindings may specify any valid value or leave the + # field unset. To learn which resources support conditions in their IAM policies, + # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/ + # resource-policies). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayPolicy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayPolicy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_gateway_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayPolicy::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayPolicy + command.params['resource'] = resource unless resource.nil? + command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists Gateways in a given project and location. + # @param [String] parent + # Required. Parent resource of the Gateway, of the form: `projects/*/locations/*` + # @param [String] filter + # Filter. + # @param [String] order_by + # Order by parameters. + # @param [Fixnum] page_size + # Page size. + # @param [String] page_token + # Page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayListGatewaysResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayListGatewaysResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_gateways(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+parent}/gateways', options) + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayListGatewaysResponse::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayListGatewaysResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the parameters of a single Gateway. + # @param [String] name + # Output only. Resource name of the Gateway. Format: projects/`project`/ + # locations/`location`/gateways/`gateway` + # @param [Google::Apis::ApigatewayV1beta::ApigatewayGateway] apigateway_gateway_object + # @param [String] update_mask + # Field mask is used to specify the fields to be overwritten in the Gateway + # 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_gateway(name, apigateway_gateway_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta/{+name}', options) + command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewayGateway::Representation + command.request_object = apigateway_gateway_object + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayOperation::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayOperation + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy on the specified resource. Replaces any + # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` + # PERMISSION_DENIED` errors. + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. + # @param [Google::Apis::ApigatewayV1beta::ApigatewaySetIamPolicyRequest] apigateway_set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayPolicy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayPolicy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_project_location_gateway_iam_policy(resource, apigateway_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewaySetIamPolicyRequest::Representation + command.request_object = apigateway_set_iam_policy_request_object + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayPolicy::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayPolicy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # 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. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. + # @param [Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsRequest] apigateway_test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_project_location_gateway_iam_permissions(resource, apigateway_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsRequest::Representation + command.request_object = apigateway_test_iam_permissions_request_object + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Starts asynchronous cancellation on a long-running operation. The server makes + # a best effort to cancel the operation, but success is not guaranteed. If the + # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + # Clients can use Operations.GetOperation or other methods to check whether the + # cancellation succeeded or whether the operation completed despite cancellation. + # On successful cancellation, the operation is not deleted; instead, it becomes + # an operation with an Operation.error value with a google.rpc.Status.code of 1, + # corresponding to `Code.CANCELLED`. + # @param [String] name + # The name of the operation resource to be cancelled. + # @param [Google::Apis::ApigatewayV1beta::ApigatewayCancelOperationRequest] apigateway_cancel_operation_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def cancel_project_location_operation(name, apigateway_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta/{+name}:cancel', options) + command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewayCancelOperationRequest::Representation + command.request_object = apigateway_cancel_operation_request_object + command.response_representation = Google::Apis::ApigatewayV1beta::Empty::Representation + command.response_class = Google::Apis::ApigatewayV1beta::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a long-running operation. This method indicates that the client is no + # longer interested in the operation result. It does not cancel the operation. + # If the server doesn't support this method, it returns `google.rpc.Code. + # UNIMPLEMENTED`. + # @param [String] name + # The name of the operation resource to be deleted. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::ApigatewayV1beta::Empty::Representation + command.response_class = Google::Apis::ApigatewayV1beta::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the latest state of a long-running operation. Clients can use this method + # to poll the operation result at intervals as recommended by the API service. + # @param [String] name + # The name of the operation resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayOperation::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayOperation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists operations that match the specified filter in the request. If the server + # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` + # binding allows API services to override the binding to use different resource + # name schemes, such as `users/*/operations`. To override the binding, API + # services can add a binding such as `"/v1/`name=users/*`/operations"` to their + # service configuration. For backwards compatibility, the default name includes + # the operations collection id, however overriding users must ensure the name + # binding is the parent resource, without the operations collection id. + # @param [String] name + # The name of the operation's parent resource. + # @param [String] filter + # The standard list filter. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] page_token + # The standard list page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayListOperationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ApigatewayV1beta::ApigatewayListOperationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+name}/operations', options) + command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayListOperationsResponse::Representation + command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayListOperationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/appengine_v1.rb b/generated/google/apis/appengine_v1.rb index 11874f56f..8d0ef086b 100644 --- a/generated/google/apis/appengine_v1.rb +++ b/generated/google/apis/appengine_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1 VERSION = 'V1' - REVISION = '20200822' + REVISION = '20200903' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' diff --git a/generated/google/apis/appengine_v1/classes.rb b/generated/google/apis/appengine_v1/classes.rb index 925b51186..e95697bdd 100644 --- a/generated/google/apis/appengine_v1/classes.rb +++ b/generated/google/apis/appengine_v1/classes.rb @@ -1140,91 +1140,91 @@ module Google class Instance include Google::Apis::Core::Hashable - # App Engine release this instance is running on.@OutputOnly + # Output only. App Engine release this instance is running on. # Corresponds to the JSON property `appEngineRelease` # @return [String] attr_accessor :app_engine_release - # Availability of the instance.@OutputOnly + # Output only. Availability of the instance. # Corresponds to the JSON property `availability` # @return [String] attr_accessor :availability - # Average latency (ms) over the last minute.@OutputOnly + # Output only. Average latency (ms) over the last minute. # Corresponds to the JSON property `averageLatency` # @return [Fixnum] attr_accessor :average_latency - # Number of errors since this instance was started.@OutputOnly + # Output only. Number of errors since this instance was started. # Corresponds to the JSON property `errors` # @return [Fixnum] attr_accessor :errors - # Relative name of the instance within the version. Example: instance-1.@ - # OutputOnly + # Output only. Relative name of the instance within the version. Example: + # instance-1. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Total memory in use (bytes).@OutputOnly + # Output only. Total memory in use (bytes). # Corresponds to the JSON property `memoryUsage` # @return [Fixnum] attr_accessor :memory_usage - # Full path to the Instance resource in the API. Example: apps/myapp/services/ - # default/versions/v1/instances/instance-1.@OutputOnly + # Output only. Full path to the Instance resource in the API. Example: apps/ + # myapp/services/default/versions/v1/instances/instance-1. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Average queries per second (QPS) over the last minute.@OutputOnly + # Output only. Average queries per second (QPS) over the last minute. # Corresponds to the JSON property `qps` # @return [Float] attr_accessor :qps - # Number of requests since this instance was started.@OutputOnly + # Output only. Number of requests since this instance was started. # Corresponds to the JSON property `requests` # @return [Fixnum] attr_accessor :requests - # Time that this instance was started.@OutputOnly + # Output only. Time that this instance was started.@OutputOnly # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time - # Whether this instance is in debug mode. Only applicable for instances in App - # Engine flexible environment.@OutputOnly + # Output only. Whether this instance is in debug mode. Only applicable for + # instances in App Engine flexible environment. # Corresponds to the JSON property `vmDebugEnabled` # @return [Boolean] attr_accessor :vm_debug_enabled alias_method :vm_debug_enabled?, :vm_debug_enabled - # Virtual machine ID of this instance. Only applicable for instances in App - # Engine flexible environment.@OutputOnly + # Output only. Virtual machine ID of this instance. Only applicable for + # instances in App Engine flexible environment. # Corresponds to the JSON property `vmId` # @return [String] attr_accessor :vm_id - # The IP address of this instance. Only applicable for instances in App Engine - # flexible environment.@OutputOnly + # Output only. The IP address of this instance. Only applicable for instances in + # App Engine flexible environment. # Corresponds to the JSON property `vmIp` # @return [String] attr_accessor :vm_ip - # Name of the virtual machine where this instance lives. Only applicable for - # instances in App Engine flexible environment.@OutputOnly + # Output only. Name of the virtual machine where this instance lives. Only + # applicable for instances in App Engine flexible environment. # Corresponds to the JSON property `vmName` # @return [String] attr_accessor :vm_name - # Status of the virtual machine where this instance lives. Only applicable for - # instances in App Engine flexible environment.@OutputOnly + # Output only. Status of the virtual machine where this instance lives. Only + # applicable for instances in App Engine flexible environment. # Corresponds to the JSON property `vmStatus` # @return [String] attr_accessor :vm_status - # Zone where the virtual machine is located. Only applicable for instances in - # App Engine flexible environment.@OutputOnly + # Output only. Zone where the virtual machine is located. Only applicable for + # instances in App Engine flexible environment. # Corresponds to the JSON property `vmZoneName` # @return [String] attr_accessor :vm_zone_name @@ -1747,6 +1747,26 @@ module Google end end + # A NetworkSettings resource is a container for ingress settings for a version + # or service. + class NetworkSettings + include Google::Apis::Core::Hashable + + # The ingress settings for version or service. + # Corresponds to the JSON property `ingressTrafficAllowed` + # @return [String] + attr_accessor :ingress_traffic_allowed + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ingress_traffic_allowed = args[:ingress_traffic_allowed] if args.key?(:ingress_traffic_allowed) + end + end + # Target scaling by network usage. Only applicable in the App Engine flexible # environment. class NetworkUtilization @@ -2257,6 +2277,12 @@ module Google # @return [String] attr_accessor :name + # A NetworkSettings resource is a container for ingress settings for a version + # or service. + # Corresponds to the JSON property `networkSettings` + # @return [Google::Apis::AppengineV1::NetworkSettings] + attr_accessor :network_settings + # Traffic routing configuration for versions within a single service. Traffic # splits define how traffic directed to the service is assigned to versions. # Corresponds to the JSON property `split` @@ -2271,6 +2297,7 @@ module Google def update!(**args) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) + @network_settings = args[:network_settings] if args.key?(:network_settings) @split = args[:split] if args.key?(:split) end end diff --git a/generated/google/apis/appengine_v1/representations.rb b/generated/google/apis/appengine_v1/representations.rb index af82f5c5e..c0be9aa82 100644 --- a/generated/google/apis/appengine_v1/representations.rb +++ b/generated/google/apis/appengine_v1/representations.rb @@ -298,6 +298,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class NetworkSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class NetworkUtilization class Representation < Google::Apis::Core::JsonRepresentation; end @@ -896,6 +902,13 @@ module Google end end + class NetworkSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :ingress_traffic_allowed, as: 'ingressTrafficAllowed' + end + end + class NetworkUtilization # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1023,6 +1036,8 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :name, as: 'name' + property :network_settings, as: 'networkSettings', class: Google::Apis::AppengineV1::NetworkSettings, decorator: Google::Apis::AppengineV1::NetworkSettings::Representation + property :split, as: 'split', class: Google::Apis::AppengineV1::TrafficSplit, decorator: Google::Apis::AppengineV1::TrafficSplit::Representation end diff --git a/generated/google/apis/appengine_v1beta.rb b/generated/google/apis/appengine_v1beta.rb index d77403210..ba3bd04d2 100644 --- a/generated/google/apis/appengine_v1beta.rb +++ b/generated/google/apis/appengine_v1beta.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1beta VERSION = 'V1beta' - REVISION = '20200822' + REVISION = '20200903' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' diff --git a/generated/google/apis/appengine_v1beta/classes.rb b/generated/google/apis/appengine_v1beta/classes.rb index 6a6559e3d..1984447ea 100644 --- a/generated/google/apis/appengine_v1beta/classes.rb +++ b/generated/google/apis/appengine_v1beta/classes.rb @@ -1219,91 +1219,97 @@ module Google class Instance include Google::Apis::Core::Hashable - # App Engine release this instance is running on.@OutputOnly + # Output only. App Engine release this instance is running on. # Corresponds to the JSON property `appEngineRelease` # @return [String] attr_accessor :app_engine_release - # Availability of the instance.@OutputOnly + # Output only. Availability of the instance. # Corresponds to the JSON property `availability` # @return [String] attr_accessor :availability - # Average latency (ms) over the last minute.@OutputOnly + # Output only. Average latency (ms) over the last minute. # Corresponds to the JSON property `averageLatency` # @return [Fixnum] attr_accessor :average_latency - # Number of errors since this instance was started.@OutputOnly + # Output only. Number of errors since this instance was started. # Corresponds to the JSON property `errors` # @return [Fixnum] attr_accessor :errors - # Relative name of the instance within the version. Example: instance-1.@ - # OutputOnly + # Output only. Relative name of the instance within the version. Example: + # instance-1. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Total memory in use (bytes).@OutputOnly + # Output only. Total memory in use (bytes). # Corresponds to the JSON property `memoryUsage` # @return [Fixnum] attr_accessor :memory_usage - # Full path to the Instance resource in the API. Example: apps/myapp/services/ - # default/versions/v1/instances/instance-1.@OutputOnly + # Output only. Full path to the Instance resource in the API. Example: apps/ + # myapp/services/default/versions/v1/instances/instance-1. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Average queries per second (QPS) over the last minute.@OutputOnly + # Output only. Average queries per second (QPS) over the last minute. # Corresponds to the JSON property `qps` # @return [Float] attr_accessor :qps - # Number of requests since this instance was started.@OutputOnly + # Output only. Number of requests since this instance was started. # Corresponds to the JSON property `requests` # @return [Fixnum] attr_accessor :requests - # Time that this instance was started.@OutputOnly + # Output only. Time that this instance was started.@OutputOnly # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time - # Whether this instance is in debug mode. Only applicable for instances in App - # Engine flexible environment.@OutputOnly + # Output only. Whether this instance is in debug mode. Only applicable for + # instances in App Engine flexible environment. # Corresponds to the JSON property `vmDebugEnabled` # @return [Boolean] attr_accessor :vm_debug_enabled alias_method :vm_debug_enabled?, :vm_debug_enabled - # Virtual machine ID of this instance. Only applicable for instances in App - # Engine flexible environment.@OutputOnly + # Output only. Virtual machine ID of this instance. Only applicable for + # instances in App Engine flexible environment. # Corresponds to the JSON property `vmId` # @return [String] attr_accessor :vm_id - # The IP address of this instance. Only applicable for instances in App Engine - # flexible environment.@OutputOnly + # Output only. The IP address of this instance. Only applicable for instances in + # App Engine flexible environment. # Corresponds to the JSON property `vmIp` # @return [String] attr_accessor :vm_ip - # Name of the virtual machine where this instance lives. Only applicable for - # instances in App Engine flexible environment.@OutputOnly + # Output only. The liveness health check of this instance. Only applicable for + # instances in App Engine flexible environment. + # Corresponds to the JSON property `vmLiveness` + # @return [String] + attr_accessor :vm_liveness + + # Output only. Name of the virtual machine where this instance lives. Only + # applicable for instances in App Engine flexible environment. # Corresponds to the JSON property `vmName` # @return [String] attr_accessor :vm_name - # Status of the virtual machine where this instance lives. Only applicable for - # instances in App Engine flexible environment.@OutputOnly + # Output only. Status of the virtual machine where this instance lives. Only + # applicable for instances in App Engine flexible environment. # Corresponds to the JSON property `vmStatus` # @return [String] attr_accessor :vm_status - # Zone where the virtual machine is located. Only applicable for instances in - # App Engine flexible environment.@OutputOnly + # Output only. Zone where the virtual machine is located. Only applicable for + # instances in App Engine flexible environment. # Corresponds to the JSON property `vmZoneName` # @return [String] attr_accessor :vm_zone_name @@ -1327,6 +1333,7 @@ module Google @vm_debug_enabled = args[:vm_debug_enabled] if args.key?(:vm_debug_enabled) @vm_id = args[:vm_id] if args.key?(:vm_id) @vm_ip = args[:vm_ip] if args.key?(:vm_ip) + @vm_liveness = args[:vm_liveness] if args.key?(:vm_liveness) @vm_name = args[:vm_name] if args.key?(:vm_name) @vm_status = args[:vm_status] if args.key?(:vm_status) @vm_zone_name = args[:vm_zone_name] if args.key?(:vm_zone_name) @@ -1826,6 +1833,26 @@ module Google end end + # A NetworkSettings resource is a container for ingress settings for a version + # or service. + class NetworkSettings + include Google::Apis::Core::Hashable + + # The ingress settings for version or service. + # Corresponds to the JSON property `ingressTrafficAllowed` + # @return [String] + attr_accessor :ingress_traffic_allowed + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ingress_traffic_allowed = args[:ingress_traffic_allowed] if args.key?(:ingress_traffic_allowed) + end + end + # Target scaling by network usage. Only applicable in the App Engine flexible # environment. class NetworkUtilization @@ -2336,6 +2363,12 @@ module Google # @return [String] attr_accessor :name + # A NetworkSettings resource is a container for ingress settings for a version + # or service. + # Corresponds to the JSON property `networkSettings` + # @return [Google::Apis::AppengineV1beta::NetworkSettings] + attr_accessor :network_settings + # Traffic routing configuration for versions within a single service. Traffic # splits define how traffic directed to the service is assigned to versions. # Corresponds to the JSON property `split` @@ -2350,6 +2383,7 @@ module Google def update!(**args) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) + @network_settings = args[:network_settings] if args.key?(:network_settings) @split = args[:split] if args.key?(:split) end end diff --git a/generated/google/apis/appengine_v1beta/representations.rb b/generated/google/apis/appengine_v1beta/representations.rb index 200c74859..6a176c3c9 100644 --- a/generated/google/apis/appengine_v1beta/representations.rb +++ b/generated/google/apis/appengine_v1beta/representations.rb @@ -310,6 +310,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class NetworkSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class NetworkUtilization class Representation < Google::Apis::Core::JsonRepresentation; end @@ -777,6 +783,7 @@ module Google property :vm_debug_enabled, as: 'vmDebugEnabled' property :vm_id, as: 'vmId' property :vm_ip, as: 'vmIp' + property :vm_liveness, as: 'vmLiveness' property :vm_name, as: 'vmName' property :vm_status, as: 'vmStatus' property :vm_zone_name, as: 'vmZoneName' @@ -930,6 +937,13 @@ module Google end end + class NetworkSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :ingress_traffic_allowed, as: 'ingressTrafficAllowed' + end + end + class NetworkUtilization # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1057,6 +1071,8 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' property :name, as: 'name' + property :network_settings, as: 'networkSettings', class: Google::Apis::AppengineV1beta::NetworkSettings, decorator: Google::Apis::AppengineV1beta::NetworkSettings::Representation + property :split, as: 'split', class: Google::Apis::AppengineV1beta::TrafficSplit, decorator: Google::Apis::AppengineV1beta::TrafficSplit::Representation end diff --git a/generated/google/apis/bigquery_v2.rb b/generated/google/apis/bigquery_v2.rb index a5a9c9eac..17c1374ce 100644 --- a/generated/google/apis/bigquery_v2.rb +++ b/generated/google/apis/bigquery_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigquery/ module BigqueryV2 VERSION = 'V2' - REVISION = '20200818' + REVISION = '20200827' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/bigquery_v2/classes.rb b/generated/google/apis/bigquery_v2/classes.rb index ff68b6d4f..5fe876e9a 100644 --- a/generated/google/apis/bigquery_v2/classes.rb +++ b/generated/google/apis/bigquery_v2/classes.rb @@ -3583,6 +3583,12 @@ module Google # @return [Fixnum] attr_accessor :total_slot_ms + # [Output-only] [Alpha] Information of the multi-statement transaction if this + # job is part of one. + # Corresponds to the JSON property `transactionInfoTemplate` + # @return [Google::Apis::BigqueryV2::TransactionInfo] + attr_accessor :transaction_info_template + def initialize(**args) update!(**args) end @@ -3605,6 +3611,7 @@ module Google @start_time = args[:start_time] if args.key?(:start_time) @total_bytes_processed = args[:total_bytes_processed] if args.key?(:total_bytes_processed) @total_slot_ms = args[:total_slot_ms] if args.key?(:total_slot_ms) + @transaction_info_template = args[:transaction_info_template] if args.key?(:transaction_info_template) end # @@ -6750,6 +6757,25 @@ module Google end end + # + class TransactionInfo + include Google::Apis::Core::Hashable + + # [Output-only] // [Alpha] Id of the transaction. + # Corresponds to the JSON property `transactionId` + # @return [String] + attr_accessor :transaction_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @transaction_id = args[:transaction_id] if args.key?(:transaction_id) + end + end + # This is used for defining User Defined Function (UDF) resources only when # using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. # CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. diff --git a/generated/google/apis/bigquery_v2/representations.rb b/generated/google/apis/bigquery_v2/representations.rb index fb9b8518e..283cc5990 100644 --- a/generated/google/apis/bigquery_v2/representations.rb +++ b/generated/google/apis/bigquery_v2/representations.rb @@ -790,6 +790,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class TransactionInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class UserDefinedFunctionResource class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1643,6 +1649,8 @@ module Google property :start_time, :numeric_string => true, as: 'startTime' property :total_bytes_processed, :numeric_string => true, as: 'totalBytesProcessed' property :total_slot_ms, :numeric_string => true, as: 'totalSlotMs' + property :transaction_info_template, as: 'transactionInfoTemplate', class: Google::Apis::BigqueryV2::TransactionInfo, decorator: Google::Apis::BigqueryV2::TransactionInfo::Representation + end class ReservationUsage @@ -2437,6 +2445,13 @@ module Google end end + class TransactionInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :transaction_id, as: 'transactionId' + end + end + class UserDefinedFunctionResource # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/bigtableadmin_v1.rb b/generated/google/apis/bigtableadmin_v1.rb index 423c2082d..777e09c07 100644 --- a/generated/google/apis/bigtableadmin_v1.rb +++ b/generated/google/apis/bigtableadmin_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigtable/ module BigtableadminV1 VERSION = 'V1' - REVISION = '20200817' + REVISION = '20200821' end end end diff --git a/generated/google/apis/bigtableadmin_v1/classes.rb b/generated/google/apis/bigtableadmin_v1/classes.rb index 25738aa1f..3aab240fb 100644 --- a/generated/google/apis/bigtableadmin_v1/classes.rb +++ b/generated/google/apis/bigtableadmin_v1/classes.rb @@ -26,30 +26,26 @@ module Google class Backup include Google::Apis::Core::Hashable - # Output only. `end_time` is the time that the backup was finished. The row - # data in the backup will be no newer than this timestamp. + # Output only. `end_time` is the time that the backup was finished. The row data + # in the backup will be no newer than this timestamp. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Required. The expiration time of the backup, with microseconds - # granularity that must be at least 6 hours and at most 30 days - # from the time the request is received. Once the `expire_time` - # has passed, Cloud Bigtable will delete the backup and free the - # resources used by the backup. + # Required. The expiration time of the backup, with microseconds granularity + # that must be at least 6 hours and at most 30 days from the time the request is + # received. Once the `expire_time` has passed, Cloud Bigtable will delete the + # backup and free the resources used by the backup. # Corresponds to the JSON property `expireTime` # @return [String] attr_accessor :expire_time - # A globally unique identifier for the backup which cannot be - # changed. Values are of the form - # `projects/`project`/instances/`instance`/clusters/`cluster`/ - # backups/_a-zA-Z0-9*` - # The final segment of the name must be between 1 and 50 characters - # in length. - # The backup is stored in the cluster identified by the prefix of the backup - # name of the form - # `projects/`project`/instances/`instance`/clusters/`cluster``. + # A globally unique identifier for the backup which cannot be changed. Values + # are of the form `projects/`project`/instances/`instance`/clusters/`cluster`/ + # backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 + # characters in length. The backup is stored in the cluster identified by the + # prefix of the backup name of the form `projects/`project`/instances/`instance`/ + # clusters/`cluster``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -60,17 +56,15 @@ module Google attr_accessor :size_bytes # Required. Immutable. Name of the table from which this backup was created. - # This needs - # to be in the same instance as the backup. Values are of the form - # `projects/`project`/instances/`instance`/tables/`source_table``. + # This needs to be in the same instance as the backup. Values are of the form ` + # projects/`project`/instances/`instance`/tables/`source_table``. # Corresponds to the JSON property `sourceTable` # @return [String] attr_accessor :source_table - # Output only. `start_time` is the time that the backup was started - # (i.e. approximately the time the - # CreateBackup request is received). The - # row data in this backup will be no older than this timestamp. + # Output only. `start_time` is the time that the backup was started (i.e. + # approximately the time the CreateBackup request is received). The row data in + # this backup will be no older than this timestamp. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -105,8 +99,8 @@ module Google # @return [String] attr_accessor :backup - # Output only. This time that the backup was finished. Row data in the - # backup will be no newer than this timestamp. + # Output only. This time that the backup was finished. Row data in the backup + # will be no newer than this timestamp. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time @@ -116,8 +110,8 @@ module Google # @return [String] attr_accessor :source_table - # Output only. The time that the backup was started. Row data in the backup - # will be no older than this timestamp. + # Output only. The time that the backup was started. Row data in the backup will + # be no older than this timestamp. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -135,36 +129,33 @@ module Google end end - # A resizable group of nodes in a particular cloud location, capable - # of serving all Tables in the parent - # Instance. + # A resizable group of nodes in a particular cloud location, capable of serving + # all Tables in the parent Instance. class Cluster include Google::Apis::Core::Hashable - # Immutable. The type of storage used by this cluster to serve its - # parent instance's tables, unless explicitly overridden. + # Immutable. The type of storage used by this cluster to serve its parent + # instance's tables, unless explicitly overridden. # Corresponds to the JSON property `defaultStorageType` # @return [String] attr_accessor :default_storage_type # Immutable. The location where this cluster's nodes and storage reside. For - # best - # performance, clients should be located as close as possible to this - # cluster. Currently only zones are supported, so values should be of the - # form `projects/`project`/locations/`zone``. + # best performance, clients should be located as close as possible to this + # cluster. Currently only zones are supported, so values should be of the form ` + # projects/`project`/locations/`zone``. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location - # The unique name of the cluster. Values are of the form - # `projects/`project`/instances/`instance`/clusters/a-z*`. + # The unique name of the cluster. Values are of the form `projects/`project`/ + # instances/`instance`/clusters/a-z*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Required. The number of nodes allocated to this cluster. More nodes enable - # higher - # throughput and more consistent performance. + # higher throughput and more consistent performance. # Corresponds to the JSON property `serveNodes` # @return [Fixnum] attr_accessor :serve_nodes @@ -188,8 +179,7 @@ module Google end end - # Metadata type for the operation returned by - # CreateBackup. + # Metadata type for the operation returned by CreateBackup. class CreateBackupMetadata include Google::Apis::Core::Hashable @@ -246,12 +236,10 @@ module Google attr_accessor :request_time # Keys: the full `name` of each table that existed in the instance when - # CreateCluster was first called, i.e. - # `projects//instances//tables/`. Any table added - # to the instance by a later API call will be created in the new cluster by - # that API call, not this one. - # Values: information on how much of a table's data has been copied to the - # newly-created cluster so far. + # CreateCluster was first called, i.e. `projects//instances//tables/`. Any table + # added to the instance by a later API call will be created in the new cluster + # by that API call, not this one. Values: information on how much of a table's + # data has been copied to the newly-created cluster so far. # Corresponds to the JSON property `tables` # @return [Hash] attr_accessor :tables @@ -273,24 +261,21 @@ module Google class CreateClusterRequest include Google::Apis::Core::Hashable - # A resizable group of nodes in a particular cloud location, capable - # of serving all Tables in the parent - # Instance. + # A resizable group of nodes in a particular cloud location, capable of serving + # all Tables in the parent Instance. # Corresponds to the JSON property `cluster` # @return [Google::Apis::BigtableadminV1::Cluster] attr_accessor :cluster # Required. The ID to be used when referring to the new cluster within its - # instance, - # e.g., just `mycluster` rather than - # `projects/myproject/instances/myinstance/clusters/mycluster`. + # instance, e.g., just `mycluster` rather than `projects/myproject/instances/ + # myinstance/clusters/mycluster`. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # Required. The unique name of the instance in which to create the new cluster. - # Values are of the form - # `projects/`project`/instances/`instance``. + # Values are of the form `projects/`project`/instances/`instance``. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -343,26 +328,22 @@ module Google include Google::Apis::Core::Hashable # Required. The clusters to be created within the instance, mapped by desired - # cluster ID, e.g., just `mycluster` rather than - # `projects/myproject/instances/myinstance/clusters/mycluster`. - # Fields marked `OutputOnly` must be left blank. + # cluster ID, e.g., just `mycluster` rather than `projects/myproject/instances/ + # myinstance/clusters/mycluster`. Fields marked `OutputOnly` must be left blank. # Currently, at most four clusters can be specified. # Corresponds to the JSON property `clusters` # @return [Hash] attr_accessor :clusters - # A collection of Bigtable Tables and - # the resources that serve them. - # All tables in an instance are served from all - # Clusters in the instance. + # A collection of Bigtable Tables and the resources that serve them. All tables + # in an instance are served from all Clusters in the instance. # Corresponds to the JSON property `instance` # @return [Google::Apis::BigtableadminV1::Instance] attr_accessor :instance # Required. The ID to be used when referring to the new instance within its - # project, - # e.g., just `myinstance` rather than - # `projects/myproject/instances/myinstance`. + # project, e.g., just `myinstance` rather than `projects/myproject/instances/ + # myinstance`. # Corresponds to the JSON property `instanceId` # @return [String] attr_accessor :instance_id @@ -436,16 +417,13 @@ module Google end end - # A collection of Bigtable Tables and - # the resources that serve them. - # All tables in an instance are served from all - # Clusters in the instance. + # A collection of Bigtable Tables and the resources that serve them. All tables + # in an instance are served from all Clusters in the instance. class Instance include Google::Apis::Core::Hashable - # Required. The descriptive name for this instance as it appears in UIs. - # Can be changed at any time, but should be kept globally unique - # to avoid confusion. + # Required. The descriptive name for this instance as it appears in UIs. Can be + # changed at any time, but should be kept globally unique to avoid confusion. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -453,19 +431,17 @@ module Google # Required. Labels are a flexible and lightweight mechanism for organizing cloud # resources into groups that reflect a customer's organizational needs and # deployment strategies. They can be used to filter resources and aggregate - # metrics. - # * Label keys must be between 1 and 63 characters long and must conform to - # the regular expression: `\p`Ll`\p`Lo``0,62``. - # * Label values must be between 0 and 63 characters long and must conform to - # the regular expression: `[\p`Ll`\p`Lo`\p`N`_-]`0,63``. - # * No more than 64 labels can be associated with a given resource. - # * Keys and values must both be under 128 bytes. + # metrics. * Label keys must be between 1 and 63 characters long and must + # conform to the regular expression: `\p`Ll`\p`Lo``0,62``. * Label values must + # be between 0 and 63 characters long and must conform to the regular expression: + # `[\p`Ll`\p`Lo`\p`N`_-]`0,63``. * No more than 64 labels can be associated + # with a given resource. * Keys and values must both be under 128 bytes. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # The unique name of the instance. Values are of the form - # `projects/`project`/instances/a-z+[a-z0-9]`. + # The unique name of the instance. Values are of the form `projects/`project`/ + # instances/a-z+[a-z0-9]`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -494,19 +470,17 @@ module Google end end - # Encapsulates progress related information for a Cloud Bigtable long - # running operation. + # Encapsulates progress related information for a Cloud Bigtable long running + # operation. class OperationProgress include Google::Apis::Core::Hashable - # If set, the time at which this operation failed or was completed - # successfully. + # If set, the time at which this operation failed or was completed successfully. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Percent completion of the operation. - # Values are between 0 and 100 inclusive. + # Percent completion of the operation. Values are between 0 and 100 inclusive. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -528,10 +502,10 @@ module Google end end - # Metadata type for the long-running operation used to track the progress - # of optimizations performed on a newly restored table. This long-running - # operation is automatically created by the system after the successful - # completion of a table restore, and cannot be cancelled. + # Metadata type for the long-running operation used to track the progress of + # optimizations performed on a newly restored table. This long-running operation + # is automatically created by the system after the successful completion of a + # table restore, and cannot be cancelled. class OptimizeRestoredTableMetadata include Google::Apis::Core::Hashable @@ -540,8 +514,8 @@ module Google # @return [String] attr_accessor :name - # Encapsulates progress related information for a Cloud Bigtable long - # running operation. + # Encapsulates progress related information for a Cloud Bigtable long running + # operation. # Corresponds to the JSON property `progress` # @return [Google::Apis::BigtableadminV1::OperationProgress] attr_accessor :progress @@ -561,16 +535,14 @@ module Google class PartialUpdateInstanceRequest include Google::Apis::Core::Hashable - # A collection of Bigtable Tables and - # the resources that serve them. - # All tables in an instance are served from all - # Clusters in the instance. + # A collection of Bigtable Tables and the resources that serve them. All tables + # in an instance are served from all Clusters in the instance. # Corresponds to the JSON property `instance` # @return [Google::Apis::BigtableadminV1::Instance] attr_accessor :instance - # Required. The subset of Instance fields which should be replaced. - # Must be explicitly set. + # Required. The subset of Instance fields which should be replaced. Must be + # explicitly set. # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask @@ -586,8 +558,7 @@ module Google end end - # Metadata type for the long-running operation returned by - # RestoreTable. + # Metadata type for the long-running operation returned by RestoreTable. class RestoreTableMetadata include Google::Apis::Core::Hashable @@ -601,21 +572,20 @@ module Google # @return [String] attr_accessor :name - # If exists, the name of the long-running operation that will be used to - # track the post-restore optimization process to optimize the performance of - # the restored table. The metadata type of the long-running operation is - # OptimizeRestoreTableMetadata. The response type is - # Empty. This long-running operation may be - # automatically created by the system if applicable after the - # RestoreTable long-running operation completes successfully. This operation - # may not be created if the table is already optimized or the restore was - # not successful. + # If exists, the name of the long-running operation that will be used to track + # the post-restore optimization process to optimize the performance of the + # restored table. The metadata type of the long-running operation is + # OptimizeRestoreTableMetadata. The response type is Empty. This long-running + # operation may be automatically created by the system if applicable after the + # RestoreTable long-running operation completes successfully. This operation may + # not be created if the table is already optimized or the restore was not + # successful. # Corresponds to the JSON property `optimizeTableOperationName` # @return [String] attr_accessor :optimize_table_operation_name - # Encapsulates progress related information for a Cloud Bigtable long - # running operation. + # Encapsulates progress related information for a Cloud Bigtable long running + # operation. # Corresponds to the JSON property `progress` # @return [Google::Apis::BigtableadminV1::OperationProgress] attr_accessor :progress @@ -643,9 +613,8 @@ module Google class TableProgress include Google::Apis::Core::Hashable - # Estimate of the number of bytes copied so far for this table. - # This will eventually reach 'estimated_size_bytes' unless the table copy - # is CANCELLED. + # Estimate of the number of bytes copied so far for this table. This will + # eventually reach 'estimated_size_bytes' unless the table copy is CANCELLED. # Corresponds to the JSON property `estimatedCopiedBytes` # @return [Fixnum] attr_accessor :estimated_copied_bytes @@ -694,9 +663,8 @@ module Google # @return [String] attr_accessor :finish_time - # A resizable group of nodes in a particular cloud location, capable - # of serving all Tables in the parent - # Instance. + # A resizable group of nodes in a particular cloud location, capable of serving + # all Tables in the parent Instance. # Corresponds to the JSON property `originalRequest` # @return [Google::Apis::BigtableadminV1::Cluster] attr_accessor :original_request diff --git a/generated/google/apis/bigtableadmin_v2.rb b/generated/google/apis/bigtableadmin_v2.rb index 6858d752e..bb72656b9 100644 --- a/generated/google/apis/bigtableadmin_v2.rb +++ b/generated/google/apis/bigtableadmin_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigtable/ module BigtableadminV2 VERSION = 'V2' - REVISION = '20200817' + REVISION = '20200821' # Administer your Cloud Bigtable tables and clusters AUTH_BIGTABLE_ADMIN = 'https://www.googleapis.com/auth/bigtable.admin' diff --git a/generated/google/apis/bigtableadmin_v2/classes.rb b/generated/google/apis/bigtableadmin_v2/classes.rb index 866699f5d..ef43b7917 100644 --- a/generated/google/apis/bigtableadmin_v2/classes.rb +++ b/generated/google/apis/bigtableadmin_v2/classes.rb @@ -22,8 +22,8 @@ module Google module Apis module BigtableadminV2 - # A configuration object describing how Cloud Bigtable should treat traffic - # from a particular end user application. + # A configuration object describing how Cloud Bigtable should treat traffic from + # a particular end user application. class AppProfile include Google::Apis::Core::Hashable @@ -32,35 +32,33 @@ module Google # @return [String] attr_accessor :description - # Strongly validated etag for optimistic concurrency control. Preserve the - # value returned from `GetAppProfile` when calling `UpdateAppProfile` to - # fail the request if there has been a modification in the mean time. The - # `update_mask` of the request need not include `etag` for this protection - # to apply. - # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and - # [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more - # details. + # Strongly validated etag for optimistic concurrency control. Preserve the value + # returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the + # request if there has been a modification in the mean time. The `update_mask` + # of the request need not include `etag` for this protection to apply. See [ + # Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https:// + # tools.ietf.org/html/rfc7232#section-2.3) for more details. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Read/write requests are routed to the nearest cluster in the instance, and # will fail over to the nearest cluster that is available in the event of - # transient errors or delays. Clusters in a region are considered - # equidistant. Choosing this option sacrifices read-your-writes consistency - # to improve availability. + # transient errors or delays. Clusters in a region are considered equidistant. + # Choosing this option sacrifices read-your-writes consistency to improve + # availability. # Corresponds to the JSON property `multiClusterRoutingUseAny` # @return [Google::Apis::BigtableadminV2::MultiClusterRoutingUseAny] attr_accessor :multi_cluster_routing_use_any - # The unique name of the app profile. Values are of the form - # `projects/`project`/instances/`instance`/appProfiles/_a-zA-Z0-9*`. + # The unique name of the app profile. Values are of the form `projects/`project`/ + # instances/`instance`/appProfiles/_a-zA-Z0-9*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Unconditionally routes all read/write requests to a specific cluster. - # This option preserves read-your-writes consistency but does not improve + # Unconditionally routes all read/write requests to a specific cluster. This + # option preserves read-your-writes consistency but does not improve # availability. # Corresponds to the JSON property `singleClusterRouting` # @return [Google::Apis::BigtableadminV2::SingleClusterRouting] @@ -80,53 +78,21 @@ module Google end end - # 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. + # 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. class AuditConfig include Google::Apis::Core::Hashable @@ -135,9 +101,9 @@ module Google # @return [Array] attr_accessor :audit_log_configs - # 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. + # 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. # Corresponds to the JSON property `service` # @return [String] attr_accessor :service @@ -153,28 +119,15 @@ module Google end end - # 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. + # 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. class AuditLogConfig include Google::Apis::Core::Hashable - # Specifies the identities that do not cause logging for this type of - # permission. + # Specifies the identities that do not cause logging for this type of permission. # Follows the same format of Binding.members. # Corresponds to the JSON property `exemptedMembers` # @return [Array] @@ -200,30 +153,26 @@ module Google class Backup include Google::Apis::Core::Hashable - # Output only. `end_time` is the time that the backup was finished. The row - # data in the backup will be no newer than this timestamp. + # Output only. `end_time` is the time that the backup was finished. The row data + # in the backup will be no newer than this timestamp. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Required. The expiration time of the backup, with microseconds - # granularity that must be at least 6 hours and at most 30 days - # from the time the request is received. Once the `expire_time` - # has passed, Cloud Bigtable will delete the backup and free the - # resources used by the backup. + # Required. The expiration time of the backup, with microseconds granularity + # that must be at least 6 hours and at most 30 days from the time the request is + # received. Once the `expire_time` has passed, Cloud Bigtable will delete the + # backup and free the resources used by the backup. # Corresponds to the JSON property `expireTime` # @return [String] attr_accessor :expire_time - # A globally unique identifier for the backup which cannot be - # changed. Values are of the form - # `projects/`project`/instances/`instance`/clusters/`cluster`/ - # backups/_a-zA-Z0-9*` - # The final segment of the name must be between 1 and 50 characters - # in length. - # The backup is stored in the cluster identified by the prefix of the backup - # name of the form - # `projects/`project`/instances/`instance`/clusters/`cluster``. + # A globally unique identifier for the backup which cannot be changed. Values + # are of the form `projects/`project`/instances/`instance`/clusters/`cluster`/ + # backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 + # characters in length. The backup is stored in the cluster identified by the + # prefix of the backup name of the form `projects/`project`/instances/`instance`/ + # clusters/`cluster``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -234,17 +183,15 @@ module Google attr_accessor :size_bytes # Required. Immutable. Name of the table from which this backup was created. - # This needs - # to be in the same instance as the backup. Values are of the form - # `projects/`project`/instances/`instance`/tables/`source_table``. + # This needs to be in the same instance as the backup. Values are of the form ` + # projects/`project`/instances/`instance`/tables/`source_table``. # Corresponds to the JSON property `sourceTable` # @return [String] attr_accessor :source_table - # Output only. `start_time` is the time that the backup was started - # (i.e. approximately the time the - # CreateBackup request is received). The - # row data in this backup will be no older than this timestamp. + # Output only. `start_time` is the time that the backup was started (i.e. + # approximately the time the CreateBackup request is received). The row data in + # this backup will be no older than this timestamp. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -279,8 +226,8 @@ module Google # @return [String] attr_accessor :backup - # Output only. This time that the backup was finished. Row data in the - # backup will be no newer than this timestamp. + # Output only. This time that the backup was finished. Row data in the backup + # will be no newer than this timestamp. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time @@ -290,8 +237,8 @@ module Google # @return [String] attr_accessor :source_table - # Output only. The time that the backup was started. Row data in the backup - # will be no older than this timestamp. + # Output only. The time that the backup was started. Row data in the backup will + # be no older than this timestamp. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -313,69 +260,57 @@ module Google class Binding include Google::Apis::Core::Hashable - # Represents a textual expression in the Common Expression Language (CEL) - # syntax. CEL is a C-like expression language. The syntax and semantics of CEL - # are documented at https://github.com/google/cel-spec. - # Example (Comparison): - # title: "Summary size limit" - # description: "Determines if a summary is less than 100 chars" - # expression: "document.summary.size() < 100" - # Example (Equality): - # title: "Requestor is owner" - # description: "Determines if requestor is the document owner" - # expression: "document.owner == request.auth.claims.email" - # Example (Logic): - # title: "Public documents" - # description: "Determine whether the document should be publicly visible" - # expression: "document.type != 'private' && document.type != 'internal'" - # Example (Data Manipulation): - # title: "Notification string" - # description: "Create a notification string with a timestamp." - # expression: "'New message received at ' + string(document.create_time)" - # The exact variables and functions that may be referenced within an expression - # are determined by the service that evaluates it. See the service - # documentation for additional information. + # Represents a textual expression in the Common Expression Language (CEL) syntax. + # CEL is a C-like expression language. The syntax and semantics of CEL are + # documented at https://github.com/google/cel-spec. Example (Comparison): title: + # "Summary size limit" description: "Determines if a summary is less than 100 + # chars" expression: "document.summary.size() < 100" Example (Equality): title: " + # Requestor is owner" description: "Determines if requestor is the document + # owner" expression: "document.owner == request.auth.claims.email" Example ( + # Logic): title: "Public documents" description: "Determine whether the document + # should be publicly visible" expression: "document.type != 'private' && + # document.type != 'internal'" Example (Data Manipulation): title: "Notification + # string" description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" The + # exact variables and functions that may be referenced within an expression are + # determined by the service that evaluates it. See the service documentation for + # additional information. # Corresponds to the JSON property `condition` # @return [Google::Apis::BigtableadminV2::Expr] attr_accessor :condition - # Specifies the identities requesting access for a Cloud Platform resource. - # `members` can have the following values: - # * `allUsers`: A special identifier that represents anyone who is - # on the internet; with or without a Google account. - # * `allAuthenticatedUsers`: A special identifier that represents anyone - # who is authenticated with a Google account or a service account. - # * `user:`emailid``: An email address that represents a specific Google - # account. For example, `alice@example.com` . - # * `serviceAccount:`emailid``: An email address that represents a service - # account. For example, `my-other-app@appspot.gserviceaccount.com`. - # * `group:`emailid``: An email address that represents a Google group. - # For example, `admins@example.com`. - # * `deleted:user:`emailid`?uid=`uniqueid``: An email address (plus unique - # identifier) representing a user that has been recently deleted. For - # example, `alice@example.com?uid=123456789012345678901`. If the user is - # recovered, this value reverts to `user:`emailid`` and the recovered user - # retains the role in the binding. - # * `deleted:serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus - # unique identifier) representing a service account that has been recently - # deleted. For example, - # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - # If the service account is undeleted, this value reverts to - # `serviceAccount:`emailid`` and the undeleted service account retains the - # role in the binding. - # * `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique - # identifier) representing a Google group that has been recently - # deleted. For example, `admins@example.com?uid=123456789012345678901`. If - # the group is recovered, this value reverts to `group:`emailid`` and the - # recovered group retains the role in the binding. - # * `domain:`domain``: The G Suite domain (primary) that represents all the - # users of that domain. For example, `google.com` or `example.com`. + # Specifies the identities requesting access for a Cloud Platform resource. ` + # members` can have the following values: * `allUsers`: A special identifier + # that represents anyone who is on the internet; with or without a Google + # account. * `allAuthenticatedUsers`: A special identifier that represents + # anyone who is authenticated with a Google account or a service account. * ` + # user:`emailid``: An email address that represents a specific Google account. + # For example, `alice@example.com` . * `serviceAccount:`emailid``: An email + # address that represents a service account. For example, `my-other-app@appspot. + # gserviceaccount.com`. * `group:`emailid``: An email address that represents a + # Google group. For example, `admins@example.com`. * `deleted:user:`emailid`?uid= + # `uniqueid``: An email address (plus unique identifier) representing a user + # that has been recently deleted. For example, `alice@example.com?uid= + # 123456789012345678901`. If the user is recovered, this value reverts to `user:` + # emailid`` and the recovered user retains the role in the binding. * `deleted: + # serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus unique + # identifier) representing a service account that has been recently deleted. For + # example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + # If the service account is undeleted, this value reverts to `serviceAccount:` + # emailid`` and the undeleted service account retains the role in the binding. * + # `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique + # identifier) representing a Google group that has been recently deleted. For + # example, `admins@example.com?uid=123456789012345678901`. If the group is + # recovered, this value reverts to `group:`emailid`` and the recovered group + # retains the role in the binding. * `domain:`domain``: The G Suite domain ( + # primary) that represents all the users of that domain. For example, `google. + # com` or `example.com`. # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members - # Role that is assigned to `members`. - # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor` + # , or `roles/owner`. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role @@ -392,8 +327,8 @@ module Google end end - # Request message for - # google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency + # Request message for google.bigtable.admin.v2.BigtableTableAdmin. + # CheckConsistency class CheckConsistencyRequest include Google::Apis::Core::Hashable @@ -412,13 +347,13 @@ module Google end end - # Response message for - # google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency + # Response message for google.bigtable.admin.v2.BigtableTableAdmin. + # CheckConsistency class CheckConsistencyResponse include Google::Apis::Core::Hashable - # True only if the token is consistent. A token is consistent if replication - # has caught up with the restrictions specified in the request. + # True only if the token is consistent. A token is consistent if replication has + # caught up with the restrictions specified in the request. # Corresponds to the JSON property `consistent` # @return [Boolean] attr_accessor :consistent @@ -434,36 +369,33 @@ module Google end end - # A resizable group of nodes in a particular cloud location, capable - # of serving all Tables in the parent - # Instance. + # A resizable group of nodes in a particular cloud location, capable of serving + # all Tables in the parent Instance. class Cluster include Google::Apis::Core::Hashable - # Immutable. The type of storage used by this cluster to serve its - # parent instance's tables, unless explicitly overridden. + # Immutable. The type of storage used by this cluster to serve its parent + # instance's tables, unless explicitly overridden. # Corresponds to the JSON property `defaultStorageType` # @return [String] attr_accessor :default_storage_type # Immutable. The location where this cluster's nodes and storage reside. For - # best - # performance, clients should be located as close as possible to this - # cluster. Currently only zones are supported, so values should be of the - # form `projects/`project`/locations/`zone``. + # best performance, clients should be located as close as possible to this + # cluster. Currently only zones are supported, so values should be of the form ` + # projects/`project`/locations/`zone``. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location - # The unique name of the cluster. Values are of the form - # `projects/`project`/instances/`instance`/clusters/a-z*`. + # The unique name of the cluster. Values are of the form `projects/`project`/ + # instances/`instance`/clusters/a-z*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Required. The number of nodes allocated to this cluster. More nodes enable - # higher - # throughput and more consistent performance. + # higher throughput and more consistent performance. # Corresponds to the JSON property `serveNodes` # @return [Fixnum] attr_accessor :serve_nodes @@ -525,8 +457,7 @@ module Google end end - # Metadata type for the operation returned by - # CreateBackup. + # Metadata type for the operation returned by CreateBackup. class CreateBackupMetadata include Google::Apis::Core::Hashable @@ -583,12 +514,10 @@ module Google attr_accessor :request_time # Keys: the full `name` of each table that existed in the instance when - # CreateCluster was first called, i.e. - # `projects//instances//tables/
`. Any table added - # to the instance by a later API call will be created in the new cluster by - # that API call, not this one. - # Values: information on how much of a table's data has been copied to the - # newly-created cluster so far. + # CreateCluster was first called, i.e. `projects//instances//tables/`. Any table + # added to the instance by a later API call will be created in the new cluster + # by that API call, not this one. Values: information on how much of a table's + # data has been copied to the newly-created cluster so far. # Corresponds to the JSON property `tables` # @return [Hash] attr_accessor :tables @@ -610,24 +539,21 @@ module Google class CreateClusterRequest include Google::Apis::Core::Hashable - # A resizable group of nodes in a particular cloud location, capable - # of serving all Tables in the parent - # Instance. + # A resizable group of nodes in a particular cloud location, capable of serving + # all Tables in the parent Instance. # Corresponds to the JSON property `cluster` # @return [Google::Apis::BigtableadminV2::Cluster] attr_accessor :cluster # Required. The ID to be used when referring to the new cluster within its - # instance, - # e.g., just `mycluster` rather than - # `projects/myproject/instances/myinstance/clusters/mycluster`. + # instance, e.g., just `mycluster` rather than `projects/myproject/instances/ + # myinstance/clusters/mycluster`. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # Required. The unique name of the instance in which to create the new cluster. - # Values are of the form - # `projects/`project`/instances/`instance``. + # Values are of the form `projects/`project`/instances/`instance``. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -680,26 +606,22 @@ module Google include Google::Apis::Core::Hashable # Required. The clusters to be created within the instance, mapped by desired - # cluster ID, e.g., just `mycluster` rather than - # `projects/myproject/instances/myinstance/clusters/mycluster`. - # Fields marked `OutputOnly` must be left blank. + # cluster ID, e.g., just `mycluster` rather than `projects/myproject/instances/ + # myinstance/clusters/mycluster`. Fields marked `OutputOnly` must be left blank. # Currently, at most four clusters can be specified. # Corresponds to the JSON property `clusters` # @return [Hash] attr_accessor :clusters - # A collection of Bigtable Tables and - # the resources that serve them. - # All tables in an instance are served from all - # Clusters in the instance. + # A collection of Bigtable Tables and the resources that serve them. All tables + # in an instance are served from all Clusters in the instance. # Corresponds to the JSON property `instance` # @return [Google::Apis::BigtableadminV2::Instance] attr_accessor :instance # Required. The ID to be used when referring to the new instance within its - # project, - # e.g., just `myinstance` rather than - # `projects/myproject/instances/myinstance`. + # project, e.g., just `myinstance` rather than `projects/myproject/instances/ + # myinstance`. # Corresponds to the JSON property `instanceId` # @return [String] attr_accessor :instance_id @@ -723,39 +645,32 @@ module Google end end - # Request message for - # google.bigtable.admin.v2.BigtableTableAdmin.CreateTable + # Request message for google.bigtable.admin.v2.BigtableTableAdmin.CreateTable class CreateTableRequest include Google::Apis::Core::Hashable - # The optional list of row keys that will be used to initially split the - # table into several tablets (tablets are similar to HBase regions). - # Given two split keys, `s1` and `s2`, three tablets will be created, - # spanning the key ranges: `[, s1), [s1, s2), [s2, )`. - # Example: - # * Row keys := `["a", "apple", "custom", "customer_1", "customer_2",` - # `"other", "zz"]` - # * initial_split_keys := `["apple", "customer_1", "customer_2", "other"]` - # * Key assignment: - # - Tablet 1 `[, apple) => `"a"`.` - # - Tablet 2 `[apple, customer_1) => `"apple", "custom"`.` - # - Tablet 3 `[customer_1, customer_2) => `"customer_1"`.` - # - Tablet 4 `[customer_2, other) => `"customer_2"`.` - # - Tablet 5 `[other, ) => `"other", "zz"`.` + # The optional list of row keys that will be used to initially split the table + # into several tablets (tablets are similar to HBase regions). Given two split + # keys, `s1` and `s2`, three tablets will be created, spanning the key ranges: `[ + # , s1), [s1, s2), [s2, )`. Example: * Row keys := `["a", "apple", "custom", " + # customer_1", "customer_2",` `"other", "zz"]` * initial_split_keys := `["apple", + # "customer_1", "customer_2", "other"]` * Key assignment: - Tablet 1 `[, apple) + # => `"a"`.` - Tablet 2 `[apple, customer_1) => `"apple", "custom"`.` - Tablet 3 + # `[customer_1, customer_2) => `"customer_1"`.` - Tablet 4 `[customer_2, other) = + # > `"customer_2"`.` - Tablet 5 `[other, ) => `"other", "zz"`.` # Corresponds to the JSON property `initialSplits` # @return [Array] attr_accessor :initial_splits - # A collection of user data indexed by row, column, and timestamp. - # Each table is served using the resources of its parent cluster. + # A collection of user data indexed by row, column, and timestamp. Each table is + # served using the resources of its parent cluster. # Corresponds to the JSON property `table` # @return [Google::Apis::BigtableadminV2::Table] attr_accessor :table # Required. The name by which the new table should be referred to within the - # parent - # instance, e.g., `foobar` rather than ``parent`/tables/foobar`. - # Maximum 50 characters. + # parent instance, e.g., `foobar` rather than ``parent`/tables/foobar`. Maximum + # 50 characters. # Corresponds to the JSON property `tableId` # @return [String] attr_accessor :table_id @@ -772,8 +687,7 @@ module Google end end - # Request message for - # google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange + # Request message for google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange class DropRowRangeRequest include Google::Apis::Core::Hashable @@ -783,8 +697,8 @@ module Google attr_accessor :delete_all_data_from_table alias_method :delete_all_data_from_table?, :delete_all_data_from_table - # Delete all rows that start with this row key prefix. Prefix cannot be - # zero length. + # Delete all rows that start with this row key prefix. Prefix cannot be zero + # length. # Corresponds to the JSON property `rowKeyPrefix` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -801,13 +715,11 @@ module Google end end - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. class Empty include Google::Apis::Core::Hashable @@ -820,52 +732,43 @@ module Google end end - # Represents a textual expression in the Common Expression Language (CEL) - # syntax. CEL is a C-like expression language. The syntax and semantics of CEL - # are documented at https://github.com/google/cel-spec. - # Example (Comparison): - # title: "Summary size limit" - # description: "Determines if a summary is less than 100 chars" - # expression: "document.summary.size() < 100" - # Example (Equality): - # title: "Requestor is owner" - # description: "Determines if requestor is the document owner" - # expression: "document.owner == request.auth.claims.email" - # Example (Logic): - # title: "Public documents" - # description: "Determine whether the document should be publicly visible" - # expression: "document.type != 'private' && document.type != 'internal'" - # Example (Data Manipulation): - # title: "Notification string" - # description: "Create a notification string with a timestamp." - # expression: "'New message received at ' + string(document.create_time)" - # The exact variables and functions that may be referenced within an expression - # are determined by the service that evaluates it. See the service - # documentation for additional information. + # Represents a textual expression in the Common Expression Language (CEL) syntax. + # CEL is a C-like expression language. The syntax and semantics of CEL are + # documented at https://github.com/google/cel-spec. Example (Comparison): title: + # "Summary size limit" description: "Determines if a summary is less than 100 + # chars" expression: "document.summary.size() < 100" Example (Equality): title: " + # Requestor is owner" description: "Determines if requestor is the document + # owner" expression: "document.owner == request.auth.claims.email" Example ( + # Logic): title: "Public documents" description: "Determine whether the document + # should be publicly visible" expression: "document.type != 'private' && + # document.type != 'internal'" Example (Data Manipulation): title: "Notification + # string" description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" The + # exact variables and functions that may be referenced within an expression are + # determined by the service that evaluates it. See the service documentation for + # additional information. class Expr include Google::Apis::Core::Hashable - # Optional. Description of the expression. This is a longer text which - # describes the expression, e.g. when hovered over it in a UI. + # Optional. Description of the expression. This is a longer text which describes + # the expression, e.g. when hovered over it in a UI. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Textual representation of an expression in Common Expression Language - # syntax. + # Textual representation of an expression in Common Expression Language syntax. # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression - # Optional. String indicating the location of the expression for error - # reporting, e.g. a file name and a position in the file. + # Optional. String indicating the location of the expression for error reporting, + # e.g. a file name and a position in the file. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location - # 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. + # 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. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -942,9 +845,8 @@ module Google # @return [Google::Apis::BigtableadminV2::Intersection] attr_accessor :intersection - # Delete cells in a column older than the given age. - # Values must be at least one millisecond, and will be truncated to - # microsecond granularity. + # Delete cells in a column older than the given age. Values must be at least one + # millisecond, and will be truncated to microsecond granularity. # Corresponds to the JSON property `maxAge` # @return [String] attr_accessor :max_age @@ -972,8 +874,8 @@ module Google end end - # Request message for - # google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken + # Request message for google.bigtable.admin.v2.BigtableTableAdmin. + # GenerateConsistencyToken class GenerateConsistencyTokenRequest include Google::Apis::Core::Hashable @@ -986,8 +888,8 @@ module Google end end - # Response message for - # google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken + # Response message for google.bigtable.admin.v2.BigtableTableAdmin. + # GenerateConsistencyToken class GenerateConsistencyTokenResponse include Google::Apis::Core::Hashable @@ -1029,15 +931,13 @@ module Google class GetPolicyOptions include Google::Apis::Core::Hashable - # Optional. The policy format version to be returned. - # Valid values are 0, 1, and 3. Requests specifying an invalid value will be - # rejected. - # Requests for policies with any conditional bindings must specify version 3. - # Policies without any conditional bindings may specify any valid value or - # leave the field unset. - # To learn which resources support conditions in their IAM policies, see the - # [IAM - # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + # Optional. The policy format version to be returned. Valid values are 0, 1, and + # 3. Requests specifying an invalid value will be rejected. Requests for + # policies with any conditional bindings must specify version 3. Policies + # without any conditional bindings may specify any valid value or leave the + # field unset. To learn which resources support conditions in their IAM policies, + # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/ + # resource-policies). # Corresponds to the JSON property `requestedPolicyVersion` # @return [Fixnum] attr_accessor :requested_policy_version @@ -1052,16 +952,13 @@ module Google end end - # A collection of Bigtable Tables and - # the resources that serve them. - # All tables in an instance are served from all - # Clusters in the instance. + # A collection of Bigtable Tables and the resources that serve them. All tables + # in an instance are served from all Clusters in the instance. class Instance include Google::Apis::Core::Hashable - # Required. The descriptive name for this instance as it appears in UIs. - # Can be changed at any time, but should be kept globally unique - # to avoid confusion. + # Required. The descriptive name for this instance as it appears in UIs. Can be + # changed at any time, but should be kept globally unique to avoid confusion. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -1069,19 +966,17 @@ module Google # Required. Labels are a flexible and lightweight mechanism for organizing cloud # resources into groups that reflect a customer's organizational needs and # deployment strategies. They can be used to filter resources and aggregate - # metrics. - # * Label keys must be between 1 and 63 characters long and must conform to - # the regular expression: `\p`Ll`\p`Lo``0,62``. - # * Label values must be between 0 and 63 characters long and must conform to - # the regular expression: `[\p`Ll`\p`Lo`\p`N`_-]`0,63``. - # * No more than 64 labels can be associated with a given resource. - # * Keys and values must both be under 128 bytes. + # metrics. * Label keys must be between 1 and 63 characters long and must + # conform to the regular expression: `\p`Ll`\p`Lo``0,62``. * Label values must + # be between 0 and 63 characters long and must conform to the regular expression: + # `[\p`Ll`\p`Lo`\p`N`_-]`0,63``. * No more than 64 labels can be associated + # with a given resource. * Keys and values must both be under 128 bytes. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # The unique name of the instance. Values are of the form - # `projects/`project`/instances/a-z+[a-z0-9]`. + # The unique name of the instance. Values are of the form `projects/`project`/ + # instances/a-z+[a-z0-9]`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1138,17 +1033,15 @@ module Google # @return [Array] attr_accessor :app_profiles - # Locations from which AppProfile information could not be retrieved, - # due to an outage or some other transient condition. - # AppProfiles from these locations may be missing from `app_profiles`. - # Values are of the form `projects//locations/` + # Locations from which AppProfile information could not be retrieved, due to an + # outage or some other transient condition. AppProfiles from these locations may + # be missing from `app_profiles`. Values are of the form `projects//locations/` # Corresponds to the JSON property `failedLocations` # @return [Array] attr_accessor :failed_locations - # Set if not all app profiles could be returned in a single response. - # Pass this value to `page_token` in another request to get the next - # page of results. + # Set if not all app profiles could be returned in a single response. Pass this + # value to `page_token` in another request to get the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1174,8 +1067,7 @@ module Google # @return [Array] attr_accessor :backups - # `next_page_token` can be sent in a subsequent - # ListBackups call to fetch more + # `next_page_token` can be sent in a subsequent ListBackups call to fetch more # of the matching backups. # Corresponds to the JSON property `nextPageToken` # @return [String] @@ -1201,11 +1093,10 @@ module Google # @return [Array] attr_accessor :clusters - # Locations from which Cluster information could not be retrieved, - # due to an outage or some other transient condition. - # Clusters from these locations may be missing from `clusters`, - # or may only have partial information returned. - # Values are of the form `projects//locations/` + # Locations from which Cluster information could not be retrieved, due to an + # outage or some other transient condition. Clusters from these locations may be + # missing from `clusters`, or may only have partial information returned. Values + # are of the form `projects//locations/` # Corresponds to the JSON property `failedLocations` # @return [Array] attr_accessor :failed_locations @@ -1231,12 +1122,11 @@ module Google class ListInstancesResponse include Google::Apis::Core::Hashable - # Locations from which Instance information could not be retrieved, - # due to an outage or some other transient condition. - # Instances whose Clusters are all in one of the failed locations - # may be missing from `instances`, and Instances with at least one - # Cluster in a failed location may only have partial information returned. - # Values are of the form `projects//locations/` + # Locations from which Instance information could not be retrieved, due to an + # outage or some other transient condition. Instances whose Clusters are all in + # one of the failed locations may be missing from `instances`, and Instances + # with at least one Cluster in a failed location may only have partial + # information returned. Values are of the form `projects//locations/` # Corresponds to the JSON property `failedLocations` # @return [Array] attr_accessor :failed_locations @@ -1313,14 +1203,12 @@ module Google end end - # Response message for - # google.bigtable.admin.v2.BigtableTableAdmin.ListTables + # Response message for google.bigtable.admin.v2.BigtableTableAdmin.ListTables class ListTablesResponse include Google::Apis::Core::Hashable - # Set if not all tables could be returned in a single response. - # Pass this value to `page_token` in another request to get the next - # page of results. + # Set if not all tables could be returned in a single response. Pass this value + # to `page_token` in another request to get the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1345,14 +1233,14 @@ module Google class Location include Google::Apis::Core::Hashable - # The friendly name for this location, typically a nearby city name. - # For example, "Tokyo". + # The friendly name for this location, typically a nearby city name. For example, + # "Tokyo". # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Cross-service attributes for the location. For example - # `"cloud.googleapis.com/region": "us-east1"` + # Cross-service attributes for the location. For example `"cloud.googleapis.com/ + # region": "us-east1"` # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -1368,8 +1256,8 @@ module Google # @return [Hash] attr_accessor :metadata - # Resource name for the location, which may vary between implementations. - # For example: `"projects/example-project/locations/us-east1"` + # Resource name for the location, which may vary between implementations. For + # example: `"projects/example-project/locations/us-east1"` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1397,8 +1285,8 @@ module Google # @return [Google::Apis::BigtableadminV2::ColumnFamily] attr_accessor :create - # Drop (delete) the column family with the given ID, or fail if no such - # family exists. + # Drop (delete) the column family with the given ID, or fail if no such family + # exists. # Corresponds to the JSON property `drop` # @return [Boolean] attr_accessor :drop @@ -1427,15 +1315,14 @@ module Google end end - # Request message for - # google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies + # Request message for google.bigtable.admin.v2.BigtableTableAdmin. + # ModifyColumnFamilies class ModifyColumnFamiliesRequest include Google::Apis::Core::Hashable # Required. Modifications to be atomically applied to the specified table's - # families. - # Entries are applied in order, meaning that earlier modifications can be - # masked by later ones (in the case of repeated updates to the same family, + # families. Entries are applied in order, meaning that earlier modifications can + # be masked by later ones (in the case of repeated updates to the same family, # for example). # Corresponds to the JSON property `modifications` # @return [Array] @@ -1453,9 +1340,9 @@ module Google # Read/write requests are routed to the nearest cluster in the instance, and # will fail over to the nearest cluster that is available in the event of - # transient errors or delays. Clusters in a region are considered - # equidistant. Choosing this option sacrifices read-your-writes consistency - # to improve availability. + # transient errors or delays. Clusters in a region are considered equidistant. + # Choosing this option sacrifices read-your-writes consistency to improve + # availability. class MultiClusterRoutingUseAny include Google::Apis::Core::Hashable @@ -1473,47 +1360,45 @@ module Google class Operation include Google::Apis::Core::Hashable - # If the value is `false`, it means the operation is still in progress. - # If `true`, the operation is completed, and either `error` or `response` is - # available. + # If the value is `false`, it means the operation is still in progress. If `true` + # , the operation is completed, and either `error` or `response` is available. # Corresponds to the JSON property `done` # @return [Boolean] attr_accessor :done alias_method :done?, :done - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). # Corresponds to the JSON property `error` # @return [Google::Apis::BigtableadminV2::Status] attr_accessor :error - # Service-specific metadata associated with the operation. It typically - # contains progress information and common metadata such as create time. - # Some services might not provide such metadata. Any method that returns a - # long-running operation should document the metadata type, if any. + # Service-specific metadata associated with the operation. It typically contains + # progress information and common metadata such as create time. Some services + # might not provide such metadata. Any method that returns a long-running + # operation should document the metadata type, if any. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # The server-assigned name, which is only unique within the same service that - # originally returns it. If you use the default HTTP mapping, the - # `name` should be a resource name ending with `operations/`unique_id``. + # originally returns it. If you use the default HTTP mapping, the `name` should + # be a resource name ending with `operations/`unique_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The normal response of the operation in case of success. If the original - # method returns no data on success, such as `Delete`, the response is - # `google.protobuf.Empty`. If the original method is standard - # `Get`/`Create`/`Update`, the response should be the resource. For other - # methods, the response should have the type `XxxResponse`, where `Xxx` - # is the original method name. For example, if the original method name - # is `TakeSnapshot()`, the inferred response type is - # `TakeSnapshotResponse`. + # The normal response of the operation in case of success. If the original + # method returns no data on success, such as `Delete`, the response is `google. + # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, + # the response should be the resource. For other methods, the response should + # have the type `XxxResponse`, where `Xxx` is the original method name. For + # example, if the original method name is `TakeSnapshot()`, the inferred + # response type is `TakeSnapshotResponse`. # Corresponds to the JSON property `response` # @return [Hash] attr_accessor :response @@ -1532,19 +1417,17 @@ module Google end end - # Encapsulates progress related information for a Cloud Bigtable long - # running operation. + # Encapsulates progress related information for a Cloud Bigtable long running + # operation. class OperationProgress include Google::Apis::Core::Hashable - # If set, the time at which this operation failed or was completed - # successfully. + # If set, the time at which this operation failed or was completed successfully. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Percent completion of the operation. - # Values are between 0 and 100 inclusive. + # Percent completion of the operation. Values are between 0 and 100 inclusive. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -1566,10 +1449,10 @@ module Google end end - # Metadata type for the long-running operation used to track the progress - # of optimizations performed on a newly restored table. This long-running - # operation is automatically created by the system after the successful - # completion of a table restore, and cannot be cancelled. + # Metadata type for the long-running operation used to track the progress of + # optimizations performed on a newly restored table. This long-running operation + # is automatically created by the system after the successful completion of a + # table restore, and cannot be cancelled. class OptimizeRestoredTableMetadata include Google::Apis::Core::Hashable @@ -1578,8 +1461,8 @@ module Google # @return [String] attr_accessor :name - # Encapsulates progress related information for a Cloud Bigtable long - # running operation. + # Encapsulates progress related information for a Cloud Bigtable long running + # operation. # Corresponds to the JSON property `progress` # @return [Google::Apis::BigtableadminV2::OperationProgress] attr_accessor :progress @@ -1599,16 +1482,14 @@ module Google class PartialUpdateInstanceRequest include Google::Apis::Core::Hashable - # A collection of Bigtable Tables and - # the resources that serve them. - # All tables in an instance are served from all - # Clusters in the instance. + # A collection of Bigtable Tables and the resources that serve them. All tables + # in an instance are served from all Clusters in the instance. # Corresponds to the JSON property `instance` # @return [Google::Apis::BigtableadminV2::Instance] attr_accessor :instance - # Required. The subset of Instance fields which should be replaced. - # Must be explicitly set. + # Required. The subset of Instance fields which should be replaced. Must be + # explicitly set. # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask @@ -1625,66 +1506,32 @@ module Google end # An Identity and Access Management (IAM) policy, which specifies access - # controls for Google Cloud resources. - # A `Policy` is a collection of `bindings`. A `binding` binds one or more - # `members` to a single `role`. Members can be user accounts, service accounts, - # Google groups, and domains (such as G Suite). A `role` is a named list of - # permissions; each `role` can be an IAM predefined role or a user-created - # custom role. - # For some types of Google Cloud resources, a `binding` can also specify a - # `condition`, which is a logical expression that allows access to a resource - # only if the expression evaluates to `true`. A condition can add constraints - # based on attributes of the request, the resource, or both. To learn which - # resources support conditions in their IAM policies, see the - # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- - # policies). - # **JSON example:** - # ` - # "bindings": [ - # ` - # "role": "roles/resourcemanager.organizationAdmin", - # "members": [ - # "user:mike@example.com", - # "group:admins@example.com", - # "domain:google.com", - # "serviceAccount:my-project-id@appspot.gserviceaccount.com" - # ] - # `, - # ` - # "role": "roles/resourcemanager.organizationViewer", - # "members": [ - # "user:eve@example.com" - # ], - # "condition": ` - # "title": "expirable access", - # "description": "Does not grant access after Sep 2020", - # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z') - # ", - # ` - # ` - # ], - # "etag": "BwWWja0YfJA=", - # "version": 3 - # ` - # **YAML example:** - # bindings: - # - members: - # - user:mike@example.com - # - group:admins@example.com - # - domain:google.com - # - serviceAccount:my-project-id@appspot.gserviceaccount.com - # role: roles/resourcemanager.organizationAdmin - # - members: - # - user:eve@example.com - # role: roles/resourcemanager.organizationViewer - # condition: - # title: expirable access - # description: Does not grant access after Sep 2020 - # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - # - etag: BwWWja0YfJA= - # - version: 3 - # For a description of IAM and its features, see the - # [IAM documentation](https://cloud.google.com/iam/docs/). + # controls for Google Cloud resources. A `Policy` is a collection of `bindings`. + # A `binding` binds one or more `members` to a single `role`. Members can be + # user accounts, service accounts, Google groups, and domains (such as G Suite). + # A `role` is a named list of permissions; each `role` can be an IAM predefined + # role or a user-created custom role. For some types of Google Cloud resources, + # a `binding` can also specify a `condition`, which is a logical expression that + # allows access to a resource only if the expression evaluates to `true`. A + # condition can add constraints based on attributes of the request, the resource, + # or both. To learn which resources support conditions in their IAM policies, + # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/ + # resource-policies). **JSON example:** ` "bindings": [ ` "role": "roles/ + # resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", " + # group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@ + # appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager. + # organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` " + # title": "expirable access", "description": "Does not grant access after Sep + # 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", ` + # ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: - + # members: - user:mike@example.com - group:admins@example.com - domain:google. + # com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/ + # resourcemanager.organizationAdmin - members: - user:eve@example.com role: + # roles/resourcemanager.organizationViewer condition: title: expirable access + # description: Does not grant access after Sep 2020 expression: request.time < + # timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a + # description of IAM and its features, see the [IAM documentation](https://cloud. + # google.com/iam/docs/). class Policy include Google::Apis::Core::Hashable @@ -1693,48 +1540,44 @@ module Google # @return [Array] attr_accessor :audit_configs - # Associates a list of `members` to a `role`. Optionally, may specify a - # `condition` that determines how and when the `bindings` are applied. Each - # of the `bindings` must contain at least one member. + # Associates a list of `members` to a `role`. Optionally, may specify a ` + # condition` that determines how and when the `bindings` are applied. Each of + # the `bindings` must contain at least one member. # Corresponds to the JSON property `bindings` # @return [Array] attr_accessor :bindings - # `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. + # `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. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag - # 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). + # 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). # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -1777,8 +1620,7 @@ module Google end end - # Metadata type for the long-running operation returned by - # RestoreTable. + # Metadata type for the long-running operation returned by RestoreTable. class RestoreTableMetadata include Google::Apis::Core::Hashable @@ -1792,21 +1634,20 @@ module Google # @return [String] attr_accessor :name - # If exists, the name of the long-running operation that will be used to - # track the post-restore optimization process to optimize the performance of - # the restored table. The metadata type of the long-running operation is - # OptimizeRestoreTableMetadata. The response type is - # Empty. This long-running operation may be - # automatically created by the system if applicable after the - # RestoreTable long-running operation completes successfully. This operation - # may not be created if the table is already optimized or the restore was - # not successful. + # If exists, the name of the long-running operation that will be used to track + # the post-restore optimization process to optimize the performance of the + # restored table. The metadata type of the long-running operation is + # OptimizeRestoreTableMetadata. The response type is Empty. This long-running + # operation may be automatically created by the system if applicable after the + # RestoreTable long-running operation completes successfully. This operation may + # not be created if the table is already optimized or the restore was not + # successful. # Corresponds to the JSON property `optimizeTableOperationName` # @return [String] attr_accessor :optimize_table_operation_name - # Encapsulates progress related information for a Cloud Bigtable long - # running operation. + # Encapsulates progress related information for a Cloud Bigtable long running + # operation. # Corresponds to the JSON property `progress` # @return [Google::Apis::BigtableadminV2::OperationProgress] attr_accessor :progress @@ -1830,21 +1671,19 @@ module Google end end - # The request for - # RestoreTable. + # The request for RestoreTable. class RestoreTableRequest include Google::Apis::Core::Hashable - # Name of the backup from which to restore. Values are of the form - # `projects//instances//clusters//backups/`. + # Name of the backup from which to restore. Values are of the form `projects// + # instances//clusters//backups/`. # Corresponds to the JSON property `backup` # @return [String] attr_accessor :backup - # Required. The id of the table to create and restore to. This - # table must not already exist. The `table_id` appended to - # `parent` forms the full table name of the form - # `projects//instances//tables/`. + # Required. The id of the table to create and restore to. This table must not + # already exist. The `table_id` appended to `parent` forms the full table name + # of the form `projects//instances//tables/`. # Corresponds to the JSON property `tableId` # @return [String] attr_accessor :table_id @@ -1865,74 +1704,39 @@ module Google include Google::Apis::Core::Hashable # An Identity and Access Management (IAM) policy, which specifies access - # controls for Google Cloud resources. - # A `Policy` is a collection of `bindings`. A `binding` binds one or more - # `members` to a single `role`. Members can be user accounts, service accounts, - # Google groups, and domains (such as G Suite). A `role` is a named list of - # permissions; each `role` can be an IAM predefined role or a user-created - # custom role. - # For some types of Google Cloud resources, a `binding` can also specify a - # `condition`, which is a logical expression that allows access to a resource - # only if the expression evaluates to `true`. A condition can add constraints - # based on attributes of the request, the resource, or both. To learn which - # resources support conditions in their IAM policies, see the - # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- - # policies). - # **JSON example:** - # ` - # "bindings": [ - # ` - # "role": "roles/resourcemanager.organizationAdmin", - # "members": [ - # "user:mike@example.com", - # "group:admins@example.com", - # "domain:google.com", - # "serviceAccount:my-project-id@appspot.gserviceaccount.com" - # ] - # `, - # ` - # "role": "roles/resourcemanager.organizationViewer", - # "members": [ - # "user:eve@example.com" - # ], - # "condition": ` - # "title": "expirable access", - # "description": "Does not grant access after Sep 2020", - # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z') - # ", - # ` - # ` - # ], - # "etag": "BwWWja0YfJA=", - # "version": 3 - # ` - # **YAML example:** - # bindings: - # - members: - # - user:mike@example.com - # - group:admins@example.com - # - domain:google.com - # - serviceAccount:my-project-id@appspot.gserviceaccount.com - # role: roles/resourcemanager.organizationAdmin - # - members: - # - user:eve@example.com - # role: roles/resourcemanager.organizationViewer - # condition: - # title: expirable access - # description: Does not grant access after Sep 2020 - # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - # - etag: BwWWja0YfJA= - # - version: 3 - # For a description of IAM and its features, see the - # [IAM documentation](https://cloud.google.com/iam/docs/). + # controls for Google Cloud resources. A `Policy` is a collection of `bindings`. + # A `binding` binds one or more `members` to a single `role`. Members can be + # user accounts, service accounts, Google groups, and domains (such as G Suite). + # A `role` is a named list of permissions; each `role` can be an IAM predefined + # role or a user-created custom role. For some types of Google Cloud resources, + # a `binding` can also specify a `condition`, which is a logical expression that + # allows access to a resource only if the expression evaluates to `true`. A + # condition can add constraints based on attributes of the request, the resource, + # or both. To learn which resources support conditions in their IAM policies, + # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/ + # resource-policies). **JSON example:** ` "bindings": [ ` "role": "roles/ + # resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", " + # group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@ + # appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager. + # organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` " + # title": "expirable access", "description": "Does not grant access after Sep + # 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", ` + # ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: - + # members: - user:mike@example.com - group:admins@example.com - domain:google. + # com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/ + # resourcemanager.organizationAdmin - members: - user:eve@example.com role: + # roles/resourcemanager.organizationViewer condition: title: expirable access + # description: Does not grant access after Sep 2020 expression: request.time < + # timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a + # description of IAM and its features, see the [IAM documentation](https://cloud. + # google.com/iam/docs/). # Corresponds to the JSON property `policy` # @return [Google::Apis::BigtableadminV2::Policy] attr_accessor :policy # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only - # the fields in the mask will be modified. If no mask is provided, the - # following default mask is used: - # `paths: "bindings, etag"` + # the fields in the mask will be modified. If no mask is provided, the following + # default mask is used: `paths: "bindings, etag"` # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask @@ -1948,15 +1752,15 @@ module Google end end - # Unconditionally routes all read/write requests to a specific cluster. - # This option preserves read-your-writes consistency but does not improve + # Unconditionally routes all read/write requests to a specific cluster. This + # option preserves read-your-writes consistency but does not improve # availability. class SingleClusterRouting include Google::Apis::Core::Hashable # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are - # allowed by this app profile. It is unsafe to send these requests to - # the same table/row/column in multiple clusters. + # allowed by this app profile. It is unsafe to send these requests to the same + # table/row/column in multiple clusters. # Corresponds to the JSON property `allowTransactionalWrites` # @return [Boolean] attr_accessor :allow_transactional_writes @@ -1998,12 +1802,12 @@ module Google end end - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). class Status include Google::Apis::Core::Hashable @@ -2012,15 +1816,15 @@ module Google # @return [Fixnum] attr_accessor :code - # A list of messages that carry the error details. There is a common set of + # A list of messages that carry the error details. There is a common set of # message types for APIs to use. # Corresponds to the JSON property `details` # @return [Array>] attr_accessor :details - # A developer-facing error message, which should be in English. Any - # user-facing error message should be localized and sent in the - # google.rpc.Status.details field, or localized by the client. + # A developer-facing error message, which should be in English. Any user-facing + # error message should be localized and sent in the google.rpc.Status.details + # field, or localized by the client. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -2037,16 +1841,15 @@ module Google end end - # A collection of user data indexed by row, column, and timestamp. - # Each table is served using the resources of its parent cluster. + # A collection of user data indexed by row, column, and timestamp. Each table is + # served using the resources of its parent cluster. class Table include Google::Apis::Core::Hashable - # Output only. Map from cluster ID to per-cluster table state. - # If it could not be determined whether or not the table has data in a - # particular cluster (for example, if its zone is unavailable), then - # there will be an entry for the cluster with UNKNOWN `replication_status`. - # Views: `REPLICATION_VIEW`, `FULL` + # Output only. Map from cluster ID to per-cluster table state. If it could not + # be determined whether or not the table has data in a particular cluster (for + # example, if its zone is unavailable), then there will be an entry for the + # cluster with UNKNOWN `replication_status`. Views: `REPLICATION_VIEW`, `FULL` # Corresponds to the JSON property `clusterStates` # @return [Hash] attr_accessor :cluster_states @@ -2058,17 +1861,16 @@ module Google attr_accessor :column_families # Immutable. The granularity (i.e. `MILLIS`) at which timestamps are stored in - # this - # table. Timestamps not matching the granularity will be rejected. - # If unspecified at creation time, the value will be set to `MILLIS`. - # Views: `SCHEMA_VIEW`, `FULL`. + # this table. Timestamps not matching the granularity will be rejected. If + # unspecified at creation time, the value will be set to `MILLIS`. Views: ` + # SCHEMA_VIEW`, `FULL`. # Corresponds to the JSON property `granularity` # @return [String] attr_accessor :granularity - # The unique name of the table. Values are of the form - # `projects/`project`/instances/`instance`/tables/_a-zA-Z0-9*`. - # Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL` + # The unique name of the table. Values are of the form `projects/`project`/ + # instances/`instance`/tables/_a-zA-Z0-9*`. Views: `NAME_ONLY`, `SCHEMA_VIEW`, ` + # REPLICATION_VIEW`, `FULL` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2096,9 +1898,8 @@ module Google class TableProgress include Google::Apis::Core::Hashable - # Estimate of the number of bytes copied so far for this table. - # This will eventually reach 'estimated_size_bytes' unless the table copy - # is CANCELLED. + # Estimate of the number of bytes copied so far for this table. This will + # eventually reach 'estimated_size_bytes' unless the table copy is CANCELLED. # Corresponds to the JSON property `estimatedCopiedBytes` # @return [Fixnum] attr_accessor :estimated_copied_bytes @@ -2129,10 +1930,9 @@ module Google class TestIamPermissionsRequest include Google::Apis::Core::Hashable - # The set of permissions to check for the `resource`. Permissions with - # wildcards (such as '*' or 'storage.*') are not allowed. For more - # information see - # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + # The set of permissions to check for the `resource`. Permissions with wildcards + # (such as '*' or 'storage.*') are not allowed. For more information see [IAM + # Overview](https://cloud.google.com/iam/docs/overview#permissions). # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions @@ -2151,8 +1951,7 @@ module Google class TestIamPermissionsResponse include Google::Apis::Core::Hashable - # A subset of `TestPermissionsRequest.permissions` that the caller is - # allowed. + # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions @@ -2208,9 +2007,8 @@ module Google # @return [String] attr_accessor :finish_time - # A resizable group of nodes in a particular cloud location, capable - # of serving all Tables in the parent - # Instance. + # A resizable group of nodes in a particular cloud location, capable of serving + # all Tables in the parent Instance. # Corresponds to the JSON property `originalRequest` # @return [Google::Apis::BigtableadminV2::Cluster] attr_accessor :original_request diff --git a/generated/google/apis/bigtableadmin_v2/service.rb b/generated/google/apis/bigtableadmin_v2/service.rb index 86168ce67..b08b9ff6e 100644 --- a/generated/google/apis/bigtableadmin_v2/service.rb +++ b/generated/google/apis/bigtableadmin_v2/service.rb @@ -47,15 +47,13 @@ module Google @batch_path = 'batch' end - # Starts asynchronous cancellation on a long-running operation. The server - # makes a best effort to cancel the operation, but success is not - # guaranteed. If the server doesn't support this method, it returns - # `google.rpc.Code.UNIMPLEMENTED`. Clients can use - # Operations.GetOperation or - # other methods to check whether the cancellation succeeded or whether the - # operation completed despite cancellation. On successful cancellation, - # the operation is not deleted; instead, it becomes an operation with - # an Operation.error value with a google.rpc.Status.code of 1, + # Starts asynchronous cancellation on a long-running operation. The server makes + # a best effort to cancel the operation, but success is not guaranteed. If the + # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + # Clients can use Operations.GetOperation or other methods to check whether the + # cancellation succeeded or whether the operation completed despite cancellation. + # On successful cancellation, the operation is not deleted; instead, it becomes + # an operation with an Operation.error value with a google.rpc.Status.code of 1, # corresponding to `Code.CANCELLED`. # @param [String] name # The name of the operation resource to be cancelled. @@ -86,10 +84,10 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a long-running operation. This method indicates that the client is - # no longer interested in the operation result. It does not cancel the - # operation. If the server doesn't support this method, it returns - # `google.rpc.Code.UNIMPLEMENTED`. + # Deletes a long-running operation. This method indicates that the client is no + # longer interested in the operation result. It does not cancel the operation. + # If the server doesn't support this method, it returns `google.rpc.Code. + # UNIMPLEMENTED`. # @param [String] name # The name of the operation resource to be deleted. # @param [String] fields @@ -119,9 +117,8 @@ module Google execute_or_queue_command(command, &block) end - # Gets the latest state of a long-running operation. Clients can use this - # method to poll the operation result at intervals as recommended by the API - # service. + # Gets the latest state of a long-running operation. Clients can use this method + # to poll the operation result at intervals as recommended by the API service. # @param [String] name # The name of the operation resource. # @param [String] fields @@ -151,15 +148,14 @@ module Google execute_or_queue_command(command, &block) end - # Lists operations that match the specified filter in the request. If the - # server doesn't support this method, it returns `UNIMPLEMENTED`. - # NOTE: the `name` binding allows API services to override the binding - # to use different resource name schemes, such as `users/*/operations`. To - # override the binding, API services can add a binding such as - # `"/v1/`name=users/*`/operations"` to their service configuration. - # For backwards compatibility, the default name includes the operations - # collection id, however overriding users must ensure the name binding - # is the parent resource, without the operations collection id. + # Lists operations that match the specified filter in the request. If the server + # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` + # binding allows API services to override the binding to use different resource + # name schemes, such as `users/*/operations`. To override the binding, API + # services can add a binding such as `"/v1/`name=users/*`/operations"` to their + # service configuration. For backwards compatibility, the default name includes + # the operations collection id, however overriding users must ensure the name + # binding is the parent resource, without the operations collection id. # @param [String] name # The name of the operation's parent resource. # @param [String] filter @@ -234,8 +230,8 @@ module Google # Delete an instance from a project. # @param [String] name - # Required. The unique name of the instance to be deleted. - # Values are of the form `projects/`project`/instances/`instance``. + # Required. The unique name of the instance to be deleted. Values are of the + # form `projects/`project`/instances/`instance``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -265,8 +261,8 @@ module Google # Gets information about an instance. # @param [String] name - # Required. The unique name of the requested instance. Values are of the form - # `projects/`project`/instances/`instance``. + # Required. The unique name of the requested instance. Values are of the form ` + # projects/`project`/instances/`instance``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -297,8 +293,8 @@ module Google # Gets the access control policy for an instance resource. Returns an empty # policy if an instance exists but does not have a policy set. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::BigtableadminV2::GetIamPolicyRequest] get_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -332,8 +328,7 @@ module Google # Lists information about instances in a project. # @param [String] parent # Required. The unique name of the project for which a list of instances is - # requested. - # Values are of the form `projects/`project``. + # requested. Values are of the form `projects/`project``. # @param [String] page_token # DEPRECATED: This field is unused and ignored. # @param [String] fields @@ -367,12 +362,12 @@ module Google # Partially updates an instance within a project. This method can modify all # fields of an Instance and is the preferred way to update an Instance. # @param [String] name - # The unique name of the instance. Values are of the form - # `projects/`project`/instances/a-z+[a-z0-9]`. + # The unique name of the instance. Values are of the form `projects/`project`/ + # instances/a-z+[a-z0-9]`. # @param [Google::Apis::BigtableadminV2::Instance] instance_object # @param [String] update_mask - # Required. The subset of Instance fields which should be replaced. - # Must be explicitly set. + # Required. The subset of Instance fields which should be replaced. Must be + # explicitly set. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -403,11 +398,11 @@ module Google execute_or_queue_command(command, &block) end - # Sets the access control policy on an instance resource. Replaces any - # existing policy. + # Sets the access control policy on an instance resource. Replaces any existing + # policy. # @param [String] resource - # REQUIRED: The resource for which the policy is being specified. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::BigtableadminV2::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -440,8 +435,8 @@ module Google # Returns permissions that the caller has on the specified instance resource. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::BigtableadminV2::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -476,8 +471,8 @@ module Google # name and type for an Instance. To update other Instance properties, such as # labels, use PartialUpdateInstance. # @param [String] name - # The unique name of the instance. Values are of the form - # `projects/`project`/instances/a-z+[a-z0-9]`. + # The unique name of the instance. Values are of the form `projects/`project`/ + # instances/a-z+[a-z0-9]`. # @param [Google::Apis::BigtableadminV2::Instance] instance_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -511,14 +506,12 @@ module Google # Creates an app profile within an instance. # @param [String] parent # Required. The unique name of the instance in which to create the new app - # profile. - # Values are of the form - # `projects/`project`/instances/`instance``. + # profile. Values are of the form `projects/`project`/instances/`instance``. # @param [Google::Apis::BigtableadminV2::AppProfile] app_profile_object # @param [String] app_profile_id # Required. The ID to be used when referring to the new app profile within its - # instance, e.g., just `myprofile` rather than - # `projects/myproject/instances/myinstance/appProfiles/myprofile`. + # instance, e.g., just `myprofile` rather than `projects/myproject/instances/ + # myinstance/appProfiles/myprofile`. # @param [Boolean] ignore_warnings # If true, ignore safety checks when creating the app profile. # @param [String] fields @@ -555,8 +548,7 @@ module Google # Deletes an app profile from an instance. # @param [String] name # Required. The unique name of the app profile to be deleted. Values are of the - # form - # `projects/`project`/instances/`instance`/appProfiles/`app_profile``. + # form `projects/`project`/instances/`instance`/appProfiles/`app_profile``. # @param [Boolean] ignore_warnings # Required. If true, ignore safety checks when deleting the app profile. # @param [String] fields @@ -621,18 +613,16 @@ module Google # Lists information about app profiles in an instance. # @param [String] parent # Required. The unique name of the instance for which a list of app profiles is - # requested. Values are of the form - # `projects/`project`/instances/`instance``. - # Use ``instance` = '-'` to list AppProfiles for all Instances in a project, - # e.g., `projects/myproject/instances/-`. + # requested. Values are of the form `projects/`project`/instances/`instance``. + # Use ``instance` = '-'` to list AppProfiles for all Instances in a project, e.g. + # , `projects/myproject/instances/-`. # @param [Fixnum] page_size - # Maximum number of results per page. - # A page_size of zero lets the server choose the number of items to return. - # A page_size which is strictly positive will return at most that many items. - # A negative page_size will cause an error. - # Following the first request, subsequent paginated calls are not required - # to pass a page_size. If a page_size is set in subsequent calls, it must - # match the page_size given in the first request. + # Maximum number of results per page. A page_size of zero lets the server choose + # the number of items to return. A page_size which is strictly positive will + # return at most that many items. A negative page_size will cause an error. + # Following the first request, subsequent paginated calls are not required to + # pass a page_size. If a page_size is set in subsequent calls, it must match the + # page_size given in the first request. # @param [String] page_token # The value of `next_page_token` returned by a previous call. # @param [String] fields @@ -666,14 +656,14 @@ module Google # Updates an app profile within an instance. # @param [String] name - # The unique name of the app profile. Values are of the form - # `projects/`project`/instances/`instance`/appProfiles/_a-zA-Z0-9*`. + # The unique name of the app profile. Values are of the form `projects/`project`/ + # instances/`instance`/appProfiles/_a-zA-Z0-9*`. # @param [Google::Apis::BigtableadminV2::AppProfile] app_profile_object # @param [Boolean] ignore_warnings # If true, ignore safety checks when updating the app profile. # @param [String] update_mask - # Required. The subset of app profile fields which should be replaced. - # If unset, all fields will be replaced. + # Required. The subset of app profile fields which should be replaced. If unset, + # all fields will be replaced. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -708,14 +698,12 @@ module Google # Creates a cluster within an instance. # @param [String] parent # Required. The unique name of the instance in which to create the new cluster. - # Values are of the form - # `projects/`project`/instances/`instance``. + # Values are of the form `projects/`project`/instances/`instance``. # @param [Google::Apis::BigtableadminV2::Cluster] cluster_object # @param [String] cluster_id # Required. The ID to be used when referring to the new cluster within its - # instance, - # e.g., just `mycluster` rather than - # `projects/myproject/instances/myinstance/clusters/mycluster`. + # instance, e.g., just `mycluster` rather than `projects/myproject/instances/ + # myinstance/clusters/mycluster`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -779,8 +767,8 @@ module Google # Gets information about a cluster. # @param [String] name - # Required. The unique name of the requested cluster. Values are of the form - # `projects/`project`/instances/`instance`/clusters/`cluster``. + # Required. The unique name of the requested cluster. Values are of the form ` + # projects/`project`/instances/`instance`/clusters/`cluster``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -811,10 +799,9 @@ module Google # Lists information about clusters in an instance. # @param [String] parent # Required. The unique name of the instance for which a list of clusters is - # requested. - # Values are of the form `projects/`project`/instances/`instance``. - # Use ``instance` = '-'` to list Clusters for all Instances in a project, - # e.g., `projects/myproject/instances/-`. + # requested. Values are of the form `projects/`project`/instances/`instance``. + # Use ``instance` = '-'` to list Clusters for all Instances in a project, e.g., ` + # projects/myproject/instances/-`. # @param [String] page_token # DEPRECATED: This field is unused and ignored. # @param [String] fields @@ -847,8 +834,8 @@ module Google # Updates a cluster within an instance. # @param [String] name - # The unique name of the cluster. Values are of the form - # `projects/`project`/instances/`instance`/clusters/a-z*`. + # The unique name of the cluster. Values are of the form `projects/`project`/ + # instances/`instance`/clusters/a-z*`. # @param [Google::Apis::BigtableadminV2::Cluster] cluster_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -879,27 +866,21 @@ module Google execute_or_queue_command(command, &block) end - # Starts creating a new Cloud Bigtable Backup. The returned backup - # long-running operation can be used to - # track creation of the backup. The - # metadata field type is - # CreateBackupMetadata. The - # response field type is - # Backup, if successful. Cancelling the returned operation will stop the - # creation and delete the backup. + # Starts creating a new Cloud Bigtable Backup. The returned backup long-running + # operation can be used to track creation of the backup. The metadata field type + # is CreateBackupMetadata. The response field type is Backup, if successful. + # Cancelling the returned operation will stop the creation and delete the backup. # @param [String] parent - # Required. This must be one of the clusters in the instance in which this - # table is located. The backup will be stored in this cluster. Values are - # of the form `projects/`project`/instances/`instance`/clusters/`cluster``. + # Required. This must be one of the clusters in the instance in which this table + # is located. The backup will be stored in this cluster. Values are of the form ` + # projects/`project`/instances/`instance`/clusters/`cluster``. # @param [Google::Apis::BigtableadminV2::Backup] backup_object # @param [String] backup_id - # Required. The id of the backup to be created. The `backup_id` along with - # the parent `parent` are combined as `parent`/backups/`backup_id` to create - # the full backup name, of the form: - # `projects/`project`/instances/`instance`/clusters/`cluster`/backups/`backup_id` - # `. - # This string must be between 1 and 50 characters in length and match the - # regex _a-zA-Z0-9*. + # Required. The id of the backup to be created. The `backup_id` along with the + # parent `parent` are combined as `parent`/backups/`backup_id` to create the + # full backup name, of the form: `projects/`project`/instances/`instance`/ + # clusters/`cluster`/backups/`backup_id``. This string must be between 1 and 50 + # characters in length and match the regex _a-zA-Z0-9*. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -932,9 +913,8 @@ module Google # Deletes a pending or completed Cloud Bigtable backup. # @param [String] name - # Required. Name of the backup to delete. - # Values are of the form - # `projects/`project`/instances/`instance`/clusters/`cluster`/backups/`backup``. + # Required. Name of the backup to delete. Values are of the form `projects/` + # project`/instances/`instance`/clusters/`cluster`/backups/`backup``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -964,9 +944,8 @@ module Google # Gets metadata on a pending or completed Cloud Bigtable Backup. # @param [String] name - # Required. Name of the backup. - # Values are of the form - # `projects/`project`/instances/`instance`/clusters/`cluster`/backups/`backup``. + # Required. Name of the backup. Values are of the form `projects/`project`/ + # instances/`instance`/clusters/`cluster`/backups/`backup``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -994,12 +973,11 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a Table resource. - # Returns an empty policy if the resource exists but does not have a policy - # set. + # Gets the access control policy for a Table resource. Returns an empty policy + # if the resource exists but does not have a policy set. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::BigtableadminV2::GetIamPolicyRequest] get_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1030,68 +1008,49 @@ module Google execute_or_queue_command(command, &block) end - # Lists Cloud Bigtable backups. Returns both completed and pending - # backups. + # Lists Cloud Bigtable backups. Returns both completed and pending backups. # @param [String] parent - # Required. The cluster to list backups from. Values are of the - # form `projects/`project`/instances/`instance`/clusters/`cluster``. - # Use ``cluster` = '-'` to list backups for all clusters in an instance, - # e.g., `projects/`project`/instances/`instance`/clusters/-`. + # Required. The cluster to list backups from. Values are of the form `projects/` + # project`/instances/`instance`/clusters/`cluster``. Use ``cluster` = '-'` to + # list backups for all clusters in an instance, e.g., `projects/`project`/ + # instances/`instance`/clusters/-`. # @param [String] filter - # A filter expression that filters backups listed 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 :. Colon ':' represents a HAS operator which is - # roughly synonymous with equality. Filter rules are case insensitive. - # The fields eligible for filtering are: - # * `name` - # * `source_table` - # * `state` - # * `start_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) - # * `end_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) - # * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) - # * `size_bytes` - # To filter on multiple expressions, provide each separate expression within - # parentheses. By default, each expression is an AND expression. However, - # you can include AND, OR, and NOT expressions explicitly. - # Some examples of using filters are: - # * `name:"exact"` --> The backup's name is the string "exact". - # * `name:howl` --> The backup's name contains the string "howl". - # * `source_table:prod` - # --> The source_table's name contains the string "prod". - # * `state:CREATING` --> The backup is pending creation. - # * `state:READY` --> The backup is fully created and ready for use. - # * `(name:howl) AND (start_time < \"2018-03-28T14:50:00Z\")` - # --> The backup name contains the string "howl" and start_time - # of the backup is before 2018-03-28T14:50:00Z. - # * `size_bytes > 10000000000` --> The backup's size is greater than 10GB + # A filter expression that filters backups listed 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 :. Colon ':' + # represents a HAS operator which is roughly synonymous with equality. Filter + # rules are case insensitive. The fields eligible for filtering are: * `name` * ` + # source_table` * `state` * `start_time` (and values are of the format YYYY-MM- + # DDTHH:MM:SSZ) * `end_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) + # * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * ` + # size_bytes` To filter on multiple expressions, provide each separate + # expression within parentheses. By default, each expression is an AND + # expression. However, you can include AND, OR, and NOT expressions explicitly. + # Some examples of using filters are: * `name:"exact"` --> The backup's name is + # the string "exact". * `name:howl` --> The backup's name contains the string " + # howl". * `source_table:prod` --> The source_table's name contains the string " + # prod". * `state:CREATING` --> The backup is pending creation. * `state:READY` - + # -> The backup is fully created and ready for use. * `(name:howl) AND ( + # start_time < \"2018-03-28T14:50:00Z\")` --> The backup name contains the + # string "howl" and start_time of the backup is before 2018-03-28T14:50:00Z. * ` + # size_bytes > 10000000000` --> The backup's size is greater than 10GB # @param [String] order_by - # An expression for specifying the sort order of the results of the request. - # The string value should specify one or more fields in Backup. The full - # syntax is described at https://aip.dev/132#ordering. - # Fields supported are: - # * name - # * source_table - # * expire_time - # * start_time - # * end_time - # * size_bytes - # * state - # For example, "start_time". The default sorting order is ascending. - # To specify descending order for the field, a suffix " desc" should - # be appended to the field name. For example, "start_time desc". - # Redundant space characters in the syntax are insigificant. - # If order_by is empty, results will be sorted by `start_time` in descending - # order starting from the most recently created backup. + # An expression for specifying the sort order of the results of the request. The + # string value should specify one or more fields in Backup. The full syntax is + # described at https://aip.dev/132#ordering. Fields supported are: * name * + # source_table * expire_time * start_time * end_time * size_bytes * state For + # example, "start_time". The default sorting order is ascending. To specify + # descending order for the field, a suffix " desc" should be appended to the + # field name. For example, "start_time desc". Redundant space characters in the + # syntax are insigificant. If order_by is empty, results will be sorted by ` + # start_time` in descending order starting from the most recently created backup. # @param [Fixnum] page_size - # Number of backups to be returned in the response. If 0 or - # less, defaults to the server's maximum allowed page size. + # Number of backups to be returned in the response. If 0 or less, defaults to + # the server's maximum allowed page size. # @param [String] page_token - # If non-empty, `page_token` should contain a - # next_page_token from a - # previous ListBackupsResponse to the same `parent` and with the same - # `filter`. + # If non-empty, `page_token` should contain a next_page_token from a previous + # ListBackupsResponse to the same `parent` and with the same `filter`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1125,22 +1084,19 @@ module Google # Updates a pending or completed Cloud Bigtable Backup. # @param [String] name - # A globally unique identifier for the backup which cannot be - # changed. Values are of the form - # `projects/`project`/instances/`instance`/clusters/`cluster`/ - # backups/_a-zA-Z0-9*` - # The final segment of the name must be between 1 and 50 characters - # in length. - # The backup is stored in the cluster identified by the prefix of the backup - # name of the form - # `projects/`project`/instances/`instance`/clusters/`cluster``. + # A globally unique identifier for the backup which cannot be changed. Values + # are of the form `projects/`project`/instances/`instance`/clusters/`cluster`/ + # backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 + # characters in length. The backup is stored in the cluster identified by the + # prefix of the backup name of the form `projects/`project`/instances/`instance`/ + # clusters/`cluster``. # @param [Google::Apis::BigtableadminV2::Backup] backup_object # @param [String] update_mask - # Required. A mask specifying which fields (e.g. `expire_time`) in the - # Backup resource should be updated. This mask is relative to the Backup - # resource, not to the request message. The field mask must always be - # specified; this prevents any future fields from being erased accidentally - # by clients that do not know about them. + # Required. A mask specifying which fields (e.g. `expire_time`) in the Backup + # resource should be updated. This mask is relative to the Backup resource, not + # to the request message. The field mask must always be specified; this prevents + # any future fields from being erased accidentally by clients that do not know + # about them. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1171,11 +1127,11 @@ module Google execute_or_queue_command(command, &block) end - # Sets the access control policy on a Table resource. - # Replaces any existing policy. + # Sets the access control policy on a Table resource. Replaces any existing + # policy. # @param [String] resource - # REQUIRED: The resource for which the policy is being specified. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::BigtableadminV2::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1208,8 +1164,8 @@ module Google # Returns permissions that the caller has on the specified table resource. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::BigtableadminV2::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1241,13 +1197,12 @@ module Google end # Checks replication consistency based on a consistency token, that is, if - # replication has caught up based on the conditions specified in the token - # and the check request. + # replication has caught up based on the conditions specified in the token and + # the check request. # @param [String] name # Required. The unique name of the Table for which to check replication - # consistency. - # Values are of the form - # `projects/`project`/instances/`instance`/tables/`table``. + # consistency. Values are of the form `projects/`project`/instances/`instance`/ + # tables/`table``. # @param [Google::Apis::BigtableadminV2::CheckConsistencyRequest] check_consistency_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1278,12 +1233,11 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new table in the specified instance. - # The table can be created with a full set of initial column families, - # specified in the request. + # Creates a new table in the specified instance. The table can be created with a + # full set of initial column families, specified in the request. # @param [String] parent - # Required. The unique name of the instance in which to create the table. - # Values are of the form `projects/`project`/instances/`instance``. + # Required. The unique name of the instance in which to create the table. Values + # are of the form `projects/`project`/instances/`instance``. # @param [Google::Apis::BigtableadminV2::CreateTableRequest] create_table_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1316,9 +1270,8 @@ module Google # Permanently deletes a specified table and all of its data. # @param [String] name - # Required. The unique name of the table to be deleted. - # Values are of the form - # `projects/`project`/instances/`instance`/tables/`table``. + # Required. The unique name of the table to be deleted. Values are of the form ` + # projects/`project`/instances/`instance`/tables/`table``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1351,8 +1304,8 @@ module Google # particular prefix. # @param [String] name # Required. The unique name of the table on which to drop a range of rows. - # Values are of the form - # `projects/`project`/instances/`instance`/tables/`table``. + # Values are of the form `projects/`project`/instances/`instance`/tables/`table`` + # . # @param [Google::Apis::BigtableadminV2::DropRowRangeRequest] drop_row_range_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1384,13 +1337,13 @@ module Google end # Generates a consistency token for a Table, which can be used in - # CheckConsistency to check whether mutations to the table that finished - # before this call started have been replicated. The tokens will be available - # for 90 days. + # CheckConsistency to check whether mutations to the table that finished before + # this call started have been replicated. The tokens will be available for 90 + # days. # @param [String] name # Required. The unique name of the Table for which to create a consistency token. - # Values are of the form - # `projects/`project`/instances/`instance`/tables/`table``. + # Values are of the form `projects/`project`/instances/`instance`/tables/`table` + # `. # @param [Google::Apis::BigtableadminV2::GenerateConsistencyTokenRequest] generate_consistency_token_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1423,12 +1376,11 @@ module Google # Gets metadata information about the specified table. # @param [String] name - # Required. The unique name of the requested table. - # Values are of the form - # `projects/`project`/instances/`instance`/tables/`table``. + # Required. The unique name of the requested table. Values are of the form ` + # projects/`project`/instances/`instance`/tables/`table``. # @param [String] view - # The view to be applied to the returned table's fields. - # Defaults to `SCHEMA_VIEW` if unspecified. + # The view to be applied to the returned table's fields. Defaults to ` + # SCHEMA_VIEW` if unspecified. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1457,12 +1409,11 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a Table resource. - # Returns an empty policy if the resource exists but does not have a policy - # set. + # Gets the access control policy for a Table resource. Returns an empty policy + # if the resource exists but does not have a policy set. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::BigtableadminV2::GetIamPolicyRequest] get_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1498,18 +1449,17 @@ module Google # Required. The unique name of the instance for which tables should be listed. # Values are of the form `projects/`project`/instances/`instance``. # @param [Fixnum] page_size - # Maximum number of results per page. - # A page_size of zero lets the server choose the number of items to return. - # A page_size which is strictly positive will return at most that many items. - # A negative page_size will cause an error. - # Following the first request, subsequent paginated calls are not required - # to pass a page_size. If a page_size is set in subsequent calls, it must - # match the page_size given in the first request. + # Maximum number of results per page. A page_size of zero lets the server choose + # the number of items to return. A page_size which is strictly positive will + # return at most that many items. A negative page_size will cause an error. + # Following the first request, subsequent paginated calls are not required to + # pass a page_size. If a page_size is set in subsequent calls, it must match the + # page_size given in the first request. # @param [String] page_token # The value of `next_page_token` returned by a previous call. # @param [String] view - # The view to be applied to the returned tables' fields. - # Only NAME_ONLY view (default) and REPLICATION_VIEW are supported. + # The view to be applied to the returned tables' fields. Only NAME_ONLY view ( + # default) and REPLICATION_VIEW are supported. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1541,13 +1491,13 @@ module Google end # Performs a series of column family modifications on the specified table. - # Either all or none of the modifications will occur before this method - # returns, but data requests received prior to that point may see a table - # where only some modifications have taken effect. + # Either all or none of the modifications will occur before this method returns, + # but data requests received prior to that point may see a table where only some + # modifications have taken effect. # @param [String] name # Required. The unique name of the table whose families should be modified. - # Values are of the form - # `projects/`project`/instances/`instance`/tables/`table``. + # Values are of the form `projects/`project`/instances/`instance`/tables/`table`` + # . # @param [Google::Apis::BigtableadminV2::ModifyColumnFamiliesRequest] modify_column_families_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1578,18 +1528,15 @@ module Google execute_or_queue_command(command, &block) end - # Create a new table by restoring from a completed backup. The new table - # must be in the same instance as the instance containing the backup. The - # returned table long-running operation can - # be used to track the progress of the operation, and to cancel it. The - # metadata field type is - # RestoreTableMetadata. The - # response type is - # Table, if successful. + # Create a new table by restoring from a completed backup. The new table must be + # in the same instance as the instance containing the backup. The returned table + # long-running operation can be used to track the progress of the operation, and + # to cancel it. The metadata field type is RestoreTableMetadata. The response + # type is Table, if successful. # @param [String] parent - # Required. The name of the instance in which to create the restored - # table. This instance must be the parent of the source backup. Values are - # of the form `projects//instances/`. + # Required. The name of the instance in which to create the restored table. This + # instance must be the parent of the source backup. Values are of the form ` + # projects//instances/`. # @param [Google::Apis::BigtableadminV2::RestoreTableRequest] restore_table_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1620,11 +1567,11 @@ module Google execute_or_queue_command(command, &block) end - # Sets the access control policy on a Table resource. - # Replaces any existing policy. + # Sets the access control policy on a Table resource. Replaces any existing + # policy. # @param [String] resource - # REQUIRED: The resource for which the policy is being specified. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::BigtableadminV2::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1657,8 +1604,8 @@ module Google # Returns permissions that the caller has on the specified table resource. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::BigtableadminV2::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/binaryauthorization_v1.rb b/generated/google/apis/binaryauthorization_v1.rb index d5db597ec..dfd5f74f1 100644 --- a/generated/google/apis/binaryauthorization_v1.rb +++ b/generated/google/apis/binaryauthorization_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/binary-authorization/ module BinaryauthorizationV1 VERSION = 'V1' - REVISION = '20200807' + REVISION = '20200828' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/binaryauthorization_v1/classes.rb b/generated/google/apis/binaryauthorization_v1/classes.rb index 3dedcb92d..b36cd7058 100644 --- a/generated/google/apis/binaryauthorization_v1/classes.rb +++ b/generated/google/apis/binaryauthorization_v1/classes.rb @@ -177,6 +177,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: @@ -238,6 +244,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) diff --git a/generated/google/apis/binaryauthorization_v1/representations.rb b/generated/google/apis/binaryauthorization_v1/representations.rb index fafb81d54..c856006d6 100644 --- a/generated/google/apis/binaryauthorization_v1/representations.rb +++ b/generated/google/apis/binaryauthorization_v1/representations.rb @@ -153,6 +153,7 @@ module Google class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::BinaryauthorizationV1::Expr, decorator: Google::Apis::BinaryauthorizationV1::Expr::Representation collection :members, as: 'members' diff --git a/generated/google/apis/binaryauthorization_v1beta1.rb b/generated/google/apis/binaryauthorization_v1beta1.rb index ddbff12f0..e6f50c14d 100644 --- a/generated/google/apis/binaryauthorization_v1beta1.rb +++ b/generated/google/apis/binaryauthorization_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/binary-authorization/ module BinaryauthorizationV1beta1 VERSION = 'V1beta1' - REVISION = '20200807' + REVISION = '20200828' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/binaryauthorization_v1beta1/classes.rb b/generated/google/apis/binaryauthorization_v1beta1/classes.rb index e2054c4f4..55f8af9e4 100644 --- a/generated/google/apis/binaryauthorization_v1beta1/classes.rb +++ b/generated/google/apis/binaryauthorization_v1beta1/classes.rb @@ -177,6 +177,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: @@ -238,6 +244,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) diff --git a/generated/google/apis/binaryauthorization_v1beta1/representations.rb b/generated/google/apis/binaryauthorization_v1beta1/representations.rb index 7642e6c7d..45b2ddc23 100644 --- a/generated/google/apis/binaryauthorization_v1beta1/representations.rb +++ b/generated/google/apis/binaryauthorization_v1beta1/representations.rb @@ -153,6 +153,7 @@ module Google class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::BinaryauthorizationV1beta1::Expr, decorator: Google::Apis::BinaryauthorizationV1beta1::Expr::Representation collection :members, as: 'members' diff --git a/generated/google/apis/calendar_v3.rb b/generated/google/apis/calendar_v3.rb index a5cc3bacf..4257485a1 100644 --- a/generated/google/apis/calendar_v3.rb +++ b/generated/google/apis/calendar_v3.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/google-apps/calendar/firstapp module CalendarV3 VERSION = 'V3' - REVISION = '20200827' + REVISION = '20200902' # See, edit, share, and permanently delete all the calendars you can access using Google Calendar AUTH_CALENDAR = 'https://www.googleapis.com/auth/calendar' diff --git a/generated/google/apis/calendar_v3/classes.rb b/generated/google/apis/calendar_v3/classes.rb index 778eaac68..20688ce77 100644 --- a/generated/google/apis/calendar_v3/classes.rb +++ b/generated/google/apis/calendar_v3/classes.rb @@ -1111,7 +1111,8 @@ module Google # @return [Google::Apis::CalendarV3::Event::ExtendedProperties] attr_accessor :extended_properties - # A gadget that extends this event. + # A gadget that extends this event. Gadgets are deprecated; this structure is + # instead only used for returning birthday calendar metadata. # Corresponds to the JSON property `gadget` # @return [Google::Apis::CalendarV3::Event::Gadget] attr_accessor :gadget @@ -1431,11 +1432,12 @@ module Google end end - # A gadget that extends this event. + # A gadget that extends this event. Gadgets are deprecated; this structure is + # instead only used for returning birthday calendar metadata. class Gadget include Google::Apis::Core::Hashable - # The gadget's display mode. Optional. Possible values are: + # The gadget's display mode. Deprecated. Possible values are: # - "icon" - The gadget displays next to the event's title in the calendar view. # - "chip" - The gadget displays when the event is clicked. # Corresponds to the JSON property `display` @@ -1443,17 +1445,17 @@ module Google attr_accessor :display_mode # The gadget's height in pixels. The height must be an integer greater than 0. - # Optional. + # Optional. Deprecated. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height - # The gadget's icon URL. The URL scheme must be HTTPS. + # The gadget's icon URL. The URL scheme must be HTTPS. Deprecated. # Corresponds to the JSON property `iconLink` # @return [String] attr_accessor :icon_link - # The gadget's URL. The URL scheme must be HTTPS. + # The gadget's URL. The URL scheme must be HTTPS. Deprecated. # Corresponds to the JSON property `link` # @return [String] attr_accessor :link @@ -1463,18 +1465,18 @@ module Google # @return [Hash] attr_accessor :preferences - # The gadget's title. + # The gadget's title. Deprecated. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title - # The gadget's type. + # The gadget's type. Deprecated. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # The gadget's width in pixels. The width must be an integer greater than 0. - # Optional. + # Optional. Deprecated. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width diff --git a/generated/google/apis/civicinfo_v2.rb b/generated/google/apis/civicinfo_v2.rb index 7bab2a5cd..f7fcb34f2 100644 --- a/generated/google/apis/civicinfo_v2.rb +++ b/generated/google/apis/civicinfo_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/civic-information/ module CivicinfoV2 VERSION = 'V2' - REVISION = '20200824' + REVISION = '20200908' end end end diff --git a/generated/google/apis/civicinfo_v2/classes.rb b/generated/google/apis/civicinfo_v2/classes.rb index e7c519e60..1a54c6ea7 100644 --- a/generated/google/apis/civicinfo_v2/classes.rb +++ b/generated/google/apis/civicinfo_v2/classes.rb @@ -96,6 +96,18 @@ module Google # @return [String] attr_accessor :election_info_url + # A last minute or emergency notification text provided by this administrative + # body. + # Corresponds to the JSON property `electionNoticeText` + # @return [String] + attr_accessor :election_notice_text + + # A URL provided by this administrative body for additional information related + # to the last minute or emergency notification. + # Corresponds to the JSON property `electionNoticeUrl` + # @return [String] + attr_accessor :election_notice_url + # The election officials for this election administrative body. # Corresponds to the JSON property `electionOfficials` # @return [Array] @@ -154,6 +166,8 @@ module Google @ballot_info_url = args[:ballot_info_url] if args.key?(:ballot_info_url) @correspondence_address = args[:correspondence_address] if args.key?(:correspondence_address) @election_info_url = args[:election_info_url] if args.key?(:election_info_url) + @election_notice_text = args[:election_notice_text] if args.key?(:election_notice_text) + @election_notice_url = args[:election_notice_url] if args.key?(:election_notice_url) @election_officials = args[:election_officials] if args.key?(:election_officials) @election_registration_confirmation_url = args[:election_registration_confirmation_url] if args.key?(:election_registration_confirmation_url) @election_registration_url = args[:election_registration_url] if args.key?(:election_registration_url) @@ -838,18 +852,14 @@ module Google # @return [String] attr_accessor :id - # Latitude of the location, in degrees north of the equator. Only some locations - # -- generally, ballot drop boxes for vote-by-mail elections -- will have this - # set; for others, use a geocoding service like the Google Maps API to resolve - # the address to a geographic point. + # Latitude of the location, in degrees north of the equator. Note this field may + # not be available for some locations. # Corresponds to the JSON property `latitude` # @return [Float] attr_accessor :latitude - # Longitude of the location, in degrees east of the Prime Meridian. Only some - # locations -- generally, ballot drop boxes for vote-by-mail elections -- will - # have this set; for others, use a geocoding service like the Google Maps API to - # resolve the address to a geographic point. + # Longitude of the location, in degrees east of the Prime Meridian. Note this + # field may not be available for some locations. # Corresponds to the JSON property `longitude` # @return [Float] attr_accessor :longitude diff --git a/generated/google/apis/civicinfo_v2/representations.rb b/generated/google/apis/civicinfo_v2/representations.rb index d119c6883..1f1408495 100644 --- a/generated/google/apis/civicinfo_v2/representations.rb +++ b/generated/google/apis/civicinfo_v2/representations.rb @@ -164,6 +164,8 @@ module Google property :correspondence_address, as: 'correspondenceAddress', class: Google::Apis::CivicinfoV2::SimpleAddressType, decorator: Google::Apis::CivicinfoV2::SimpleAddressType::Representation property :election_info_url, as: 'electionInfoUrl' + property :election_notice_text, as: 'electionNoticeText' + property :election_notice_url, as: 'electionNoticeUrl' collection :election_officials, as: 'electionOfficials', class: Google::Apis::CivicinfoV2::ElectionOfficial, decorator: Google::Apis::CivicinfoV2::ElectionOfficial::Representation property :election_registration_confirmation_url, as: 'electionRegistrationConfirmationUrl' diff --git a/generated/google/apis/cloudasset_v1.rb b/generated/google/apis/cloudasset_v1.rb index b5d329f88..5e171e032 100644 --- a/generated/google/apis/cloudasset_v1.rb +++ b/generated/google/apis/cloudasset_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/asset-inventory/docs/quickstart module CloudassetV1 VERSION = 'V1' - REVISION = '20200810' + REVISION = '20200828' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudasset_v1beta1.rb b/generated/google/apis/cloudasset_v1beta1.rb index a789e0827..d8a999edf 100644 --- a/generated/google/apis/cloudasset_v1beta1.rb +++ b/generated/google/apis/cloudasset_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/asset-inventory/docs/quickstart module CloudassetV1beta1 VERSION = 'V1beta1' - REVISION = '20200810' + REVISION = '20200828' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudasset_v1p5beta1.rb b/generated/google/apis/cloudasset_v1p5beta1.rb index 1f75420b9..b13006db7 100644 --- a/generated/google/apis/cloudasset_v1p5beta1.rb +++ b/generated/google/apis/cloudasset_v1p5beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/asset-inventory/docs/quickstart module CloudassetV1p5beta1 VERSION = 'V1p5beta1' - REVISION = '20200810' + REVISION = '20200828' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudbuild_v1.rb b/generated/google/apis/cloudbuild_v1.rb index 8725a7cb7..bff5dc5d6 100644 --- a/generated/google/apis/cloudbuild_v1.rb +++ b/generated/google/apis/cloudbuild_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/cloud-build/docs/ module CloudbuildV1 VERSION = 'V1' - REVISION = '20200817' + REVISION = '20200910' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudbuild_v1/classes.rb b/generated/google/apis/cloudbuild_v1/classes.rb index c89f68dac..83cb535ae 100644 --- a/generated/google/apis/cloudbuild_v1/classes.rb +++ b/generated/google/apis/cloudbuild_v1/classes.rb @@ -177,6 +177,13 @@ module Google # @return [String] attr_accessor :logs_bucket + # Output only. The 'Build' name with format: `projects/`project`/locations/` + # location`/builds/`build``, where `build` is a unique identifier generated by + # the service. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + # Optional arguments to enable specific features of builds. # Corresponds to the JSON property `options` # @return [Google::Apis::CloudbuildV1::BuildOptions] @@ -283,6 +290,7 @@ module Google @images = args[:images] if args.key?(:images) @log_url = args[:log_url] if args.key?(:log_url) @logs_bucket = args[:logs_bucket] if args.key?(:logs_bucket) + @name = args[:name] if args.key?(:name) @options = args[:options] if args.key?(:options) @project_id = args[:project_id] if args.key?(:project_id) @queue_ttl = args[:queue_ttl] if args.key?(:queue_ttl) @@ -645,7 +653,7 @@ module Google attr_accessor :name # Substitutions for Build resource. The keys must match the following regular - # expression: `^_[A-Z0-9_]+$`.The keys cannot conflict with the keys in bindings. + # expression: `^_[A-Z0-9_]+$`. # Corresponds to the JSON property `substitutions` # @return [Hash] attr_accessor :substitutions @@ -718,12 +726,31 @@ module Google class CancelBuildRequest include Google::Apis::Core::Hashable + # Required. ID of the build. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # The name of the `Build` to retrieve. Format: `projects/`project`/locations/` + # location`/builds/`build`` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Required. ID of the project. + # Corresponds to the JSON property `projectId` + # @return [String] + attr_accessor :project_id + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @id = args[:id] if args.key?(:id) + @name = args[:name] if args.key?(:name) + @project_id = args[:project_id] if args.key?(:project_id) end end @@ -740,6 +767,40 @@ module Google end end + # Request to create a new build. + class CreateBuildRequest + include Google::Apis::Core::Hashable + + # A build resource in the Cloud Build API. At a high level, a `Build` describes + # where to find source code, how to build it (for example, the builder image to + # run on the source), and where to store the built artifacts. Fields can include + # the following variables, which will be expanded when the build is created: - $ + # PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID of + # the build. - $REPO_NAME: the source repository name specified by RepoSource. - + # $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag + # name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA + # specified by RepoSource or resolved from the specified branch or tag. - $ + # SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. + # Corresponds to the JSON property `build` + # @return [Google::Apis::CloudbuildV1::Build] + attr_accessor :build + + # Required. ID of the project. + # Corresponds to the JSON property `projectId` + # @return [String] + attr_accessor :project_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @build = args[:build] if args.key?(:build) + @project_id = args[:project_id] if args.key?(:project_id) + end + end + # A generic empty message that you can re-use to avoid defining duplicated empty # messages in your APIs. A typical example is to use it as the request or the # response type of an API method. For instance: service Foo ` rpc Bar(google. @@ -1370,12 +1431,31 @@ module Google class RetryBuildRequest include Google::Apis::Core::Hashable + # Required. Build ID of the original build. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # The name of the `Build` to retry. Format: `projects/`project`/locations/` + # location`/builds/`build`` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Required. ID of the project. + # Corresponds to the JSON property `projectId` + # @return [String] + attr_accessor :project_id + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @id = args[:id] if args.key?(:id) + @name = args[:name] if args.key?(:name) + @project_id = args[:project_id] if args.key?(:project_id) end end diff --git a/generated/google/apis/cloudbuild_v1/representations.rb b/generated/google/apis/cloudbuild_v1/representations.rb index 5eb2c8764..999fce6d7 100644 --- a/generated/google/apis/cloudbuild_v1/representations.rb +++ b/generated/google/apis/cloudbuild_v1/representations.rb @@ -88,6 +88,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class CreateBuildRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Empty class Representation < Google::Apis::Core::JsonRepresentation; end @@ -296,6 +302,7 @@ module Google collection :images, as: 'images' property :log_url, as: 'logUrl' property :logs_bucket, as: 'logsBucket' + property :name, as: 'name' property :options, as: 'options', class: Google::Apis::CloudbuildV1::BuildOptions, decorator: Google::Apis::CloudbuildV1::BuildOptions::Representation property :project_id, as: 'projectId' @@ -406,6 +413,9 @@ module Google class CancelBuildRequest # @private class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + property :name, as: 'name' + property :project_id, as: 'projectId' end end @@ -415,6 +425,15 @@ module Google end end + class CreateBuildRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :build, as: 'build', class: Google::Apis::CloudbuildV1::Build, decorator: Google::Apis::CloudbuildV1::Build::Representation + + property :project_id, as: 'projectId' + end + end + class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -595,6 +614,9 @@ module Google class RetryBuildRequest # @private class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + property :name, as: 'name' + property :project_id, as: 'projectId' end end diff --git a/generated/google/apis/cloudbuild_v1/service.rb b/generated/google/apis/cloudbuild_v1/service.rb index dbe9f5ba8..98d4bc918 100644 --- a/generated/google/apis/cloudbuild_v1/service.rb +++ b/generated/google/apis/cloudbuild_v1/service.rb @@ -160,6 +160,9 @@ module Google # @param [String] project_id # Required. ID of the project. # @param [Google::Apis::CloudbuildV1::Build] build_object + # @param [String] parent + # The parent resource where this build will be created. Format: `projects/` + # project`/locations/`location`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -177,13 +180,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_project_build(project_id, build_object = nil, fields: nil, quota_user: nil, options: nil, &block) + def create_project_build(project_id, build_object = nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/projects/{projectId}/builds', options) command.request_representation = Google::Apis::CloudbuildV1::Build::Representation command.request_object = build_object command.response_representation = Google::Apis::CloudbuildV1::Operation::Representation command.response_class = Google::Apis::CloudbuildV1::Operation command.params['projectId'] = project_id unless project_id.nil? + command.query['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) @@ -196,6 +200,9 @@ module Google # Required. ID of the project. # @param [String] id # Required. ID of the build. + # @param [String] name + # The name of the `Build` to retrieve. Format: `projects/`project`/locations/` + # location`/builds/`build`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -213,12 +220,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_build(project_id, id, fields: nil, quota_user: nil, options: nil, &block) + def get_project_build(project_id, id, name: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/projects/{projectId}/builds/{id}', options) command.response_representation = Google::Apis::CloudbuildV1::Build::Representation command.response_class = Google::Apis::CloudbuildV1::Build command.params['projectId'] = project_id unless project_id.nil? command.params['id'] = id unless id.nil? + command.query['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) @@ -234,6 +242,9 @@ module Google # Number of results to return in the list. # @param [String] page_token # Token to provide to skip to a particular spot in the list. + # @param [String] parent + # The parent of the collection of `Builds`. Format: `projects/`project`/ + # locations/location` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -251,7 +262,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_builds(project_id, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + def list_project_builds(project_id, filter: nil, page_size: nil, page_token: nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/projects/{projectId}/builds', options) command.response_representation = Google::Apis::CloudbuildV1::ListBuildsResponse::Representation command.response_class = Google::Apis::CloudbuildV1::ListBuildsResponse @@ -259,6 +270,7 @@ module Google command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) @@ -315,6 +327,208 @@ module Google execute_or_queue_command(command, &block) end + # Cancels a build in progress. + # @param [String] name + # The name of the `Build` to retrieve. Format: `projects/`project`/locations/` + # location`/builds/`build`` + # @param [Google::Apis::CloudbuildV1::CancelBuildRequest] cancel_build_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudbuildV1::Build] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudbuildV1::Build] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def cancel_project_location_build(name, cancel_build_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:cancel', options) + command.request_representation = Google::Apis::CloudbuildV1::CancelBuildRequest::Representation + command.request_object = cancel_build_request_object + command.response_representation = Google::Apis::CloudbuildV1::Build::Representation + command.response_class = Google::Apis::CloudbuildV1::Build + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Starts a build with the specified configuration. This method returns a long- + # running `Operation`, which includes the build ID. Pass the build ID to ` + # GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). + # @param [String] parent + # The parent resource where this build will be created. Format: `projects/` + # project`/locations/`location`` + # @param [Google::Apis::CloudbuildV1::CreateBuildRequest] create_build_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudbuildV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudbuildV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_build(parent, create_build_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/builds', options) + command.request_representation = Google::Apis::CloudbuildV1::CreateBuildRequest::Representation + command.request_object = create_build_request_object + command.response_representation = Google::Apis::CloudbuildV1::Operation::Representation + command.response_class = Google::Apis::CloudbuildV1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns information about a previously requested build. The `Build` that is + # returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and + # timing information. + # @param [String] name + # The name of the `Build` to retrieve. Format: `projects/`project`/locations/` + # location`/builds/`build`` + # @param [String] id + # Required. ID of the build. + # @param [String] project_id + # Required. ID of the project. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudbuildV1::Build] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudbuildV1::Build] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_build(name, id: nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::CloudbuildV1::Build::Representation + command.response_class = Google::Apis::CloudbuildV1::Build + command.params['name'] = name unless name.nil? + command.query['id'] = id unless id.nil? + command.query['projectId'] = project_id unless project_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists previously requested builds. Previously requested builds may still be in- + # progress, or may have finished successfully or unsuccessfully. + # @param [String] parent + # The parent of the collection of `Builds`. Format: `projects/`project`/ + # locations/location` + # @param [String] filter + # The raw filter text to constrain the results. + # @param [Fixnum] page_size + # Number of results to return in the list. + # @param [String] page_token + # Token to provide to skip to a particular spot in the list. + # @param [String] project_id + # Required. ID of the project. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudbuildV1::ListBuildsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudbuildV1::ListBuildsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_builds(parent, filter: nil, page_size: nil, page_token: nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/builds', options) + command.response_representation = Google::Apis::CloudbuildV1::ListBuildsResponse::Representation + command.response_class = Google::Apis::CloudbuildV1::ListBuildsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['projectId'] = project_id unless project_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new build based on the specified build. This method creates a new + # build using the original build request, which may or may not result in an + # identical build. For triggered builds: * Triggered builds resolve to a precise + # revision; therefore a retry of a triggered build will result in a build that + # uses the same revision. For non-triggered builds that specify `RepoSource`: * + # If the original build built from the tip of a branch, the retried build will + # build from the tip of that branch, which may not be the same revision as the + # original build. * If the original build specified a commit sha or revision ID, + # the retried build will use the identical source. For builds that specify ` + # StorageSource`: * If the original build pulled source from Google Cloud + # Storage without specifying the generation of the object, the new build will + # use the current object, which may be different from the original build source. + # * If the original build pulled source from Cloud Storage and specified the + # generation of the object, the new build will attempt to use the same object, + # which may or may not be available depending on the bucket's lifecycle + # management settings. + # @param [String] name + # The name of the `Build` to retry. Format: `projects/`project`/locations/` + # location`/builds/`build`` + # @param [Google::Apis::CloudbuildV1::RetryBuildRequest] retry_build_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudbuildV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudbuildV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def retry_project_location_build(name, retry_build_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:retry', options) + command.request_representation = Google::Apis::CloudbuildV1::RetryBuildRequest::Representation + command.request_object = retry_build_request_object + command.response_representation = Google::Apis::CloudbuildV1::Operation::Representation + command.response_class = Google::Apis::CloudbuildV1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Starts asynchronous cancellation on a long-running operation. The server makes # a best effort to cancel the operation, but success is not guaranteed. If the # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. diff --git a/generated/google/apis/cloudbuild_v1alpha1.rb b/generated/google/apis/cloudbuild_v1alpha1.rb index 179cdd8c7..47d66aa74 100644 --- a/generated/google/apis/cloudbuild_v1alpha1.rb +++ b/generated/google/apis/cloudbuild_v1alpha1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/cloud-build/docs/ module CloudbuildV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200824' + REVISION = '20200831' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudbuild_v1alpha1/classes.rb b/generated/google/apis/cloudbuild_v1alpha1/classes.rb index c32a79c87..dac37eb8f 100644 --- a/generated/google/apis/cloudbuild_v1alpha1/classes.rb +++ b/generated/google/apis/cloudbuild_v1alpha1/classes.rb @@ -177,6 +177,13 @@ module Google # @return [String] attr_accessor :logs_bucket + # Output only. The 'Build' name with format: `projects/`project`/locations/` + # location`/builds/`build``, where `build` is a unique identifier generated by + # the service. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + # Optional arguments to enable specific features of builds. # Corresponds to the JSON property `options` # @return [Google::Apis::CloudbuildV1alpha1::BuildOptions] @@ -283,6 +290,7 @@ module Google @images = args[:images] if args.key?(:images) @log_url = args[:log_url] if args.key?(:log_url) @logs_bucket = args[:logs_bucket] if args.key?(:logs_bucket) + @name = args[:name] if args.key?(:name) @options = args[:options] if args.key?(:options) @project_id = args[:project_id] if args.key?(:project_id) @queue_ttl = args[:queue_ttl] if args.key?(:queue_ttl) diff --git a/generated/google/apis/cloudbuild_v1alpha1/representations.rb b/generated/google/apis/cloudbuild_v1alpha1/representations.rb index 325575662..f442b8d95 100644 --- a/generated/google/apis/cloudbuild_v1alpha1/representations.rb +++ b/generated/google/apis/cloudbuild_v1alpha1/representations.rb @@ -272,6 +272,7 @@ module Google collection :images, as: 'images' property :log_url, as: 'logUrl' property :logs_bucket, as: 'logsBucket' + property :name, as: 'name' property :options, as: 'options', class: Google::Apis::CloudbuildV1alpha1::BuildOptions, decorator: Google::Apis::CloudbuildV1alpha1::BuildOptions::Representation property :project_id, as: 'projectId' diff --git a/generated/google/apis/cloudbuild_v1alpha2.rb b/generated/google/apis/cloudbuild_v1alpha2.rb index 28108cfad..f72d444a7 100644 --- a/generated/google/apis/cloudbuild_v1alpha2.rb +++ b/generated/google/apis/cloudbuild_v1alpha2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/cloud-build/docs/ module CloudbuildV1alpha2 VERSION = 'V1alpha2' - REVISION = '20200824' + REVISION = '20200831' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudbuild_v1alpha2/classes.rb b/generated/google/apis/cloudbuild_v1alpha2/classes.rb index 3129477af..d7a6c0b85 100644 --- a/generated/google/apis/cloudbuild_v1alpha2/classes.rb +++ b/generated/google/apis/cloudbuild_v1alpha2/classes.rb @@ -177,6 +177,13 @@ module Google # @return [String] attr_accessor :logs_bucket + # Output only. The 'Build' name with format: `projects/`project`/locations/` + # location`/builds/`build``, where `build` is a unique identifier generated by + # the service. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + # Optional arguments to enable specific features of builds. # Corresponds to the JSON property `options` # @return [Google::Apis::CloudbuildV1alpha2::BuildOptions] @@ -283,6 +290,7 @@ module Google @images = args[:images] if args.key?(:images) @log_url = args[:log_url] if args.key?(:log_url) @logs_bucket = args[:logs_bucket] if args.key?(:logs_bucket) + @name = args[:name] if args.key?(:name) @options = args[:options] if args.key?(:options) @project_id = args[:project_id] if args.key?(:project_id) @queue_ttl = args[:queue_ttl] if args.key?(:queue_ttl) diff --git a/generated/google/apis/cloudbuild_v1alpha2/representations.rb b/generated/google/apis/cloudbuild_v1alpha2/representations.rb index 370ef8165..32b234d19 100644 --- a/generated/google/apis/cloudbuild_v1alpha2/representations.rb +++ b/generated/google/apis/cloudbuild_v1alpha2/representations.rb @@ -272,6 +272,7 @@ module Google collection :images, as: 'images' property :log_url, as: 'logUrl' property :logs_bucket, as: 'logsBucket' + property :name, as: 'name' property :options, as: 'options', class: Google::Apis::CloudbuildV1alpha2::BuildOptions, decorator: Google::Apis::CloudbuildV1alpha2::BuildOptions::Representation property :project_id, as: 'projectId' diff --git a/generated/google/apis/clouderrorreporting_v1beta1.rb b/generated/google/apis/clouderrorreporting_v1beta1.rb index 8ba4890a0..22007fa7c 100644 --- a/generated/google/apis/clouderrorreporting_v1beta1.rb +++ b/generated/google/apis/clouderrorreporting_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/error-reporting/ module ClouderrorreportingV1beta1 VERSION = 'V1beta1' - REVISION = '20200806' + REVISION = '20200827' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudidentity_v1.rb b/generated/google/apis/cloudidentity_v1.rb index 3042b94d0..7cab4a0de 100644 --- a/generated/google/apis/cloudidentity_v1.rb +++ b/generated/google/apis/cloudidentity_v1.rb @@ -25,7 +25,10 @@ module Google # @see https://cloud.google.com/identity/ module CloudidentityV1 VERSION = 'V1' - REVISION = '20200814' + REVISION = '20200908' + + # See your device details + AUTH_CLOUD_IDENTITY_DEVICES_LOOKUP = 'https://www.googleapis.com/auth/cloud-identity.devices.lookup' # See, change, create, and delete any of the Cloud Identity Groups that you can access, including the members of each group AUTH_CLOUD_IDENTITY_GROUPS = 'https://www.googleapis.com/auth/cloud-identity.groups' diff --git a/generated/google/apis/cloudidentity_v1/classes.rb b/generated/google/apis/cloudidentity_v1/classes.rb index 1ac7107bb..db2aaab64 100644 --- a/generated/google/apis/cloudidentity_v1/classes.rb +++ b/generated/google/apis/cloudidentity_v1/classes.rb @@ -97,6 +97,29 @@ module Google end end + # Request message for approving the device to access user data. + class GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest + include Google::Apis::Core::Hashable + + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # Corresponds to the JSON property `customer` + # @return [String] + attr_accessor :customer + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @customer = args[:customer] if args.key?(:customer) + end + end + # Response message for approving the device to access user data. class GoogleAppsCloudidentityDevicesV1ApproveDeviceUserResponse include Google::Apis::Core::Hashable @@ -117,6 +140,29 @@ module Google end end + # Request message for blocking account on device. + class GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest + include Google::Apis::Core::Hashable + + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # Corresponds to the JSON property `customer` + # @return [String] + attr_accessor :customer + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @customer = args[:customer] if args.key?(:customer) + end + end + # Response message for blocking the device from accessing user data. class GoogleAppsCloudidentityDevicesV1BlockDeviceUserResponse include Google::Apis::Core::Hashable @@ -137,6 +183,29 @@ module Google end end + # Request message for cancelling an unfinished device wipe. + class GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest + include Google::Apis::Core::Hashable + + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # Corresponds to the JSON property `customer` + # @return [String] + attr_accessor :customer + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @customer = args[:customer] if args.key?(:customer) + end + end + # Response message for cancelling an unfinished device wipe. class GoogleAppsCloudidentityDevicesV1CancelWipeDeviceResponse include Google::Apis::Core::Hashable @@ -158,6 +227,29 @@ module Google end end + # Request message for cancelling an unfinished user account wipe. + class GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest + include Google::Apis::Core::Hashable + + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # Corresponds to the JSON property `customer` + # @return [String] + attr_accessor :customer + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @customer = args[:customer] if args.key?(:customer) + end + end + # Response message for cancelling an unfinished user account wipe. class GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserResponse include Google::Apis::Core::Hashable @@ -210,7 +302,10 @@ module Google # @return [String] attr_accessor :etag - # The Health score of the resource + # The Health score of the resource. The Health score is the callers + # specification of the condition of the device from a usability point of view. + # For example, a third-party device management provider may specify a health + # score based on its compliance with organizational policies. # Corresponds to the JSON property `healthScore` # @return [String] attr_accessor :health_score @@ -235,7 +330,17 @@ module Google # Output only. [Resource name](https://cloud.google.com/apis/design/ # resource_names) of the ClientState in format: `devices/`device_id`/deviceUsers/ # `device_user_id`/clientState/`partner_id``, where partner_id corresponds to - # the partner storing the data. + # the partner storing the data. For partners belonging to the "BeyondCorp + # Alliance", this is the partner ID specified to you by Google. For all other + # callers, this is a string of the form: ``customer_id`-suffix`, where ` + # customer_id` is your customer ID. The *suffix* is any string the caller + # specifies. This string will be displayed verbatim in the administration + # console. This suffix is used in setting up Custom Access Levels in Context- + # Aware Access. Your organization's customer ID can be obtained from the URL: ` + # GET https://www.googleapis.com/admin/directory/v1/customers/my_customer` The ` + # id` field in the response contains the customer ID starting with the letter 'C' + # . The customer ID to be used in this API is the string after the letter 'C' ( + # not including 'C') # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -572,6 +677,140 @@ module Google end end + # Response message that is returned in ListClientStates. + class GoogleAppsCloudidentityDevicesV1ListClientStatesResponse + include Google::Apis::Core::Hashable + + # Client states meeting the list restrictions. + # Corresponds to the JSON property `clientStates` + # @return [Array] + attr_accessor :client_states + + # Token to retrieve the next page of results. Empty if there are no more results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @client_states = args[:client_states] if args.key?(:client_states) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Response message that is returned from the ListDeviceUsers method. + class GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse + include Google::Apis::Core::Hashable + + # Devices meeting the list restrictions. + # Corresponds to the JSON property `deviceUsers` + # @return [Array] + attr_accessor :device_users + + # Token to retrieve the next page of results. Empty if there are no more results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @device_users = args[:device_users] if args.key?(:device_users) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Response message that is returned from the ListDevices method. + class GoogleAppsCloudidentityDevicesV1ListDevicesResponse + include Google::Apis::Core::Hashable + + # Devices meeting the list restrictions. + # Corresponds to the JSON property `devices` + # @return [Array] + attr_accessor :devices + + # Token to retrieve the next page of results. Empty if there are no more results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @devices = args[:devices] if args.key?(:devices) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Response containing resource names of the DeviceUsers associated with the + # caller's credentials. + class GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse + include Google::Apis::Core::Hashable + + # The obfuscated customer Id that may be passed back to other Devices API + # methods such as List, Get, etc. + # Corresponds to the JSON property `customer` + # @return [String] + attr_accessor :customer + + # [Resource names](https://cloud.google.com/apis/design/resource_names) of the + # DeviceUsers in the format: `devices/`device_id`/deviceUsers/`user_resource_id`` + # , where device_id is the unique ID assigned to a Device and user_resource_id + # is the unique user ID + # Corresponds to the JSON property `names` + # @return [Array] + attr_accessor :names + + # Token to retrieve the next page of results. Empty if there are no more results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @customer = args[:customer] if args.key?(:customer) + @names = args[:names] if args.key?(:names) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Request message for wiping all data on the device. + class GoogleAppsCloudidentityDevicesV1WipeDeviceRequest + include Google::Apis::Core::Hashable + + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # Corresponds to the JSON property `customer` + # @return [String] + attr_accessor :customer + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @customer = args[:customer] if args.key?(:customer) + end + end + # Response message for wiping all data on the device. class GoogleAppsCloudidentityDevicesV1WipeDeviceResponse include Google::Apis::Core::Hashable @@ -593,6 +832,29 @@ module Google end end + # Request message for starting an account wipe on device. + class GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest + include Google::Apis::Core::Hashable + + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # Corresponds to the JSON property `customer` + # @return [String] + attr_accessor :customer + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @customer = args[:customer] if args.key?(:customer) + end + end + # Response message for wiping the user's account from the device. class GoogleAppsCloudidentityDevicesV1WipeDeviceUserResponse include Google::Apis::Core::Hashable @@ -812,6 +1074,11 @@ module Google # @return [Array] attr_accessor :roles + # Output only. The type of the membership. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + # Output only. Last updated timestamp of the Membership. Output only. # Corresponds to the JSON property `updateTime` # @return [String] @@ -827,6 +1094,7 @@ module Google @name = args[:name] if args.key?(:name) @preferred_member_key = args[:preferred_member_key] if args.key?(:preferred_member_key) @roles = args[:roles] if args.key?(:roles) + @type = args[:type] if args.key?(:type) @update_time = args[:update_time] if args.key?(:update_time) end end diff --git a/generated/google/apis/cloudidentity_v1/representations.rb b/generated/google/apis/cloudidentity_v1/representations.rb index de267444e..c39e58253 100644 --- a/generated/google/apis/cloudidentity_v1/representations.rb +++ b/generated/google/apis/cloudidentity_v1/representations.rb @@ -34,24 +34,48 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleAppsCloudidentityDevicesV1ApproveDeviceUserResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleAppsCloudidentityDevicesV1BlockDeviceUserResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleAppsCloudidentityDevicesV1CancelWipeDeviceResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -82,12 +106,48 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleAppsCloudidentityDevicesV1ListClientStatesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleAppsCloudidentityDevicesV1ListDevicesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleAppsCloudidentityDevicesV1WipeDeviceRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleAppsCloudidentityDevicesV1WipeDeviceResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleAppsCloudidentityDevicesV1WipeDeviceUserResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -172,6 +232,13 @@ module Google end end + class GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :customer, as: 'customer' + end + end + class GoogleAppsCloudidentityDevicesV1ApproveDeviceUserResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -180,6 +247,13 @@ module Google end end + class GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :customer, as: 'customer' + end + end + class GoogleAppsCloudidentityDevicesV1BlockDeviceUserResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -188,6 +262,13 @@ module Google end end + class GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :customer, as: 'customer' + end + end + class GoogleAppsCloudidentityDevicesV1CancelWipeDeviceResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -196,6 +277,13 @@ module Google end end + class GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :customer, as: 'customer' + end + end + class GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -283,6 +371,49 @@ module Google end end + class GoogleAppsCloudidentityDevicesV1ListClientStatesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :client_states, as: 'clientStates', class: Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ClientState, decorator: Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ClientState::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :device_users, as: 'deviceUsers', class: Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1DeviceUser, decorator: Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1DeviceUser::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class GoogleAppsCloudidentityDevicesV1ListDevicesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :devices, as: 'devices', class: Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1Device, decorator: Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1Device::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :customer, as: 'customer' + collection :names, as: 'names' + property :next_page_token, as: 'nextPageToken' + end + end + + class GoogleAppsCloudidentityDevicesV1WipeDeviceRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :customer, as: 'customer' + end + end + class GoogleAppsCloudidentityDevicesV1WipeDeviceResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -291,6 +422,13 @@ module Google end end + class GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :customer, as: 'customer' + end + end + class GoogleAppsCloudidentityDevicesV1WipeDeviceUserResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -355,6 +493,7 @@ module Google collection :roles, as: 'roles', class: Google::Apis::CloudidentityV1::MembershipRole, decorator: Google::Apis::CloudidentityV1::MembershipRole::Representation + property :type, as: 'type' property :update_time, as: 'updateTime' end end diff --git a/generated/google/apis/cloudidentity_v1/service.rb b/generated/google/apis/cloudidentity_v1/service.rb index 892712e60..13e584379 100644 --- a/generated/google/apis/cloudidentity_v1/service.rb +++ b/generated/google/apis/cloudidentity_v1/service.rb @@ -47,6 +47,765 @@ module Google @batch_path = 'batch' end + # Cancels an unfinished device wipe. This operation can be used to cancel device + # wipe in the gap between the wipe operation returning success and the device + # being wiped. This operation is possible when the device is in a "pending wipe" + # state. The device enters the "pending wipe" state when a wipe device command + # is issued, but has not yet been sent to the device. The cancel wipe will fail + # if the wipe command has already been issued to the device. + # @param [String] name + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the Device in format: `devices/`device_id``, where device_id is the unique + # ID assigned to the Device, and device_user_id is the unique ID assigned to the + # User. + # @param [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest] google_apps_cloudidentity_devices_v1_cancel_wipe_device_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def cancel_device_wipe(name, google_apps_cloudidentity_devices_v1_cancel_wipe_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:cancelWipe', options) + command.request_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest::Representation + command.request_object = google_apps_cloudidentity_devices_v1_cancel_wipe_device_request_object + command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation + command.response_class = Google::Apis::CloudidentityV1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a device. Only company-owned device may be created. + # @param [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1Device] google_apps_cloudidentity_devices_v1_device_object + # @param [String] customer + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_device(google_apps_cloudidentity_devices_v1_device_object = nil, customer: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/devices', options) + command.request_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1Device::Representation + command.request_object = google_apps_cloudidentity_devices_v1_device_object + command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation + command.response_class = Google::Apis::CloudidentityV1::Operation + command.query['customer'] = customer unless customer.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specified device. + # @param [String] name + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the Device in format: `devices/`device_id``, where device_id is the unique + # ID assigned to the Device. + # @param [String] customer + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_device(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation + command.response_class = Google::Apis::CloudidentityV1::Operation + command.params['name'] = name unless name.nil? + command.query['customer'] = customer unless customer.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the specified device. + # @param [String] name + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the Device in the format: `devices/`device_id``, where device_id is the + # unique ID assigned to the Device. + # @param [String] customer + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the Customer in the format: `customers/`customer_id``, where customer_id is + # the customer to whom the device belongs. If you're using this API for your own + # organization, use `customers/my_customer`. If you're using this API to manage + # another organization, use `customers/`customer_id``, where customer_id is the + # customer to whom the device belongs. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1Device] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1Device] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_device(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1Device::Representation + command.response_class = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1Device + command.params['name'] = name unless name.nil? + command.query['customer'] = customer unless customer.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists/Searches devices. + # @param [String] customer + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer in the format: `customers/`customer_id``, where customer_id is + # the customer to whom the device belongs. If you're using this API for your own + # organization, use `customers/my_customer`. If you're using this API to manage + # another organization, use `customers/`customer_id``, where customer_id is the + # customer to whom the device belongs. + # @param [String] filter + # Optional. Additional restrictions when fetching list of devices. [Help Center + # article link](https://support.google.com/a/answer/7549103) + # @param [String] order_by + # Optional. Order specification for devices in the response. Only one of the + # following field names may be used to specify the order: `create_time`, ` + # last_sync_time`, `model`, `os_version`, `device_type` and `serial_number`. ` + # desc` may be specified optionally at the end to specify results to be sorted + # in descending order. Default order is ascending. + # @param [Fixnum] page_size + # Optional. The maximum number of Devices to return. If unspecified, at most 20 + # Devices will be returned. The maximum value is 100; values above 100 will be + # coerced to 100. + # @param [String] page_token + # Optional. A page token, received from a previous `ListDevices` call. Provide + # this to retrieve the subsequent page. When paginating, all other parameters + # provided to `ListDevices` must match the call that provided the page token. + # @param [String] view + # Optional. The view to use for the List request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListDevicesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListDevicesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_devices(customer: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/devices', options) + command.response_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListDevicesResponse::Representation + command.response_class = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListDevicesResponse + command.query['customer'] = customer unless customer.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['view'] = view unless view.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Wipes all data on the specified device. + # @param [String] name + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``, + # where device_id is the unique ID assigned to the Device, and device_user_id is + # the unique ID assigned to the User. + # @param [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1WipeDeviceRequest] google_apps_cloudidentity_devices_v1_wipe_device_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def wipe_device(name, google_apps_cloudidentity_devices_v1_wipe_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:wipe', options) + command.request_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1WipeDeviceRequest::Representation + command.request_object = google_apps_cloudidentity_devices_v1_wipe_device_request_object + command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation + command.response_class = Google::Apis::CloudidentityV1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Approves device to access user data. + # @param [String] name + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``, + # where device_id is the unique ID assigned to the Device, and device_user_id is + # the unique ID assigned to the User. + # @param [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest] google_apps_cloudidentity_devices_v1_approve_device_user_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def approve_device_device_user(name, google_apps_cloudidentity_devices_v1_approve_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:approve', options) + command.request_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest::Representation + command.request_object = google_apps_cloudidentity_devices_v1_approve_device_user_request_object + command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation + command.response_class = Google::Apis::CloudidentityV1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Blocks device from accessing user data + # @param [String] name + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``, + # where device_id is the unique ID assigned to the Device, and device_user_id is + # the unique ID assigned to the User. + # @param [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest] google_apps_cloudidentity_devices_v1_block_device_user_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def block_device_device_user(name, google_apps_cloudidentity_devices_v1_block_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:block', options) + command.request_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest::Representation + command.request_object = google_apps_cloudidentity_devices_v1_block_device_user_request_object + command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation + command.response_class = Google::Apis::CloudidentityV1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Cancels an unfinished user account wipe. This operation can be used to cancel + # device wipe in the gap between the wipe operation returning success and the + # device being wiped. + # @param [String] name + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``, + # where device_id is the unique ID assigned to the Device, and device_user_id is + # the unique ID assigned to the User. + # @param [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest] google_apps_cloudidentity_devices_v1_cancel_wipe_device_user_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def cancel_device_device_user_wipe(name, google_apps_cloudidentity_devices_v1_cancel_wipe_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:cancelWipe', options) + command.request_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest::Representation + command.request_object = google_apps_cloudidentity_devices_v1_cancel_wipe_device_user_request_object + command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation + command.response_class = Google::Apis::CloudidentityV1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specified DeviceUser. This also revokes the user's access to + # device data. + # @param [String] name + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``, + # where device_id is the unique ID assigned to the Device, and device_user_id is + # the unique ID assigned to the User. + # @param [String] customer + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_device_device_user(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation + command.response_class = Google::Apis::CloudidentityV1::Operation + command.params['name'] = name unless name.nil? + command.query['customer'] = customer unless customer.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the specified DeviceUser + # @param [String] name + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``, + # where device_id is the unique ID assigned to the Device, and device_user_id is + # the unique ID assigned to the User. + # @param [String] customer + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1DeviceUser] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1DeviceUser] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_device_device_user(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1DeviceUser::Representation + command.response_class = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1DeviceUser + command.params['name'] = name unless name.nil? + command.query['customer'] = customer unless customer.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists/Searches DeviceUsers. + # @param [String] parent + # Required. To list all DeviceUsers, set this to "devices/-". To list all + # DeviceUsers owned by a device, set this to the resource name of the device. + # Format: devices/`device` + # @param [String] customer + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # @param [String] filter + # Optional. Additional restrictions when fetching list of devices. [HC article]( + # https://support.google.com/a/answer/7549103) + # @param [String] order_by + # Optional. Order specification for devices in the response. + # @param [Fixnum] page_size + # Optional. The maximum number of DeviceUsers to return. If unspecified, at most + # 5 DeviceUsers will be returned. The maximum value is 20; values above 20 will + # be coerced to 20. + # @param [String] page_token + # Optional. A page token, received from a previous `ListDeviceUsers` call. + # Provide this to retrieve the subsequent page. When paginating, all other + # parameters provided to `ListBooks` must match the call that provided the page + # token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_device_device_users(parent, customer: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/deviceUsers', options) + command.response_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse::Representation + command.response_class = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse + command.params['parent'] = parent unless parent.nil? + command.query['customer'] = customer unless customer.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Looks up resource names of the DeviceUsers associated with the caller's + # credentials, as well as the properties provided in the request. This method + # must be called with end-user credentials with the scope: https://www. + # googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are + # provided, only DeviceUsers having all of these properties are considered as + # matches - i.e. the query behaves like an AND. Different platforms require + # different amounts of information from the caller to ensure that the DeviceUser + # is uniquely identified. - iOS: No properties need to be passed, the caller's + # credentials are sufficient to identify the corresponding DeviceUser. - Android: + # Specifying the 'android_id' field is required. - Desktop: Specifying the ' + # raw_resource_id' field is required. + # @param [String] parent + # Must be set to "devices/-/deviceUsers" to search across all DeviceUser + # belonging to the user. + # @param [String] android_id + # Android Id returned by [Settings.Secure#ANDROID_ID](https://developer.android. + # com/reference/android/provider/Settings.Secure.html#ANDROID_ID). + # @param [Fixnum] page_size + # The maximum number of DeviceUsers to return. If unspecified, at most 20 + # DeviceUsers will be returned. The maximum value is 20; values above 20 will be + # coerced to 20. + # @param [String] page_token + # A page token, received from a previous `LookupDeviceUsers` call. Provide this + # to retrieve the subsequent page. When paginating, all other parameters + # provided to `LookupDeviceUsers` must match the call that provided the page + # token. + # @param [String] raw_resource_id + # Raw Resource Id used by Google Endpoint Verification. If the user is enrolled + # into Google Endpoint Verification, this id will be saved as the ' + # device_resource_id' field in the following platform dependent files. Mac: ~/. + # secureConnect/context_aware_config.json Windows: C:\Users\%USERPROFILE%\. + # secureConnect\context_aware_config.json Linux: ~/.secureConnect/ + # context_aware_config.json + # @param [String] user_id + # The user whose DeviceUser's resource name will be fetched. Must be set to 'me' + # to fetch the DeviceUser's resource name for the calling user. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def lookup_device_device_user(parent, android_id: nil, page_size: nil, page_token: nil, raw_resource_id: nil, user_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}:lookup', options) + command.response_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse::Representation + command.response_class = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse + command.params['parent'] = parent unless parent.nil? + command.query['androidId'] = android_id unless android_id.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['rawResourceId'] = raw_resource_id unless raw_resource_id.nil? + command.query['userId'] = user_id unless user_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Wipes the user's account on a device. Other data on the device that is not + # associated with the user's work account is not affected. For example, if a + # Gmail app is installed on a device that is used for personal and work purposes, + # and the user is logged in to the Gmail app with their personal account as + # well as their work account, wiping the "deviceUser" by their work + # administrator will not affect their personal account within Gmail or other + # apps such as Photos. + # @param [String] name + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``, + # where device_id is the unique ID assigned to the Device, and device_user_id is + # the unique ID assigned to the User. + # @param [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest] google_apps_cloudidentity_devices_v1_wipe_device_user_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def wipe_device_device_user(name, google_apps_cloudidentity_devices_v1_wipe_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:wipe', options) + command.request_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest::Representation + command.request_object = google_apps_cloudidentity_devices_v1_wipe_device_user_request_object + command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation + command.response_class = Google::Apis::CloudidentityV1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the client state for the device user + # @param [String] name + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the ClientState in format: `devices/`device_id`/deviceUsers/`device_user_id` + # /clientStates/`partner_id``, where device_id is the unique ID assigned to the + # Device, device_user_id is the unique ID assigned to the User and partner_id + # identifies the partner storing the data. + # @param [String] customer + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ClientState] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ClientState] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_device_device_user_client_state(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ClientState::Representation + command.response_class = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ClientState + command.params['name'] = name unless name.nil? + command.query['customer'] = customer unless customer.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the client states for the given search query. + # @param [String] parent + # Required. To list all ClientStates, set this to "devices/-/deviceUsers/-". To + # list all ClientStates owned by a DeviceUser, set this to the resource name of + # the DeviceUser. Format: devices/`device`/deviceUsers/`deviceUser` + # @param [String] customer + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # @param [String] filter + # Optional. Additional restrictions when fetching list of client states. + # @param [String] order_by + # Optional. Order specification for client states in the response. + # @param [String] page_token + # Optional. A page token, received from a previous `ListClientStates` call. + # Provide this to retrieve the subsequent page. When paginating, all other + # parameters provided to `ListClientStates` must match the call that provided + # the page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListClientStatesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListClientStatesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_device_device_user_client_states(parent, customer: nil, filter: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/clientStates', options) + command.response_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListClientStatesResponse::Representation + command.response_class = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ListClientStatesResponse + command.params['parent'] = parent unless parent.nil? + command.query['customer'] = customer unless customer.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the client state for the device user + # @param [String] name + # Output only. [Resource name](https://cloud.google.com/apis/design/ + # resource_names) of the ClientState in format: `devices/`device_id`/deviceUsers/ + # `device_user_id`/clientState/`partner_id``, where partner_id corresponds to + # the partner storing the data. For partners belonging to the "BeyondCorp + # Alliance", this is the partner ID specified to you by Google. For all other + # callers, this is a string of the form: ``customer_id`-suffix`, where ` + # customer_id` is your customer ID. The *suffix* is any string the caller + # specifies. This string will be displayed verbatim in the administration + # console. This suffix is used in setting up Custom Access Levels in Context- + # Aware Access. Your organization's customer ID can be obtained from the URL: ` + # GET https://www.googleapis.com/admin/directory/v1/customers/my_customer` The ` + # id` field in the response contains the customer ID starting with the letter 'C' + # . The customer ID to be used in this API is the string after the letter 'C' ( + # not including 'C') + # @param [Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ClientState] google_apps_cloudidentity_devices_v1_client_state_object + # @param [String] customer + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # @param [String] update_mask + # Optional. Comma-separated list of fully qualified names of fields to be + # updated. If not specified, all updatable fields in ClientState are updated. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_device_device_user_client_state(name, google_apps_cloudidentity_devices_v1_client_state_object = nil, customer: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/{+name}', options) + command.request_representation = Google::Apis::CloudidentityV1::GoogleAppsCloudidentityDevicesV1ClientState::Representation + command.request_object = google_apps_cloudidentity_devices_v1_client_state_object + command.response_representation = Google::Apis::CloudidentityV1::Operation::Representation + command.response_class = Google::Apis::CloudidentityV1::Operation + command.params['name'] = name unless name.nil? + command.query['customer'] = customer unless customer.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a Group. # @param [Google::Apis::CloudidentityV1::Group] group_object # @param [String] fields diff --git a/generated/google/apis/cloudidentity_v1beta1.rb b/generated/google/apis/cloudidentity_v1beta1.rb index 8df517376..375d610ad 100644 --- a/generated/google/apis/cloudidentity_v1beta1.rb +++ b/generated/google/apis/cloudidentity_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/identity/ module CloudidentityV1beta1 VERSION = 'V1beta1' - REVISION = '20200814' + REVISION = '20200908' # See your device details AUTH_CLOUD_IDENTITY_DEVICES_LOOKUP = 'https://www.googleapis.com/auth/cloud-identity.devices.lookup' diff --git a/generated/google/apis/cloudidentity_v1beta1/classes.rb b/generated/google/apis/cloudidentity_v1beta1/classes.rb index 7c3a699a9..f87c4fec7 100644 --- a/generated/google/apis/cloudidentity_v1beta1/classes.rb +++ b/generated/google/apis/cloudidentity_v1beta1/classes.rb @@ -985,7 +985,10 @@ module Google # @return [String] attr_accessor :etag - # The Health score of the resource + # The Health score of the resource. The Health score is the callers + # specification of the condition of the device from a usability point of view. + # For example, a third-party device management provider may specify a health + # score based on its compliance with organizational policies. # Corresponds to the JSON property `healthScore` # @return [String] attr_accessor :health_score @@ -1010,7 +1013,17 @@ module Google # Output only. [Resource name](https://cloud.google.com/apis/design/ # resource_names) of the ClientState in format: `devices/`device_id`/deviceUsers/ # `device_user_id`/clientState/`partner_id``, where partner_id corresponds to - # the partner storing the data. + # the partner storing the data. For partners belonging to the "BeyondCorp + # Alliance", this is the partner ID specified to you by Google. For all other + # callers, this is a string of the form: ``customer_id`-suffix`, where ` + # customer_id` is your customer ID. The *suffix* is any string the caller + # specifies. This string will be displayed verbatim in the administration + # console. This suffix is used in setting up Custom Access Levels in Context- + # Aware Access. Your organization's customer ID can be obtained from the URL: ` + # GET https://www.googleapis.com/admin/directory/v1/customers/my_customer` The ` + # id` field in the response contains the customer ID starting with the letter 'C' + # . The customer ID to be used in this API is the string after the letter 'C' ( + # not including 'C') # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1430,13 +1443,13 @@ module Google # Required. One or more label entries that apply to the Group. Currently # supported labels contain a key with an empty value. Google Groups are the - # default type of group and have a label with a key of 'cloudidentity.googleapis. - # com/groups.discussion_forum' and an empty value. Existing Google Groups can - # have an additional label with a key of 'cloudidentity.googleapis.com/groups. - # security' and an empty value added to them. **This is an immutable change and + # default type of group and have a label with a key of `cloudidentity.googleapis. + # com/groups.discussion_forum` and an empty value. Existing Google Groups can + # have an additional label with a key of `cloudidentity.googleapis.com/groups. + # security` and an empty value added to them. **This is an immutable change and # the security label cannot be removed once added.** Dynamic groups have a label # with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped - # groups for Cloud Search have a label with a key of 'system/groups/external' + # groups for Cloud Search have a label with a key of `system/groups/external` # and an empty value. Examples: `"cloudidentity.googleapis.com/groups. # discussion_forum": ""` or `"system/groups/external": ""`. # Corresponds to the JSON property `labels` diff --git a/generated/google/apis/cloudiot_v1.rb b/generated/google/apis/cloudiot_v1.rb index 74f8b8632..8e61a89bd 100644 --- a/generated/google/apis/cloudiot_v1.rb +++ b/generated/google/apis/cloudiot_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/iot module CloudiotV1 VERSION = 'V1' - REVISION = '20200804' + REVISION = '20200901' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudiot_v1/classes.rb b/generated/google/apis/cloudiot_v1/classes.rb index 071298706..0524f149f 100644 --- a/generated/google/apis/cloudiot_v1/classes.rb +++ b/generated/google/apis/cloudiot_v1/classes.rb @@ -67,6 +67,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: @@ -128,6 +134,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) diff --git a/generated/google/apis/cloudiot_v1/representations.rb b/generated/google/apis/cloudiot_v1/representations.rb index b242f3b2f..c7ac9a4f8 100644 --- a/generated/google/apis/cloudiot_v1/representations.rb +++ b/generated/google/apis/cloudiot_v1/representations.rb @@ -249,6 +249,7 @@ module Google class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::CloudiotV1::Expr, decorator: Google::Apis::CloudiotV1::Expr::Representation collection :members, as: 'members' diff --git a/generated/google/apis/cloudresourcemanager_v1.rb b/generated/google/apis/cloudresourcemanager_v1.rb index c14b6f019..5fca25c77 100644 --- a/generated/google/apis/cloudresourcemanager_v1.rb +++ b/generated/google/apis/cloudresourcemanager_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/resource-manager module CloudresourcemanagerV1 VERSION = 'V1' - REVISION = '20200810' + REVISION = '20200907' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudresourcemanager_v1/classes.rb b/generated/google/apis/cloudresourcemanager_v1/classes.rb index 50b847b90..f037d6507 100644 --- a/generated/google/apis/cloudresourcemanager_v1/classes.rb +++ b/generated/google/apis/cloudresourcemanager_v1/classes.rb @@ -119,6 +119,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: @@ -180,6 +186,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) @@ -1312,7 +1319,7 @@ module Google # The optional user-assigned display name of the Project. When present it must # be between 4 to 30 characters. Allowed characters are: lowercase and uppercase # letters, numbers, hyphen, single-quote, double-quote, space, and exclamation - # point. Example: My Project Read-write. + # point. Example: `My Project` Read-write. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1327,12 +1334,12 @@ module Google # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase # letters, digits, or hyphens. It must start with a letter. Trailing hyphens are - # prohibited. Example: tokyo-rain-123 Read-only after creation. + # prohibited. Example: `tokyo-rain-123` Read-only after creation. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # The number uniquely identifying the project. Example: 415104041262 Read-only. + # The number uniquely identifying the project. Example: `415104041262` Read-only. # Corresponds to the JSON property `projectNumber` # @return [Fixnum] attr_accessor :project_number @@ -1396,14 +1403,14 @@ module Google class ResourceId include Google::Apis::Core::Hashable - # Required field for the type-specific id. This should correspond to the id used - # in the type-specific API's. + # The type-specific id. This should correspond to the id used in the type- + # specific API's. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Required field representing the resource type this id is for. At present, the - # valid types are: "organization", "folder", and "project". + # The resource type this id is for. At present, the valid types are: " + # organization", "folder", and "project". # Corresponds to the JSON property `type` # @return [String] attr_accessor :type diff --git a/generated/google/apis/cloudresourcemanager_v1/representations.rb b/generated/google/apis/cloudresourcemanager_v1/representations.rb index 1d1a9d340..e9c69e73f 100644 --- a/generated/google/apis/cloudresourcemanager_v1/representations.rb +++ b/generated/google/apis/cloudresourcemanager_v1/representations.rb @@ -314,6 +314,7 @@ module Google class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::CloudresourcemanagerV1::Expr, decorator: Google::Apis::CloudresourcemanagerV1::Expr::Representation collection :members, as: 'members' diff --git a/generated/google/apis/cloudresourcemanager_v1/service.rb b/generated/google/apis/cloudresourcemanager_v1/service.rb index aa3bb3eca..a6955f9ea 100644 --- a/generated/google/apis/cloudresourcemanager_v1/service.rb +++ b/generated/google/apis/cloudresourcemanager_v1/service.rb @@ -928,7 +928,7 @@ module Google # Retrieves the Project identified by the specified `project_id` (for example, ` # my-project-123`). The caller must have read permissions for this Project. # @param [String] project_id - # The Project ID (for example, `my-project-123`). Required. + # Required. The Project ID (for example, `my-project-123`). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -960,7 +960,7 @@ module Google # by the specified `project_id` (for example, `my-project-123`). The caller must # have read permissions for this Project. # @param [String] project_id - # The Project ID (for example, `my-project-123`). Required. + # Required. The Project ID (for example, `my-project-123`). # @param [Google::Apis::CloudresourcemanagerV1::GetAncestryRequest] get_ancestry_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1032,8 +1032,8 @@ module Google # denied if the policy or the resource does not exist. Authorization requires # the Google IAM permission `resourcemanager.projects.getIamPolicy` on the # project. For additional information about `resource` (e.g. my-project-id) - # structure and identification, see [Resource Names](/apis/design/resource_names) - # . + # structure and identification, see [Resource Names](https://cloud.google.com/ + # apis/design/resource_names). # @param [String] resource # REQUIRED: The resource for which the policy is being requested. See the # operation documentation for the appropriate value for this field. @@ -1115,32 +1115,34 @@ module Google # results. In future versions of this API, this List method will be split into # List and Search to properly capture the behavioral difference. # @param [String] filter - # An expression for filtering the results of the request. Filter rules are case - # insensitive. Some eligible fields for filtering are: + `name` + `id` + `labels. - # ` (where *key* is the name of a label) + `parent.type` + `parent.id` + ` - # lifecycleState` Some examples of filter strings: | Filter | Description | |---- - # --------------|-----------------------------------------------------| | name: - # how* | The project's name starts with "how". | | name:Howl | The project's - # name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | - # Equivalent to above. | | labels.color:* | The project has the label `color`. | - # | labels.color:red | The project's label `color` has the value `red`. | | - # labels.color:red labels.size:big | The project's label `color` | : : has the - # value `red` and its : : : label`size` has the value : : : `big`. : | - # lifecycleState:DELETE_REQUESTED | Only show projects that are | : : pending - # deletion. : If no filter is specified, the call will return projects for which - # the user has the `resourcemanager.projects.get` permission. NOTE: To perform a - # by-parent query (eg., what projects are directly in a Folder), the caller must - # have the `resourcemanager.projects.list` permission on the parent and the - # filter must contain both a `parent.type` and a `parent.id` restriction ( - # example: "parent.type:folder parent.id:123"). In this case an alternate search - # index is used which provides more consistent results. Optional. + # Optional. An expression for filtering the results of the request. Filter rules + # are case insensitive. If multiple fields are included in a filter query, the + # query will return results that match any of the fields. Some eligible fields + # for filtering are: + `name` + `id` + `labels.` (where *key* is the name of a + # label) + `parent.type` + `parent.id` + `lifecycleState` Some examples of + # filter strings: | Filter | Description | |------------------|------------------ + # -----------------------------------| | name:how* | The project's name starts + # with "how". | | name:Howl | The project's name is `Howl` or `howl`. | | name: + # HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels. + # color:* | The project has the label `color`. | | labels.color:red | The + # project's label `color` has the value `red`. | | labels.color:red labels.size: + # big | The project's label `color` | : : has the value `red` and its : : : + # label`size` has the value : : : `big`. : | lifecycleState:DELETE_REQUESTED | + # Only show projects that are | : : pending deletion. : If no filter is + # specified, the call will return projects for which the user has the ` + # resourcemanager.projects.get` permission. NOTE: To perform a by-parent query ( + # eg., what projects are directly in a Folder), the caller must have the ` + # resourcemanager.projects.list` permission on the parent and the filter must + # contain both a `parent.type` and a `parent.id` restriction (example: "parent. + # type:folder parent.id:123"). In this case an alternate search index is used + # which provides more consistent results. # @param [Fixnum] page_size - # The maximum number of Projects to return in the response. The server can - # return fewer Projects than requested. If unspecified, server picks an - # appropriate default. Optional. + # Optional. The maximum number of Projects to return in the response. The server + # can return fewer Projects than requested. If unspecified, server picks an + # appropriate default. # @param [String] page_token - # A pagination token returned from a previous call to ListProjects that - # indicates from where listing should continue. Optional. + # Optional. A pagination token returned from a previous call to ListProjects + # that indicates from where listing should continue. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1242,32 +1244,32 @@ module Google # changing their roles can render services completely inoperable. It is # important to understand how the service account is being used before removing # or updating its roles. For additional information about `resource` (e.g. my- - # project-id) structure and identification, see [Resource Names](/apis/design/ - # resource_names). The following constraints apply when using `setIamPolicy()`: + - # Project does not support `allUsers` and `allAuthenticatedUsers` as `members` - # in a `Binding` of a `Policy`. + The owner role can be granted to a `user`, ` - # serviceAccount`, or a group that is part of an organization. For example, - # group@myownpersonaldomain.com could be added as an owner to a project in the - # myownpersonaldomain.com organization, but not the examplepetstore.com - # organization. + Service accounts can be made owners of a project directly - # without any restrictions. However, to be added as an owner, a user must be - # invited via Cloud Platform console and must accept the invitation. + A user - # cannot be granted the owner role using `setIamPolicy()`. The user must be - # granted the owner role using the Cloud Platform Console and must explicitly - # accept the invitation. + You can only grant ownership of a project to a member - # by using the GCP Console. Inviting a member will deliver an invitation email - # that they must accept. An invitation email is not generated if you are - # granting a role other than owner, or if both the member you are inviting and - # the project are part of your organization. + Membership changes that leave the - # project without any owners that have accepted the Terms of Service (ToS) will - # be rejected. + If the project is not part of an organization, there must be at - # least one owner who has accepted the Terms of Service (ToS) agreement in the - # policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from - # the policy will fail. This restriction also applies to legacy projects that no - # longer have owners who have accepted the ToS. Edits to IAM policies will be - # rejected until the lack of a ToS-accepting owner is rectified. Authorization - # requires the Google IAM permission `resourcemanager.projects.setIamPolicy` on - # the project + # project-id) structure and identification, see [Resource Names](https://cloud. + # google.com/apis/design/resource_names). The following constraints apply when + # using `setIamPolicy()`: + Project does not support `allUsers` and ` + # allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner + # role can be granted to a `user`, `serviceAccount`, or a group that is part of + # an organization. For example, group@myownpersonaldomain.com could be added as + # an owner to a project in the myownpersonaldomain.com organization, but not the + # examplepetstore.com organization. + Service accounts can be made owners of a + # project directly without any restrictions. However, to be added as an owner, a + # user must be invited via Cloud Platform console and must accept the invitation. + # + A user cannot be granted the owner role using `setIamPolicy()`. The user + # must be granted the owner role using the Cloud Platform Console and must + # explicitly accept the invitation. + You can only grant ownership of a project + # to a member by using the GCP Console. Inviting a member will deliver an + # invitation email that they must accept. An invitation email is not generated + # if you are granting a role other than owner, or if both the member you are + # inviting and the project are part of your organization. + Membership changes + # that leave the project without any owners that have accepted the Terms of + # Service (ToS) will be rejected. + If the project is not part of an + # organization, there must be at least one owner who has accepted the Terms of + # Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the + # last ToS-accepted owner from the policy will fail. This restriction also + # applies to legacy projects that no longer have owners who have accepted the + # ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting + # owner is rectified. Authorization requires the Google IAM permission ` + # resourcemanager.projects.setIamPolicy` on the project # @param [String] resource # REQUIRED: The resource for which the policy is being specified. See the # operation documentation for the appropriate value for this field. @@ -1339,8 +1341,8 @@ module Google # Returns permissions that a caller has on the specified Project. For additional # information about `resource` (e.g. my-project-id) structure and identification, - # see [Resource Names](/apis/design/resource_names). There are no permissions - # required for making this API call. + # see [Resource Names](https://cloud.google.com/apis/design/resource_names). + # There are no permissions required for making this API call. # @param [String] resource # REQUIRED: The resource for which the policy detail is being requested. See the # operation documentation for the appropriate value for this field. @@ -1379,7 +1381,7 @@ module Google # lifecycle state of DELETE_REQUESTED. After deletion starts, the Project cannot # be restored. The caller must have modify permissions for this Project. # @param [String] project_id - # The project ID (for example, `foo-bar-123`). Required. + # Required. The project ID (for example, `foo-bar-123`). # @param [Google::Apis::CloudresourcemanagerV1::UndeleteProjectRequest] undelete_project_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/cloudresourcemanager_v1beta1.rb b/generated/google/apis/cloudresourcemanager_v1beta1.rb index 9bbd61ce9..6dbe615ea 100644 --- a/generated/google/apis/cloudresourcemanager_v1beta1.rb +++ b/generated/google/apis/cloudresourcemanager_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/resource-manager module CloudresourcemanagerV1beta1 VERSION = 'V1beta1' - REVISION = '20200810' + REVISION = '20200907' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb b/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb index 76fee4d0d..9f10f2812 100644 --- a/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +++ b/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb @@ -119,6 +119,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: @@ -180,6 +186,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) @@ -641,7 +648,7 @@ module Google # the regular expression [a-z0-9_-]`0,63`. A label value can be empty. No more # than 256 labels can be associated with a given resource. Clients should store # labels in a representation such as JSON that does not depend on specific - # characters being disallowed. Example: "environment" : "dev" Read-write. + # characters being disallowed. Example: `"environment" : "dev"` Read-write. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -654,7 +661,7 @@ module Google # The optional user-assigned display name of the Project. When present it must # be between 4 to 30 characters. Allowed characters are: lowercase and uppercase # letters, numbers, hyphen, single-quote, double-quote, space, and exclamation - # point. Example: My Project Read-write. + # point. Example: `My Project` Read-write. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -669,12 +676,12 @@ module Google # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase # letters, digits, or hyphens. It must start with a letter. Trailing hyphens are - # prohibited. Example: tokyo-rain-123 Read-only after creation. + # prohibited. Example: `tokyo-rain-123` Read-only after creation. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # The number uniquely identifying the project. Example: 415104041262 Read-only. + # The number uniquely identifying the project. Example: `415104041262` Read-only. # Corresponds to the JSON property `projectNumber` # @return [Fixnum] attr_accessor :project_number diff --git a/generated/google/apis/cloudresourcemanager_v1beta1/representations.rb b/generated/google/apis/cloudresourcemanager_v1beta1/representations.rb index 48828b997..9a4b4604e 100644 --- a/generated/google/apis/cloudresourcemanager_v1beta1/representations.rb +++ b/generated/google/apis/cloudresourcemanager_v1beta1/representations.rb @@ -194,6 +194,7 @@ module Google class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::CloudresourcemanagerV1beta1::Expr, decorator: Google::Apis::CloudresourcemanagerV1beta1::Expr::Representation collection :members, as: 'members' diff --git a/generated/google/apis/cloudresourcemanager_v1beta1/service.rb b/generated/google/apis/cloudresourcemanager_v1beta1/service.rb index b8c32dd83..c287194af 100644 --- a/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +++ b/generated/google/apis/cloudresourcemanager_v1beta1/service.rb @@ -325,7 +325,7 @@ module Google # retrievable by the GetProject and ListProjects methods. The caller must have # modify permissions for this Project. # @param [String] project_id - # The Project ID (for example, `foo-bar-123`). Required. + # The Project ID (for example, `foo-bar-123`). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -356,7 +356,7 @@ module Google # Retrieves the Project identified by the specified `project_id` (for example, ` # my-project-123`). The caller must have read permissions for this Project. # @param [String] project_id - # The Project ID (for example, `my-project-123`). Required. + # Required. The Project ID (for example, `my-project-123`). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -388,7 +388,7 @@ module Google # by the specified `project_id` (for example, `my-project-123`). The caller must # have read permissions for this Project. # @param [String] project_id - # The Project ID (for example, `my-project-123`). Required. + # Required. The Project ID (for example, `my-project-123`). # @param [Google::Apis::CloudresourcemanagerV1beta1::GetAncestryRequest] get_ancestry_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -469,23 +469,24 @@ module Google # List and Search to properly capture the behavioral difference. # @param [String] filter # An expression for filtering the results of the request. Filter rules are case - # insensitive. The fields eligible for filtering are: + `name` + `id` + `labels.` - # (where *key* is the name of a label) + `parent.type` + `parent.id` Some - # examples of using labels as filters: | Filter | Description | |---------------- - # --|-----------------------------------------------------| | name:how* | The - # project's name starts with "how". | | name:Howl | The project's name is `Howl` - # or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to - # above. | | labels.color:* | The project has the label `color`. | | labels. - # color:red | The project's label `color` has the value `red`. | | labels.color: - # red labels.size:big |The project's label `color` has the value `red` and its - # label `size` has the value `big`. | If no filter is specified, the call will - # return projects for which the user has the `resourcemanager.projects.get` - # permission. NOTE: To perform a by-parent query (eg., what projects are - # directly in a Folder), the caller must have the `resourcemanager.projects.list` - # permission on the parent and the filter must contain both a `parent.type` and - # a `parent.id` restriction (example: "parent.type:folder parent.id:123"). In - # this case an alternate search index is used which provides more consistent - # results. Optional. + # insensitive. If multiple fields are included in a filter query, the query will + # return results that match any of the fields. Some eligible fields for + # filtering are: + `name` + `id` + `labels.` (where *key* is the name of a label) + # + `parent.type` + `parent.id` Some examples of using labels as filters: | + # Filter | Description | |------------------|------------------------------------ + # -----------------| | name:how* | The project's name starts with "how". | | + # name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent + # to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The + # project has the label `color`. | | labels.color:red | The project's label ` + # color` has the value `red`. | | labels.color:red labels.size:big |The project' + # s label `color` has the value `red` and its label `size` has the value `big`. | + # If no filter is specified, the call will return projects for which the user + # has the `resourcemanager.projects.get` permission. NOTE: To perform a by- + # parent query (eg., what projects are directly in a Folder), the caller must + # have the `resourcemanager.projects.list` permission on the parent and the + # filter must contain both a `parent.type` and a `parent.id` restriction ( + # example: "parent.type:folder parent.id:123"). In this case an alternate search + # index is used which provides more consistent results. Optional. # @param [Fixnum] page_size # The maximum number of Projects to return in the response. The server can # return fewer Projects than requested. If unspecified, server picks an @@ -621,7 +622,7 @@ module Google # lifecycle state of DELETE_REQUESTED. After deletion starts, the Project cannot # be restored. The caller must have modify permissions for this Project. # @param [String] project_id - # The project ID (for example, `foo-bar-123`). Required. + # Required. The project ID (for example, `foo-bar-123`). # @param [Google::Apis::CloudresourcemanagerV1beta1::UndeleteProjectRequest] undelete_project_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -656,7 +657,7 @@ module Google # (for example, `my-project-123`). The caller must have modify permissions for # this Project. # @param [String] project_id - # The project ID (for example, `my-project-123`). Required. + # The project ID (for example, `my-project-123`). # @param [Google::Apis::CloudresourcemanagerV1beta1::Project] project_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/cloudresourcemanager_v2.rb b/generated/google/apis/cloudresourcemanager_v2.rb index 0ca8f9642..01cb91d6f 100644 --- a/generated/google/apis/cloudresourcemanager_v2.rb +++ b/generated/google/apis/cloudresourcemanager_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/resource-manager module CloudresourcemanagerV2 VERSION = 'V2' - REVISION = '20200810' + REVISION = '20200831' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudresourcemanager_v2/classes.rb b/generated/google/apis/cloudresourcemanager_v2/classes.rb index 1c1d458f8..0b2ed53ab 100644 --- a/generated/google/apis/cloudresourcemanager_v2/classes.rb +++ b/generated/google/apis/cloudresourcemanager_v2/classes.rb @@ -97,6 +97,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: @@ -158,6 +164,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) diff --git a/generated/google/apis/cloudresourcemanager_v2/representations.rb b/generated/google/apis/cloudresourcemanager_v2/representations.rb index 6fdcdf028..2916f097e 100644 --- a/generated/google/apis/cloudresourcemanager_v2/representations.rb +++ b/generated/google/apis/cloudresourcemanager_v2/representations.rb @@ -168,6 +168,7 @@ module Google class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::CloudresourcemanagerV2::Expr, decorator: Google::Apis::CloudresourcemanagerV2::Expr::Representation collection :members, as: 'members' diff --git a/generated/google/apis/cloudresourcemanager_v2beta1.rb b/generated/google/apis/cloudresourcemanager_v2beta1.rb index beb9d4783..aa87decaa 100644 --- a/generated/google/apis/cloudresourcemanager_v2beta1.rb +++ b/generated/google/apis/cloudresourcemanager_v2beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/resource-manager module CloudresourcemanagerV2beta1 VERSION = 'V2beta1' - REVISION = '20200810' + REVISION = '20200831' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudresourcemanager_v2beta1/classes.rb b/generated/google/apis/cloudresourcemanager_v2beta1/classes.rb index 778b569c5..13ab05f3a 100644 --- a/generated/google/apis/cloudresourcemanager_v2beta1/classes.rb +++ b/generated/google/apis/cloudresourcemanager_v2beta1/classes.rb @@ -97,6 +97,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: @@ -158,6 +164,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) diff --git a/generated/google/apis/cloudresourcemanager_v2beta1/representations.rb b/generated/google/apis/cloudresourcemanager_v2beta1/representations.rb index 48713091e..254476ee4 100644 --- a/generated/google/apis/cloudresourcemanager_v2beta1/representations.rb +++ b/generated/google/apis/cloudresourcemanager_v2beta1/representations.rb @@ -168,6 +168,7 @@ module Google class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::CloudresourcemanagerV2beta1::Expr, decorator: Google::Apis::CloudresourcemanagerV2beta1::Expr::Representation collection :members, as: 'members' diff --git a/generated/google/apis/cloudsearch_v1.rb b/generated/google/apis/cloudsearch_v1.rb index 333b7f4fd..d67bdc330 100644 --- a/generated/google/apis/cloudsearch_v1.rb +++ b/generated/google/apis/cloudsearch_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/cloud-search/docs/guides/ module CloudsearchV1 VERSION = 'V1' - REVISION = '20200819' + REVISION = '20200901' # Index and serve your organization's data with Cloud Search AUTH_CLOUD_SEARCH = 'https://www.googleapis.com/auth/cloud_search' diff --git a/generated/google/apis/cloudtasks_v2beta3.rb b/generated/google/apis/cloudtasks_v2beta3.rb index b1a8f4faf..5f053ad71 100644 --- a/generated/google/apis/cloudtasks_v2beta3.rb +++ b/generated/google/apis/cloudtasks_v2beta3.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/tasks/ module CloudtasksV2beta3 VERSION = 'V2beta3' - REVISION = '20200804' + REVISION = '20200825' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudtasks_v2beta3/classes.rb b/generated/google/apis/cloudtasks_v2beta3/classes.rb index d42347d1a..9bd7e6bbf 100644 --- a/generated/google/apis/cloudtasks_v2beta3/classes.rb +++ b/generated/google/apis/cloudtasks_v2beta3/classes.rb @@ -992,24 +992,24 @@ module Google class RateLimits include Google::Apis::Core::Hashable - # Output only. The max burst size. Max burst size limits how fast tasks in queue - # are processed when many tasks are in the queue and the rate is high. This - # field allows the queue to have a high rate so processing starts shortly after - # a task is enqueued, but still limits resource usage when many tasks are - # enqueued in a short period of time. The [token bucket](https://wikipedia.org/ - # wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. - # Each queue has a token bucket that holds tokens, up to the maximum specified - # by `max_burst_size`. Each time a task is dispatched, a token is removed from - # the bucket. Tasks will be dispatched until the queue's bucket runs out of - # tokens. The bucket will be continuously refilled with new tokens based on - # max_dispatches_per_second. Cloud Tasks will pick the value of `max_burst_size` - # based on the value of max_dispatches_per_second. For App Engine queues that - # were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [ - # bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/ - # queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue - # is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be - # reset based on the value of max_dispatches_per_second, regardless of whether - # max_dispatches_per_second is updated. + # The max burst size. Max burst size limits how fast tasks in queue are + # processed when many tasks are in the queue and the rate is high. This field + # allows the queue to have a high rate so processing starts shortly after a task + # is enqueued, but still limits resource usage when many tasks are enqueued in a + # short period of time. The [token bucket](https://wikipedia.org/wiki/ + # Token_Bucket) algorithm is used to control the rate of task dispatches. Each + # queue has a token bucket that holds tokens, up to the maximum specified by ` + # max_burst_size`. Each time a task is dispatched, a token is removed from the + # bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. + # The bucket will be continuously refilled with new tokens based on + # max_dispatches_per_second. The default value of `max_burst_size` is picked by + # Cloud Tasks based on the value of max_dispatches_per_second. The maximum value + # of `max_burst_size` is 500. For App Engine queues that were created or updated + # using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https:// + # cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). + # If UpdateQueue is called on a queue without explicitly setting a value for ` + # max_burst_size`, `max_burst_size` value will get updated if UpdateQueue is + # updating max_dispatches_per_second. # Corresponds to the JSON property `maxBurstSize` # @return [Fixnum] attr_accessor :max_burst_size diff --git a/generated/google/apis/container_v1.rb b/generated/google/apis/container_v1.rb index 17b649ff4..932b2da27 100644 --- a/generated/google/apis/container_v1.rb +++ b/generated/google/apis/container_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/container-engine/ module ContainerV1 VERSION = 'V1' - REVISION = '20200805' + REVISION = '20200828' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/container_v1/classes.rb b/generated/google/apis/container_v1/classes.rb index d5689cff3..880cbe73d 100644 --- a/generated/google/apis/container_v1/classes.rb +++ b/generated/google/apis/container_v1/classes.rb @@ -171,12 +171,44 @@ module Google class AutoprovisioningNodePoolDefaults include Google::Apis::Core::Hashable + # The Customer Managed Encryption Key used to encrypt the boot disk attached to + # each node in the node pool. This should be of the form projects/[ + # KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME] + # . For more information about protecting resources with Cloud KMS Keys please + # see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + # Corresponds to the JSON property `bootDiskKmsKey` + # @return [String] + attr_accessor :boot_disk_kms_key + + # Size of the disk attached to each node, specified in GB. The smallest allowed + # disk size is 10GB. If unspecified, the default disk size is 100GB. + # Corresponds to the JSON property `diskSizeGb` + # @return [Fixnum] + attr_accessor :disk_size_gb + + # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If + # unspecified, the default disk type is 'pd-standard' + # Corresponds to the JSON property `diskType` + # @return [String] + attr_accessor :disk_type + # NodeManagement defines the set of node management services turned on for the # node pool. # Corresponds to the JSON property `management` # @return [Google::Apis::ContainerV1::NodeManagement] attr_accessor :management + # Minimum CPU platform to be used for NAP created node pools. 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 [how to specify + # min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min- + # cpu-platform) To unset the min cpu platform field pass "automatic" as field + # value. + # Corresponds to the JSON property `minCpuPlatform` + # @return [String] + attr_accessor :min_cpu_platform + # Scopes that are used by NAP when creating node pools. # Corresponds to the JSON property `oauthScopes` # @return [Array] @@ -187,6 +219,11 @@ module Google # @return [String] attr_accessor :service_account + # A set of Shielded Instance options. + # Corresponds to the JSON property `shieldedInstanceConfig` + # @return [Google::Apis::ContainerV1::ShieldedInstanceConfig] + attr_accessor :shielded_instance_config + # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. maxUnavailable controls the number of nodes # that can be simultaneously unavailable. maxSurge controls the number of @@ -211,9 +248,14 @@ module Google # Update properties of this object def update!(**args) + @boot_disk_kms_key = args[:boot_disk_kms_key] if args.key?(:boot_disk_kms_key) + @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb) + @disk_type = args[:disk_type] if args.key?(:disk_type) @management = args[:management] if args.key?(:management) + @min_cpu_platform = args[:min_cpu_platform] if args.key?(:min_cpu_platform) @oauth_scopes = args[:oauth_scopes] if args.key?(:oauth_scopes) @service_account = args[:service_account] if args.key?(:service_account) + @shielded_instance_config = args[:shielded_instance_config] if args.key?(:shielded_instance_config) @upgrade_settings = args[:upgrade_settings] if args.key?(:upgrade_settings) end end @@ -356,6 +398,11 @@ module Google attr_accessor :disabled alias_method :disabled?, :disabled + # Which load balancer type is installed for Cloud Run. + # Corresponds to the JSON property `loadBalancerType` + # @return [String] + attr_accessor :load_balancer_type + def initialize(**args) update!(**args) end @@ -363,6 +410,7 @@ module Google # Update properties of this object def update!(**args) @disabled = args[:disabled] if args.key?(:disabled) + @load_balancer_type = args[:load_balancer_type] if args.key?(:load_balancer_type) end end @@ -1907,14 +1955,21 @@ module Google # The password to use for HTTP basic authentication to the master endpoint. # Because the master endpoint is open to the Internet, you should create a # strong password. If a password is provided for cluster creation, username must - # be non-empty. + # be non-empty. Warning: basic authentication is deprecated, and will be removed + # in GKE control plane versions 1.19 and newer. For a list of recommended + # authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/ + # how-to/api-server-authentication # Corresponds to the JSON property `password` # @return [String] attr_accessor :password # The username to use for HTTP basic authentication to the master endpoint. For # clusters v1.6.0 and later, basic authentication can be disabled by leaving - # username unspecified (or setting it to the empty string). + # username unspecified (or setting it to the empty string). Warning: basic + # authentication is deprecated, and will be removed in GKE control plane + # versions 1.19 and newer. For a list of recommended authentication methods, see: + # https://cloud.google.com/kubernetes-engine/docs/how-to/api-server- + # authentication # Corresponds to the JSON property `username` # @return [String] attr_accessor :username diff --git a/generated/google/apis/container_v1/representations.rb b/generated/google/apis/container_v1/representations.rb index 0539fe493..a2c59183d 100644 --- a/generated/google/apis/container_v1/representations.rb +++ b/generated/google/apis/container_v1/representations.rb @@ -621,10 +621,16 @@ module Google class AutoprovisioningNodePoolDefaults # @private class Representation < Google::Apis::Core::JsonRepresentation + property :boot_disk_kms_key, as: 'bootDiskKmsKey' + property :disk_size_gb, as: 'diskSizeGb' + property :disk_type, as: 'diskType' property :management, as: 'management', class: Google::Apis::ContainerV1::NodeManagement, decorator: Google::Apis::ContainerV1::NodeManagement::Representation + property :min_cpu_platform, as: 'minCpuPlatform' collection :oauth_scopes, as: 'oauthScopes' property :service_account, as: 'serviceAccount' + property :shielded_instance_config, as: 'shieldedInstanceConfig', class: Google::Apis::ContainerV1::ShieldedInstanceConfig, decorator: Google::Apis::ContainerV1::ShieldedInstanceConfig::Representation + property :upgrade_settings, as: 'upgradeSettings', class: Google::Apis::ContainerV1::UpgradeSettings, decorator: Google::Apis::ContainerV1::UpgradeSettings::Representation end @@ -673,6 +679,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :disabled, as: 'disabled' + property :load_balancer_type, as: 'loadBalancerType' end end diff --git a/generated/google/apis/container_v1beta1.rb b/generated/google/apis/container_v1beta1.rb index 5684fa989..0394b70c9 100644 --- a/generated/google/apis/container_v1beta1.rb +++ b/generated/google/apis/container_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/container-engine/ module ContainerV1beta1 VERSION = 'V1beta1' - REVISION = '20200805' + REVISION = '20200828' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/container_v1beta1/classes.rb b/generated/google/apis/container_v1beta1/classes.rb index fbfb41943..dd508d531 100644 --- a/generated/google/apis/container_v1beta1/classes.rb +++ b/generated/google/apis/container_v1beta1/classes.rb @@ -190,6 +190,27 @@ module Google class AutoprovisioningNodePoolDefaults include Google::Apis::Core::Hashable + # The Customer Managed Encryption Key used to encrypt the boot disk attached to + # each node in the node pool. This should be of the form projects/[ + # KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME] + # . For more information about protecting resources with Cloud KMS Keys please + # see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + # Corresponds to the JSON property `bootDiskKmsKey` + # @return [String] + attr_accessor :boot_disk_kms_key + + # Size of the disk attached to each node, specified in GB. The smallest allowed + # disk size is 10GB. If unspecified, the default disk size is 100GB. + # Corresponds to the JSON property `diskSizeGb` + # @return [Fixnum] + attr_accessor :disk_size_gb + + # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If + # unspecified, the default disk type is 'pd-standard' + # Corresponds to the JSON property `diskType` + # @return [String] + attr_accessor :disk_type + # NodeManagement defines the set of node management services turned on for the # node pool. # Corresponds to the JSON property `management` @@ -227,6 +248,11 @@ module Google # @return [String] attr_accessor :service_account + # A set of Shielded Instance options. + # Corresponds to the JSON property `shieldedInstanceConfig` + # @return [Google::Apis::ContainerV1beta1::ShieldedInstanceConfig] + attr_accessor :shielded_instance_config + # These upgrade settings control the level of parallelism and the level of # disruption caused by an upgrade. maxUnavailable controls the number of nodes # that can be simultaneously unavailable. maxSurge controls the number of @@ -251,10 +277,14 @@ module Google # Update properties of this object def update!(**args) + @boot_disk_kms_key = args[:boot_disk_kms_key] if args.key?(:boot_disk_kms_key) + @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb) + @disk_type = args[:disk_type] if args.key?(:disk_type) @management = args[:management] if args.key?(:management) @min_cpu_platform = args[:min_cpu_platform] if args.key?(:min_cpu_platform) @oauth_scopes = args[:oauth_scopes] if args.key?(:oauth_scopes) @service_account = args[:service_account] if args.key?(:service_account) + @shielded_instance_config = args[:shielded_instance_config] if args.key?(:shielded_instance_config) @upgrade_settings = args[:upgrade_settings] if args.key?(:upgrade_settings) end end @@ -422,6 +452,11 @@ module Google attr_accessor :disabled alias_method :disabled?, :disabled + # Which load balancer type is installed for Cloud Run. + # Corresponds to the JSON property `loadBalancerType` + # @return [String] + attr_accessor :load_balancer_type + def initialize(**args) update!(**args) end @@ -429,6 +464,7 @@ module Google # Update properties of this object def update!(**args) @disabled = args[:disabled] if args.key?(:disabled) + @load_balancer_type = args[:load_balancer_type] if args.key?(:load_balancer_type) end end @@ -2265,14 +2301,21 @@ module Google # The password to use for HTTP basic authentication to the master endpoint. # Because the master endpoint is open to the Internet, you should create a # strong password. If a password is provided for cluster creation, username must - # be non-empty. + # be non-empty. Warning: basic authentication is deprecated, and will be removed + # in GKE control plane versions 1.19 and newer. For a list of recommended + # authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/ + # how-to/api-server-authentication # Corresponds to the JSON property `password` # @return [String] attr_accessor :password # The username to use for HTTP basic authentication to the master endpoint. For # clusters v1.6.0 and later, basic authentication can be disabled by leaving - # username unspecified (or setting it to the empty string). + # username unspecified (or setting it to the empty string). Warning: basic + # authentication is deprecated, and will be removed in GKE control plane + # versions 1.19 and newer. For a list of recommended authentication methods, see: + # https://cloud.google.com/kubernetes-engine/docs/how-to/api-server- + # authentication # Corresponds to the JSON property `username` # @return [String] attr_accessor :username @@ -2687,11 +2730,11 @@ module Google class NodeKubeletConfig include Google::Apis::Core::Hashable - # Enable CPU CFS quota enforcement for containers that specify CPU limits. If - # this option is enabled, kubelet uses CFS quota (https://www.kernel.org/doc/ - # Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. - # Otherwise, CPU limits will not be enforced at all. Disable this option to - # mitigate CPU throttling problems while still having your pods to be in + # Enable CPU CFS quota enforcement for containers that specify CPU limits. This + # option is enabled by default which makes kubelet use CFS quota (https://www. + # kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU + # limits. Otherwise, CPU limits will not be enforced at all. Disable this option + # to mitigate CPU throttling problems while still having your pods to be in # Guaranteed QoS class by specifying the CPU limits. The default value is 'true' # if unspecified. # Corresponds to the JSON property `cpuCfsQuota` @@ -2711,7 +2754,8 @@ module Google # tasks/administer-cluster/cpu-management-policies/ The following values are # allowed. - "none": the default, which represents the existing scheduling # behavior. - "static": allows pods with certain resource characteristics to be - # granted increased CPU affinity and exclusivity on the node. + # granted increased CPU affinity and exclusivity on the node. The default value + # is 'none' if unspecified. # Corresponds to the JSON property `cpuManagerPolicy` # @return [String] attr_accessor :cpu_manager_policy diff --git a/generated/google/apis/container_v1beta1/representations.rb b/generated/google/apis/container_v1beta1/representations.rb index 93d807c94..48e6a8d88 100644 --- a/generated/google/apis/container_v1beta1/representations.rb +++ b/generated/google/apis/container_v1beta1/representations.rb @@ -717,11 +717,16 @@ module Google class AutoprovisioningNodePoolDefaults # @private class Representation < Google::Apis::Core::JsonRepresentation + property :boot_disk_kms_key, as: 'bootDiskKmsKey' + property :disk_size_gb, as: 'diskSizeGb' + property :disk_type, as: 'diskType' property :management, as: 'management', class: Google::Apis::ContainerV1beta1::NodeManagement, decorator: Google::Apis::ContainerV1beta1::NodeManagement::Representation property :min_cpu_platform, as: 'minCpuPlatform' collection :oauth_scopes, as: 'oauthScopes' property :service_account, as: 'serviceAccount' + property :shielded_instance_config, as: 'shieldedInstanceConfig', class: Google::Apis::ContainerV1beta1::ShieldedInstanceConfig, decorator: Google::Apis::ContainerV1beta1::ShieldedInstanceConfig::Representation + property :upgrade_settings, as: 'upgradeSettings', class: Google::Apis::ContainerV1beta1::UpgradeSettings, decorator: Google::Apis::ContainerV1beta1::UpgradeSettings::Representation end @@ -778,6 +783,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :disabled, as: 'disabled' + property :load_balancer_type, as: 'loadBalancerType' end end diff --git a/generated/google/apis/containeranalysis_v1alpha1.rb b/generated/google/apis/containeranalysis_v1alpha1.rb index 7128795c5..84f10a023 100644 --- a/generated/google/apis/containeranalysis_v1alpha1.rb +++ b/generated/google/apis/containeranalysis_v1alpha1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/container-analysis/api/reference/rest/ module ContaineranalysisV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200807' + REVISION = '20200828' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/containeranalysis_v1alpha1/classes.rb b/generated/google/apis/containeranalysis_v1alpha1/classes.rb index 8b1a886d1..20b3851ff 100644 --- a/generated/google/apis/containeranalysis_v1alpha1/classes.rb +++ b/generated/google/apis/containeranalysis_v1alpha1/classes.rb @@ -188,6 +188,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: @@ -249,6 +255,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) diff --git a/generated/google/apis/containeranalysis_v1alpha1/representations.rb b/generated/google/apis/containeranalysis_v1alpha1/representations.rb index bb19e78bd..a61fc8d4e 100644 --- a/generated/google/apis/containeranalysis_v1alpha1/representations.rb +++ b/generated/google/apis/containeranalysis_v1alpha1/representations.rb @@ -475,6 +475,7 @@ module Google class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::ContaineranalysisV1alpha1::Expr, decorator: Google::Apis::ContaineranalysisV1alpha1::Expr::Representation collection :members, as: 'members' diff --git a/generated/google/apis/containeranalysis_v1beta1.rb b/generated/google/apis/containeranalysis_v1beta1.rb index 09ede19d5..733208488 100644 --- a/generated/google/apis/containeranalysis_v1beta1.rb +++ b/generated/google/apis/containeranalysis_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/container-analysis/api/reference/rest/ module ContaineranalysisV1beta1 VERSION = 'V1beta1' - REVISION = '20200807' + REVISION = '20200828' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/containeranalysis_v1beta1/classes.rb b/generated/google/apis/containeranalysis_v1beta1/classes.rb index 92f511898..303419354 100644 --- a/generated/google/apis/containeranalysis_v1beta1/classes.rb +++ b/generated/google/apis/containeranalysis_v1beta1/classes.rb @@ -297,6 +297,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: @@ -358,6 +364,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) diff --git a/generated/google/apis/containeranalysis_v1beta1/representations.rb b/generated/google/apis/containeranalysis_v1beta1/representations.rb index 1e3fb858f..8b5dc253b 100644 --- a/generated/google/apis/containeranalysis_v1beta1/representations.rb +++ b/generated/google/apis/containeranalysis_v1beta1/representations.rb @@ -619,6 +619,7 @@ module Google class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::ContaineranalysisV1beta1::Expr, decorator: Google::Apis::ContaineranalysisV1beta1::Expr::Representation collection :members, as: 'members' diff --git a/generated/google/apis/content_v2.rb b/generated/google/apis/content_v2.rb index ad24177d2..d5c616cfe 100644 --- a/generated/google/apis/content_v2.rb +++ b/generated/google/apis/content_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/shopping-content module ContentV2 VERSION = 'V2' - REVISION = '20200805' + REVISION = '20200902' # Manage your product listings and accounts for Google Shopping AUTH_CONTENT = 'https://www.googleapis.com/auth/content' diff --git a/generated/google/apis/content_v2/classes.rb b/generated/google/apis/content_v2/classes.rb index 24d3b4db4..239c29f23 100644 --- a/generated/google/apis/content_v2/classes.rb +++ b/generated/google/apis/content_v2/classes.rb @@ -125,7 +125,8 @@ module Google class AccountAddress include Google::Apis::Core::Hashable - # CLDR country code (e.g. "US"). + # CLDR country code (e.g. "US"). This value cannot be set for a sub-account of + # an MCA. All MCA sub-accounts inherit the country of their parent MCA. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country diff --git a/generated/google/apis/content_v2_1.rb b/generated/google/apis/content_v2_1.rb index ae7fb61b6..3605d0344 100644 --- a/generated/google/apis/content_v2_1.rb +++ b/generated/google/apis/content_v2_1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/shopping-content module ContentV2_1 VERSION = 'V2_1' - REVISION = '20200821' + REVISION = '20200902' # Manage your product listings and accounts for Google Shopping AUTH_CONTENT = 'https://www.googleapis.com/auth/content' diff --git a/generated/google/apis/content_v2_1/classes.rb b/generated/google/apis/content_v2_1/classes.rb index 67a96bd2a..2c7bc6593 100644 --- a/generated/google/apis/content_v2_1/classes.rb +++ b/generated/google/apis/content_v2_1/classes.rb @@ -131,7 +131,8 @@ module Google class AccountAddress include Google::Apis::Core::Hashable - # CLDR country code (e.g. "US"). + # CLDR country code (e.g. "US"). This value cannot be set for a sub-account of + # an MCA. All MCA sub-accounts inherit the country of their parent MCA. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country @@ -6209,17 +6210,26 @@ module Google class OrderreturnsRefundOperation include Google::Apis::Core::Hashable - # If true, the item will be fully refunded. + # If true, the item will be fully refunded. // Allowed only when payment_type is + # FOP. Merchant can choose this refund option to indicate the full remaining + # amount of corresponding object to be refunded to the customer via FOP. # Corresponds to the JSON property `fullRefund` # @return [Boolean] attr_accessor :full_refund alias_method :full_refund?, :full_refund - # If this is set, the item will be partially refunded. + # If this is set, the item will be partially refunded. Merchant can choose this + # refund option to specify the customized amount that to be refunded to the + # customer. # Corresponds to the JSON property `partialRefund` # @return [Google::Apis::ContentV2_1::OrderreturnsPartialRefund] attr_accessor :partial_refund + # The payment way of issuing refund. Default value is ORIGINAL_FOP if not set. + # Corresponds to the JSON property `paymentType` + # @return [String] + attr_accessor :payment_type + # The explanation of the reason. # Corresponds to the JSON property `reasonText` # @return [String] @@ -6238,6 +6248,7 @@ module Google def update!(**args) @full_refund = args[:full_refund] if args.key?(:full_refund) @partial_refund = args[:partial_refund] if args.key?(:partial_refund) + @payment_type = args[:payment_type] if args.key?(:payment_type) @reason_text = args[:reason_text] if args.key?(:reason_text) @return_refund_reason = args[:return_refund_reason] if args.key?(:return_refund_reason) end diff --git a/generated/google/apis/content_v2_1/representations.rb b/generated/google/apis/content_v2_1/representations.rb index 768103771..73e2e16f4 100644 --- a/generated/google/apis/content_v2_1/representations.rb +++ b/generated/google/apis/content_v2_1/representations.rb @@ -3443,6 +3443,7 @@ module Google property :full_refund, as: 'fullRefund' property :partial_refund, as: 'partialRefund', class: Google::Apis::ContentV2_1::OrderreturnsPartialRefund, decorator: Google::Apis::ContentV2_1::OrderreturnsPartialRefund::Representation + property :payment_type, as: 'paymentType' property :reason_text, as: 'reasonText' property :return_refund_reason, as: 'returnRefundReason' end diff --git a/generated/google/apis/datacatalog_v1beta1.rb b/generated/google/apis/datacatalog_v1beta1.rb index a04041496..9dac1dc10 100644 --- a/generated/google/apis/datacatalog_v1beta1.rb +++ b/generated/google/apis/datacatalog_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/data-catalog/docs/ module DatacatalogV1beta1 VERSION = 'V1beta1' - REVISION = '20200810' + REVISION = '20200831' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/datacatalog_v1beta1/classes.rb b/generated/google/apis/datacatalog_v1beta1/classes.rb index f04cd886c..c6ccf0c46 100644 --- a/generated/google/apis/datacatalog_v1beta1/classes.rb +++ b/generated/google/apis/datacatalog_v1beta1/classes.rb @@ -26,6 +26,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: @@ -87,6 +93,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) diff --git a/generated/google/apis/datacatalog_v1beta1/representations.rb b/generated/google/apis/datacatalog_v1beta1/representations.rb index 8ca3a6ae3..5a3f906fa 100644 --- a/generated/google/apis/datacatalog_v1beta1/representations.rb +++ b/generated/google/apis/datacatalog_v1beta1/representations.rb @@ -307,6 +307,7 @@ module Google class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::DatacatalogV1beta1::Expr, decorator: Google::Apis::DatacatalogV1beta1::Expr::Representation collection :members, as: 'members' diff --git a/generated/google/apis/datafusion_v1.rb b/generated/google/apis/datafusion_v1.rb index 1c7d708f2..f18029025 100644 --- a/generated/google/apis/datafusion_v1.rb +++ b/generated/google/apis/datafusion_v1.rb @@ -31,7 +31,7 @@ module Google # @see https://cloud.google.com/data-fusion/docs module DatafusionV1 VERSION = 'V1' - REVISION = '20200803' + REVISION = '20200901' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/datafusion_v1/classes.rb b/generated/google/apis/datafusion_v1/classes.rb index c1c39da06..c337c2145 100644 --- a/generated/google/apis/datafusion_v1/classes.rb +++ b/generated/google/apis/datafusion_v1/classes.rb @@ -116,6 +116,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: @@ -177,6 +183,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) @@ -292,6 +299,13 @@ module Google # @return [String] attr_accessor :create_time + # User-managed service account to set on Dataproc when Cloud Data Fusion creates + # Dataproc to run data processing pipelines. This allows users to have fine- + # grained access control on Dataproc's accesses to cloud resources. + # Corresponds to the JSON property `dataprocServiceAccount` + # @return [String] + attr_accessor :dataproc_service_account + # A description of this instance. # Corresponds to the JSON property `description` # @return [String] @@ -420,6 +434,7 @@ module Google @api_endpoint = args[:api_endpoint] if args.key?(:api_endpoint) @available_version = args[:available_version] if args.key?(:available_version) @create_time = args[:create_time] if args.key?(:create_time) + @dataproc_service_account = args[:dataproc_service_account] if args.key?(:dataproc_service_account) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @enable_stackdriver_logging = args[:enable_stackdriver_logging] if args.key?(:enable_stackdriver_logging) diff --git a/generated/google/apis/datafusion_v1/representations.rb b/generated/google/apis/datafusion_v1/representations.rb index 93d24e30a..14e0eabf8 100644 --- a/generated/google/apis/datafusion_v1/representations.rb +++ b/generated/google/apis/datafusion_v1/representations.rb @@ -187,6 +187,7 @@ module Google class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::DatafusionV1::Expr, decorator: Google::Apis::DatafusionV1::Expr::Representation collection :members, as: 'members' @@ -225,6 +226,7 @@ module Google collection :available_version, as: 'availableVersion', class: Google::Apis::DatafusionV1::Version, decorator: Google::Apis::DatafusionV1::Version::Representation property :create_time, as: 'createTime' + property :dataproc_service_account, as: 'dataprocServiceAccount' property :description, as: 'description' property :display_name, as: 'displayName' property :enable_stackdriver_logging, as: 'enableStackdriverLogging' diff --git a/generated/google/apis/datafusion_v1beta1.rb b/generated/google/apis/datafusion_v1beta1.rb index 1d65c7826..d9fdb66fd 100644 --- a/generated/google/apis/datafusion_v1beta1.rb +++ b/generated/google/apis/datafusion_v1beta1.rb @@ -31,7 +31,7 @@ module Google # @see https://cloud.google.com/data-fusion/docs module DatafusionV1beta1 VERSION = 'V1beta1' - REVISION = '20200803' + REVISION = '20200901' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/datafusion_v1beta1/classes.rb b/generated/google/apis/datafusion_v1beta1/classes.rb index 94263d932..7b48daa10 100644 --- a/generated/google/apis/datafusion_v1beta1/classes.rb +++ b/generated/google/apis/datafusion_v1beta1/classes.rb @@ -116,6 +116,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: @@ -177,6 +183,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) @@ -292,6 +299,13 @@ module Google # @return [String] attr_accessor :create_time + # User-managed service account to set on Dataproc when Cloud Data Fusion creates + # Dataproc to run data processing pipelines. This allows users to have fine- + # grained access control on Dataproc's accesses to cloud resources. + # Corresponds to the JSON property `dataprocServiceAccount` + # @return [String] + attr_accessor :dataproc_service_account + # A description of this instance. # Corresponds to the JSON property `description` # @return [String] @@ -419,6 +433,7 @@ module Google @api_endpoint = args[:api_endpoint] if args.key?(:api_endpoint) @available_version = args[:available_version] if args.key?(:available_version) @create_time = args[:create_time] if args.key?(:create_time) + @dataproc_service_account = args[:dataproc_service_account] if args.key?(:dataproc_service_account) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @enable_stackdriver_logging = args[:enable_stackdriver_logging] if args.key?(:enable_stackdriver_logging) diff --git a/generated/google/apis/datafusion_v1beta1/representations.rb b/generated/google/apis/datafusion_v1beta1/representations.rb index 3bacfa119..605a7234d 100644 --- a/generated/google/apis/datafusion_v1beta1/representations.rb +++ b/generated/google/apis/datafusion_v1beta1/representations.rb @@ -193,6 +193,7 @@ module Google class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::DatafusionV1beta1::Expr, decorator: Google::Apis::DatafusionV1beta1::Expr::Representation collection :members, as: 'members' @@ -231,6 +232,7 @@ module Google collection :available_version, as: 'availableVersion', class: Google::Apis::DatafusionV1beta1::Version, decorator: Google::Apis::DatafusionV1beta1::Version::Representation property :create_time, as: 'createTime' + property :dataproc_service_account, as: 'dataprocServiceAccount' property :description, as: 'description' property :display_name, as: 'displayName' property :enable_stackdriver_logging, as: 'enableStackdriverLogging' diff --git a/generated/google/apis/dataproc_v1.rb b/generated/google/apis/dataproc_v1.rb index db860b121..b3c4ab9be 100644 --- a/generated/google/apis/dataproc_v1.rb +++ b/generated/google/apis/dataproc_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/dataproc/ module DataprocV1 VERSION = 'V1' - REVISION = '20200813' + REVISION = '20200902' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dataproc_v1/classes.rb b/generated/google/apis/dataproc_v1/classes.rb index 0be7c564e..3c5eead9a 100644 --- a/generated/google/apis/dataproc_v1/classes.rb +++ b/generated/google/apis/dataproc_v1/classes.rb @@ -232,6 +232,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: " @@ -292,6 +298,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) @@ -412,7 +419,7 @@ module Google attr_accessor :endpoint_config # Common config settings for resources of Compute Engine cluster instances, - # applicable to all instances in the cluster. + # applicable to all instances in the cluster. NEXT ID: 13 # Corresponds to the JSON property `gceClusterConfig` # @return [Google::Apis::DataprocV1::GceClusterConfig] attr_accessor :gce_cluster_config @@ -907,7 +914,7 @@ module Google end # Common config settings for resources of Compute Engine cluster instances, - # applicable to all instances in the cluster. + # applicable to all instances in the cluster. NEXT ID: 13 class GceClusterConfig include Google::Apis::Core::Hashable @@ -941,6 +948,11 @@ module Google # @return [String] attr_accessor :network_uri + # Optional. The type of IPv6 access for a cluster. + # Corresponds to the JSON property `privateIpv6GoogleAccess` + # @return [String] + attr_accessor :private_ipv6_google_access + # Reservation Affinity for consuming Zonal reservation. # Corresponds to the JSON property `reservationAffinity` # @return [Google::Apis::DataprocV1::ReservationAffinity] @@ -1005,6 +1017,7 @@ module Google @internal_ip_only = args[:internal_ip_only] if args.key?(:internal_ip_only) @metadata = args[:metadata] if args.key?(:metadata) @network_uri = args[:network_uri] if args.key?(:network_uri) + @private_ipv6_google_access = args[:private_ipv6_google_access] if args.key?(:private_ipv6_google_access) @reservation_affinity = args[:reservation_affinity] if args.key?(:reservation_affinity) @service_account = args[:service_account] if args.key?(:service_account) @service_account_scopes = args[:service_account_scopes] if args.key?(:service_account_scopes) @@ -1661,8 +1674,8 @@ module Google include Google::Apis::Core::Hashable # Optional. Maximum number of times per hour a driver may be restarted as a - # result of driver terminating 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 + # 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.Maximum value is 10. # Corresponds to the JSON property `maxFailuresPerHour` # @return [Fixnum] @@ -2614,11 +2627,11 @@ module Google class QueryList include Google::Apis::Core::Hashable - # Required. The queries to execute. You do not need to terminate a query with a - # semicolon. Multiple queries can be specified in one string by separating each - # with a semicolon. Here is an example of an Cloud Dataproc API snippet that - # uses a QueryList to specify a HiveJob: "hiveJob": ` "queryList": ` "queries": [ - # "query1", "query2", "query3;query4", ] ` ` + # Required. The queries to execute. You do not need to end a query expression + # with a semicolon. Multiple queries can be specified in one string by + # separating each with a semicolon. Here is an example of a Dataproc API snippet + # that uses a QueryList to specify a HiveJob: "hiveJob": ` "queryList": ` " + # queries": [ "query1", "query2", "query3;query4", ] ` ` # Corresponds to the JSON property `queries` # @return [Array] attr_accessor :queries diff --git a/generated/google/apis/dataproc_v1/representations.rb b/generated/google/apis/dataproc_v1/representations.rb index 09eb2d11b..b4fc41dfc 100644 --- a/generated/google/apis/dataproc_v1/representations.rb +++ b/generated/google/apis/dataproc_v1/representations.rb @@ -530,6 +530,7 @@ module Google class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::DataprocV1::Expr, decorator: Google::Apis::DataprocV1::Expr::Representation collection :members, as: 'members' @@ -711,6 +712,7 @@ module Google property :internal_ip_only, as: 'internalIpOnly' hash :metadata, as: 'metadata' property :network_uri, as: 'networkUri' + property :private_ipv6_google_access, as: 'privateIpv6GoogleAccess' property :reservation_affinity, as: 'reservationAffinity', class: Google::Apis::DataprocV1::ReservationAffinity, decorator: Google::Apis::DataprocV1::ReservationAffinity::Representation property :service_account, as: 'serviceAccount' diff --git a/generated/google/apis/dataproc_v1beta2.rb b/generated/google/apis/dataproc_v1beta2.rb index 2de8965fc..77bee1bf1 100644 --- a/generated/google/apis/dataproc_v1beta2.rb +++ b/generated/google/apis/dataproc_v1beta2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/dataproc/ module DataprocV1beta2 VERSION = 'V1beta2' - REVISION = '20200813' + REVISION = '20200902' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dataproc_v1beta2/classes.rb b/generated/google/apis/dataproc_v1beta2/classes.rb index ad1a4fd86..0973110d9 100644 --- a/generated/google/apis/dataproc_v1beta2/classes.rb +++ b/generated/google/apis/dataproc_v1beta2/classes.rb @@ -230,6 +230,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: " @@ -290,6 +296,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) @@ -410,7 +417,7 @@ module Google attr_accessor :endpoint_config # Common config settings for resources of Compute Engine cluster instances, - # applicable to all instances in the cluster. + # applicable to all instances in the cluster. NEXT ID: 14 # Corresponds to the JSON property `gceClusterConfig` # @return [Google::Apis::DataprocV1beta2::GceClusterConfig] attr_accessor :gce_cluster_config @@ -917,7 +924,7 @@ module Google end # Common config settings for resources of Compute Engine cluster instances, - # applicable to all instances in the cluster. + # applicable to all instances in the cluster. NEXT ID: 14 class GceClusterConfig include Google::Apis::Core::Hashable @@ -951,6 +958,11 @@ module Google # @return [String] attr_accessor :network_uri + # Optional. The type of IPv6 access for a cluster. + # Corresponds to the JSON property `privateIpv6GoogleAccess` + # @return [String] + attr_accessor :private_ipv6_google_access + # Reservation Affinity for consuming Zonal reservation. # Corresponds to the JSON property `reservationAffinity` # @return [Google::Apis::DataprocV1beta2::ReservationAffinity] @@ -1015,6 +1027,7 @@ module Google @internal_ip_only = args[:internal_ip_only] if args.key?(:internal_ip_only) @metadata = args[:metadata] if args.key?(:metadata) @network_uri = args[:network_uri] if args.key?(:network_uri) + @private_ipv6_google_access = args[:private_ipv6_google_access] if args.key?(:private_ipv6_google_access) @reservation_affinity = args[:reservation_affinity] if args.key?(:reservation_affinity) @service_account = args[:service_account] if args.key?(:service_account) @service_account_scopes = args[:service_account_scopes] if args.key?(:service_account_scopes) @@ -2707,11 +2720,11 @@ module Google class QueryList include Google::Apis::Core::Hashable - # Required. The queries to execute. You do not need to terminate a query with a - # semicolon. Multiple queries can be specified in one string by separating each - # with a semicolon. Here is an example of an Cloud Dataproc API snippet that - # uses a QueryList to specify a HiveJob: "hiveJob": ` "queryList": ` "queries": [ - # "query1", "query2", "query3;query4", ] ` ` + # Required. The queries to execute. You do not need to end a query expression + # with a semicolon. Multiple queries can be specified in one string by + # separating each with a semicolon. Here is an example of a Dataproc API snippet + # that uses a QueryList to specify a HiveJob: "hiveJob": ` "queryList": ` " + # queries": [ "query1", "query2", "query3;query4", ] ` ` # Corresponds to the JSON property `queries` # @return [Array] attr_accessor :queries @@ -3510,8 +3523,8 @@ module Google # The timeout duration must be from 10 minutes ("10m") to 24 hours ("24h" or "1d" # ). The timer begins when the first job is submitted. If the workflow is # running at the end of the timeout period, any remaining jobs are cancelled, - # the workflow is terminated, and if the workflow was running on a managed - # cluster, the cluster is deleted. + # the workflow is ended, and if the workflow was running on a managed cluster, + # the cluster is deleted. # Corresponds to the JSON property `dagTimeout` # @return [String] attr_accessor :dag_timeout diff --git a/generated/google/apis/dataproc_v1beta2/representations.rb b/generated/google/apis/dataproc_v1beta2/representations.rb index fb3e0fc8a..35cc224a1 100644 --- a/generated/google/apis/dataproc_v1beta2/representations.rb +++ b/generated/google/apis/dataproc_v1beta2/representations.rb @@ -560,6 +560,7 @@ module Google class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::DataprocV1beta2::Expr, decorator: Google::Apis::DataprocV1beta2::Expr::Representation collection :members, as: 'members' @@ -745,6 +746,7 @@ module Google property :internal_ip_only, as: 'internalIpOnly' hash :metadata, as: 'metadata' property :network_uri, as: 'networkUri' + property :private_ipv6_google_access, as: 'privateIpv6GoogleAccess' property :reservation_affinity, as: 'reservationAffinity', class: Google::Apis::DataprocV1beta2::ReservationAffinity, decorator: Google::Apis::DataprocV1beta2::ReservationAffinity::Representation property :service_account, as: 'serviceAccount' diff --git a/generated/google/apis/dialogflow_v2.rb b/generated/google/apis/dialogflow_v2.rb index f6e62e9a8..6a642492a 100644 --- a/generated/google/apis/dialogflow_v2.rb +++ b/generated/google/apis/dialogflow_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/dialogflow/ module DialogflowV2 VERSION = 'V2' - REVISION = '20200823' + REVISION = '20200903' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dialogflow_v2/classes.rb b/generated/google/apis/dialogflow_v2/classes.rb index 0e2fb5e54..7038f8c3b 100644 --- a/generated/google/apis/dialogflow_v2/classes.rb +++ b/generated/google/apis/dialogflow_v2/classes.rb @@ -410,6 +410,13 @@ module Google class GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText include Google::Apis::Core::Hashable + # Output only. Whether the playback of this message can be interrupted by the + # end user's speech and the client can then starts the next Dialogflow request. + # Corresponds to the JSON property `allowPlaybackInterruption` + # @return [Boolean] + attr_accessor :allow_playback_interruption + alias_method :allow_playback_interruption?, :allow_playback_interruption + # The SSML text to be synthesized. For more information, see [SSML](/speech/text- # to-speech/docs/ssml). # Corresponds to the JSON property `ssml` @@ -427,6 +434,7 @@ module Google # Update properties of this object def update!(**args) + @allow_playback_interruption = args[:allow_playback_interruption] if args.key?(:allow_playback_interruption) @ssml = args[:ssml] if args.key?(:ssml) @text = args[:text] if args.key?(:text) end @@ -3340,8 +3348,8 @@ module Google # may provide additional information in the payload. In particular, for the # Dialogflow Phone Gateway integration, this field has the form: ` "telephony": ` # "caller_id": "+18558363987" ` ` Note: The caller ID field (`caller_id`) will - # be redacted for Standard Edition agents and populated with the caller ID in [E. - # 164 format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents. + # be redacted for Trial Edition agents and populated with the caller ID in [E. + # 164 format](https://en.wikipedia.org/wiki/E.164) for Essentials Edition agents. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload @@ -4341,15 +4349,16 @@ module Google # @return [Fixnum] attr_accessor :lifespan_count - # Required. The unique identifier of the context. Format: `projects//agent/ - # sessions//contexts/`, or `projects//agent/environments//users//sessions// - # contexts/`. The `Context ID` is always converted to lowercase, may only - # contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. The following context - # names are reserved for internal use by Dialogflow. You should not use these - # contexts or create contexts with these names: * `__system_counters__` * `* - # _id_dialog_context` * `*_dialog_params_size` + # Required. The unique identifier of the context. Supported formats: - `projects/ + # /agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/` + # , - `projects//agent/environments//users//sessions//contexts/`, - `projects// + # locations//agent/environments//users//sessions//contexts/`, The `Context ID` + # is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% + # and may be at most 250 bytes long. If `Environment ID` is not specified, we + # assume default 'draft' environment. If `User ID` is not specified, we assume + # default '-' user. The following context names are reserved for internal use by + # Dialogflow. You should not use these contexts or create contexts with these + # names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4417,8 +4426,9 @@ module Google attr_accessor :kind # The unique identifier of the entity type. Required for EntityTypes. - # UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: ` - # projects//agent/entityTypes/`. + # UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Supported + # formats: - `projects//agent/entityTypes/` - `projects//locations//agent/ + # entityTypes/` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4591,7 +4601,8 @@ module Google attr_accessor :followup_intent_info # Optional. The list of context names required for this intent to be triggered. - # Format: `projects//agent/sessions/-/contexts/`. + # Formats: - `projects//agent/sessions/-/contexts/` - `projects//locations// + # agent/sessions/-/contexts/` # Corresponds to the JSON property `inputContextNames` # @return [Array] attr_accessor :input_context_names @@ -4631,8 +4642,8 @@ module Google alias_method :ml_enabled?, :ml_enabled # Optional. The unique identifier of this intent. Required for Intents. - # UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/ - # intents/`. + # UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - ` + # projects//agent/intents/` - `projects//locations//agent/intents/` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -6380,8 +6391,8 @@ module Google # may provide additional information in the payload. In particular, for the # Dialogflow Phone Gateway integration, this field has the form: ` "telephony": ` # "caller_id": "+18558363987" ` ` Note: The caller ID field (`caller_id`) will - # be redacted for Standard Edition agents and populated with the caller ID in [E. - # 164 format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents. + # be redacted for Trial Edition agents and populated with the caller ID in [E. + # 164 format](https://en.wikipedia.org/wiki/E.164) for Essentials Edition agents. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload @@ -6645,12 +6656,15 @@ module Google # @return [String] attr_accessor :entity_override_mode - # Required. The unique identifier of this session entity type. Format: `projects/ - # /agent/sessions//entityTypes/`, or `projects//agent/environments//users// - # sessions//entityTypes/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we assume default ' - # -' user. `` must be the display name of an existing entity type in the same - # agent that will be overridden or supplemented. + # Required. The unique identifier of this session entity type. Supported formats: + # - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/ + # sessions//entityTypes/` - `projects//agent/environments//users//sessions// + # entityTypes/` - `projects//locations//agent/environments/ /users//sessions// + # entityTypes/` If `Location ID` is not specified we assume default 'us' + # location. If `Environment ID` is not specified, we assume default 'draft' + # environment. If `User ID` is not specified, we assume default '-' user. `` + # must be the display name of an existing entity type in the same agent that + # will be overridden or supplemented. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -6694,8 +6708,10 @@ module Google attr_accessor :response_id # The unique identifier of detectIntent request session. Can be used to identify - # end-user inside webhook implementation. Format: `projects//agent/sessions/`, - # or `projects//agent/environments//users//sessions/`. + # end-user inside webhook implementation. Supported formats: - `projects//agent/ + # sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/ + # environments//users//sessions/`, - `projects//locations//agent/environments// + # users//sessions/`, # Corresponds to the JSON property `session` # @return [String] attr_accessor :session diff --git a/generated/google/apis/dialogflow_v2/representations.rb b/generated/google/apis/dialogflow_v2/representations.rb index b62da878a..7dfaae573 100644 --- a/generated/google/apis/dialogflow_v2/representations.rb +++ b/generated/google/apis/dialogflow_v2/representations.rb @@ -1243,6 +1243,7 @@ module Google class GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText # @private class Representation < Google::Apis::Core::JsonRepresentation + property :allow_playback_interruption, as: 'allowPlaybackInterruption' property :ssml, as: 'ssml' property :text, as: 'text' end diff --git a/generated/google/apis/dialogflow_v2beta1.rb b/generated/google/apis/dialogflow_v2beta1.rb index 9d5524554..5b136ec00 100644 --- a/generated/google/apis/dialogflow_v2beta1.rb +++ b/generated/google/apis/dialogflow_v2beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/dialogflow/ module DialogflowV2beta1 VERSION = 'V2beta1' - REVISION = '20200823' + REVISION = '20200903' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dialogflow_v2beta1/classes.rb b/generated/google/apis/dialogflow_v2beta1/classes.rb index 023812e1d..95cc85707 100644 --- a/generated/google/apis/dialogflow_v2beta1/classes.rb +++ b/generated/google/apis/dialogflow_v2beta1/classes.rb @@ -410,6 +410,13 @@ module Google class GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText include Google::Apis::Core::Hashable + # Output only. Whether the playback of this message can be interrupted by the + # end user's speech and the client can then starts the next Dialogflow request. + # Corresponds to the JSON property `allowPlaybackInterruption` + # @return [Boolean] + attr_accessor :allow_playback_interruption + alias_method :allow_playback_interruption?, :allow_playback_interruption + # The SSML text to be synthesized. For more information, see [SSML](/speech/text- # to-speech/docs/ssml). # Corresponds to the JSON property `ssml` @@ -427,6 +434,7 @@ module Google # Update properties of this object def update!(**args) + @allow_playback_interruption = args[:allow_playback_interruption] if args.key?(:allow_playback_interruption) @ssml = args[:ssml] if args.key?(:ssml) @text = args[:text] if args.key?(:text) end @@ -2394,8 +2402,8 @@ module Google # may provide additional information in the payload. In particular, for the # Dialogflow Phone Gateway integration, this field has the form: ` "telephony": ` # "caller_id": "+18558363987" ` ` Note: The caller ID field (`caller_id`) will - # be redacted for Standard Edition agents and populated with the caller ID in [E. - # 164 format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents. + # be redacted for Trial Edition agents and populated with the caller ID in [E. + # 164 format](https://en.wikipedia.org/wiki/E.164) for Essentials Edition agents. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload @@ -2867,7 +2875,8 @@ module Google # @return [String] attr_accessor :match_mode - # Required. The project of this agent. Format: `projects/`. + # Required. The project of this agent. Format: `projects/` or `projects// + # locations/` # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -3288,15 +3297,16 @@ module Google # @return [Fixnum] attr_accessor :lifespan_count - # Required. The unique identifier of the context. Format: `projects//agent/ - # sessions//contexts/`, or `projects//agent/environments//users//sessions// - # contexts/`. The `Context ID` is always converted to lowercase, may only - # contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. The following context - # names are reserved for internal use by Dialogflow. You should not use these - # contexts or create contexts with these names: * `__system_counters__` * `* - # _id_dialog_context` * `*_dialog_params_size` + # Required. The unique identifier of the context. Supported formats: - `projects/ + # /agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/` + # , - `projects//agent/environments//users//sessions//contexts/`, - `projects// + # locations//agent/environments//users//sessions//contexts/`, The `Context ID` + # is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% + # and may be at most 250 bytes long. If `Environment ID` is not specified, we + # assume default 'draft' environment. If `User ID` is not specified, we assume + # default '-' user. The following context names are reserved for internal use by + # Dialogflow. You should not use these contexts or create contexts with these + # names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3612,8 +3622,9 @@ module Google attr_accessor :kind # The unique identifier of the entity type. Required for EntityTypes. - # UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: ` - # projects//agent/entityTypes/`. + # UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Supported + # formats: - `projects//agent/entityTypes/` - `projects//locations//agent/ + # entityTypes/` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3696,8 +3707,8 @@ module Google class GoogleCloudDialogflowV2beta1Environment include Google::Apis::Core::Hashable - # Optional. The agent version loaded into this environment. Format: `projects// - # agent/versions/`. + # Optional. The agent version loaded into this environment. Supported formats: - + # `projects//agent/versions/` - `projects//locations//agent/versions/` # Corresponds to the JSON property `agentVersion` # @return [String] attr_accessor :agent_version @@ -3708,8 +3719,9 @@ module Google # @return [String] attr_accessor :description - # Output only. The unique identifier of this agent environment. Format: - ` - # projects//agent/environments/` - `projects//locations//agent/environments/` + # Output only. The unique identifier of this agent environment. Supported + # formats: - `projects//agent/environments/` - `projects//locations//agent/ + # environments/` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3869,8 +3881,8 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1FulfillmentGenericWebService] attr_accessor :generic_web_service - # Required. The unique identifier of the fulfillment. Format: `projects//agent/ - # fulfillment`. + # Required. The unique identifier of the fulfillment. Supported formats: - ` + # projects//agent/fulfillment` - `projects//locations//agent/fulfillment` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4155,7 +4167,8 @@ module Google attr_accessor :followup_intent_info # Optional. The list of context names required for this intent to be triggered. - # Format: `projects//agent/sessions/-/contexts/`. + # Formats: - `projects//agent/sessions/-/contexts/` - `projects//locations// + # agent/sessions/-/contexts/` # Corresponds to the JSON property `inputContextNames` # @return [Array] attr_accessor :input_context_names @@ -4195,8 +4208,8 @@ module Google alias_method :ml_enabled?, :ml_enabled # Optional. The unique identifier of this intent. Required for Intents. - # UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/ - # intents/`. + # UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - ` + # projects//agent/intents/` - `projects//locations//agent/intents/` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -6191,8 +6204,8 @@ module Google # may provide additional information in the payload. In particular, for the # Dialogflow Phone Gateway integration, this field has the form: ` "telephony": ` # "caller_id": "+18558363987" ` ` Note: The caller ID field (`caller_id`) will - # be redacted for Standard Edition agents and populated with the caller ID in [E. - # 164 format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents. + # be redacted for Trial Edition agents and populated with the caller ID in [E. + # 164 format](https://en.wikipedia.org/wiki/E.164) for Essentials Edition agents. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload @@ -6721,12 +6734,15 @@ module Google # @return [String] attr_accessor :entity_override_mode - # Required. The unique identifier of this session entity type. Format: `projects/ - # /agent/sessions//entityTypes/`, or `projects//agent/environments//users// - # sessions//entityTypes/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we assume default ' - # -' user. `` must be the display name of an existing entity type in the same - # agent that will be overridden or supplemented. + # Required. The unique identifier of this session entity type. Supported formats: + # - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/ + # sessions//entityTypes/` - `projects//agent/environments//users//sessions// + # entityTypes/` - `projects//locations//agent/environments/ /users//sessions// + # entityTypes/` If `Location ID` is not specified we assume default 'us' + # location. If `Environment ID` is not specified, we assume default 'draft' + # environment. If `User ID` is not specified, we assume default '-' user. `` + # must be the display name of an existing entity type in the same agent that + # will be overridden or supplemented. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -6790,7 +6806,8 @@ module Google # @return [String] attr_accessor :environment - # Required. The project of this agent. Format: `projects/`. + # Required. The project of this agent. Format: `projects/` or `projects// + # locations/`. # Corresponds to the JSON property `project` # @return [String] attr_accessor :project @@ -7018,8 +7035,10 @@ module Google attr_accessor :response_id # The unique identifier of detectIntent request session. Can be used to identify - # end-user inside webhook implementation. Format: `projects//agent/sessions/`, - # or `projects//agent/environments//users//sessions/`. + # end-user inside webhook implementation. Supported formats: - `projects//agent/ + # sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/ + # environments//users//sessions/`, - `projects//locations//agent/environments// + # users//sessions/`, # Corresponds to the JSON property `session` # @return [String] attr_accessor :session diff --git a/generated/google/apis/dialogflow_v2beta1/representations.rb b/generated/google/apis/dialogflow_v2beta1/representations.rb index 009244109..c68b09c79 100644 --- a/generated/google/apis/dialogflow_v2beta1/representations.rb +++ b/generated/google/apis/dialogflow_v2beta1/representations.rb @@ -1291,6 +1291,7 @@ module Google class GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText # @private class Representation < Google::Apis::Core::JsonRepresentation + property :allow_playback_interruption, as: 'allowPlaybackInterruption' property :ssml, as: 'ssml' property :text, as: 'text' end diff --git a/generated/google/apis/dialogflow_v2beta1/service.rb b/generated/google/apis/dialogflow_v2beta1/service.rb index 576070edb..a91a77d05 100644 --- a/generated/google/apis/dialogflow_v2beta1/service.rb +++ b/generated/google/apis/dialogflow_v2beta1/service.rb @@ -51,7 +51,7 @@ module Google # Deletes the specified agent. # @param [String] parent # Required. The project that the agent to delete is associated with. Format: ` - # projects/`. + # projects/` or `projects//locations/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -82,7 +82,7 @@ module Google # Retrieves the specified agent. # @param [String] parent # Required. The project that the agent to fetch is associated with. Format: ` - # projects/`. + # projects/` or `projects//locations/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -112,7 +112,8 @@ module Google # Creates/updates the specified agent. # @param [String] parent - # Required. The project of this agent. Format: `projects/`. + # Required. The project of this agent. Format: `projects/` or `projects// + # locations/` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Agent] google_cloud_dialogflow_v2beta1_agent_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -149,7 +150,7 @@ module Google # Exports the specified agent to a ZIP file. Operation # @param [String] parent # Required. The project that the agent to export is associated with. Format: ` - # projects/`. + # projects/` or `projects//locations/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ExportAgentRequest] google_cloud_dialogflow_v2beta1_export_agent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -182,7 +183,8 @@ module Google # Retrieves the fulfillment. # @param [String] name - # Required. The name of the fulfillment. Format: `projects//agent/fulfillment`. + # Required. The name of the fulfillment. Supported formats: - `projects//agent/ + # fulfillment` - `projects//locations//agent/fulfillment` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -213,7 +215,8 @@ module Google # Gets agent validation result. Agent validation is performed during training # time and is updated automatically when training is completed. # @param [String] parent - # Required. The project that the agent is associated with. Format: `projects/`. + # Required. The project that the agent is associated with. Format: `projects/` + # or `projects//locations/`. # @param [String] language_code # Optional. The language for which you want a validation result. If not # specified, the agent's default language is used. [Many languages](https:// @@ -258,7 +261,7 @@ module Google # it is done training. # @param [String] parent # Required. The project that the agent to import is associated with. Format: ` - # projects/`. + # projects/` or `projects//locations/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ImportAgentRequest] google_cloud_dialogflow_v2beta1_import_agent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -299,7 +302,7 @@ module Google # draft agent is updated not when it is done training. # @param [String] parent # Required. The project that the agent to restore is associated with. Format: ` - # projects/`. + # projects/` or `projects//locations/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1RestoreAgentRequest] google_cloud_dialogflow_v2beta1_restore_agent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -336,7 +339,8 @@ module Google # project collection id "-". Refer to [List Sub-Collections](https://cloud. # google.com/apis/design/design_patterns#list_sub-collections). # @param [String] parent - # Required. The project to list agents from. Format: `projects/`. + # Required. The project to list agents from. Format: `projects/` or `projects// + # locations/`. # @param [Fixnum] page_size # Optional. The maximum number of items to return in a single page. By default # 100 and at most 1000. @@ -374,7 +378,7 @@ module Google # Trains the specified agent. Operation # @param [String] parent # Required. The project that the agent to train is associated with. Format: ` - # projects/`. + # projects/` or `projects//locations/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1TrainAgentRequest] google_cloud_dialogflow_v2beta1_train_agent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -407,8 +411,8 @@ module Google # Updates the fulfillment. # @param [String] name - # Required. The unique identifier of the fulfillment. Format: `projects//agent/ - # fulfillment`. + # Required. The unique identifier of the fulfillment. Supported formats: - ` + # projects//agent/fulfillment` - `projects//locations//agent/fulfillment` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Fulfillment] google_cloud_dialogflow_v2beta1_fulfillment_object # @param [String] update_mask # Required. The mask to control which fields get updated. If the mask is not @@ -445,8 +449,8 @@ module Google # Deletes entity types in the specified agent. Operation # @param [String] parent - # Required. The name of the agent to delete all entities types for. Format: ` - # projects//agent`. + # Required. The name of the agent to delete all entities types for. Supported + # formats: - `projects//agent`, - `projects//locations//agent`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest] google_cloud_dialogflow_v2beta1_batch_delete_entity_types_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -479,8 +483,8 @@ module Google # Updates/Creates multiple entity types in the specified agent. Operation # @param [String] parent - # Required. The name of the agent to update or create entity types in. Format: ` - # projects//agent`. + # Required. The name of the agent to update or create entity types in. Supported + # formats: - `projects//agent` - `projects//locations//agent` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest] google_cloud_dialogflow_v2beta1_batch_update_entity_types_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -513,7 +517,8 @@ module Google # Creates an entity type in the specified agent. # @param [String] parent - # Required. The agent to create a entity type for. Format: `projects//agent`. + # Required. The agent to create a entity type for. Supported formats: - ` + # projects//agent` - `projects//locations//agent` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType] google_cloud_dialogflow_v2beta1_entity_type_object # @param [String] language_code # Optional. The language used to access language-specific data. If not specified, @@ -552,8 +557,8 @@ module Google # Deletes the specified entity type. # @param [String] name - # Required. The name of the entity type to delete. Format: `projects//agent/ - # entityTypes/`. + # Required. The name of the entity type to delete. Supported formats: - ` + # projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -583,7 +588,8 @@ module Google # Retrieves the specified entity type. # @param [String] name - # Required. The name of the entity type. Format: `projects//agent/entityTypes/`. + # Required. The name of the entity type. Supported formats: - `projects//agent/ + # entityTypes/` - `projects//locations//agent/entityTypes/` # @param [String] language_code # Optional. The language used to access language-specific data. If not specified, # the agent's default language is used. For more information, see [Multilingual @@ -619,7 +625,8 @@ module Google # Returns the list of all entity types in the specified agent. # @param [String] parent - # Required. The agent to list all entity types from. Format: `projects//agent`. + # Required. The agent to list all entity types from. Supported formats: - ` + # projects//agent` - `projects//locations//agent` # @param [String] language_code # Optional. The language used to access language-specific data. If not specified, # the agent's default language is used. For more information, see [Multilingual @@ -663,8 +670,9 @@ module Google # Updates the specified entity type. # @param [String] name # The unique identifier of the entity type. Required for EntityTypes. - # UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: ` - # projects//agent/entityTypes/`. + # UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Supported + # formats: - `projects//agent/entityTypes/` - `projects//locations//agent/ + # entityTypes/` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType] google_cloud_dialogflow_v2beta1_entity_type_object # @param [String] language_code # Optional. The language used to access language-specific data. If not specified, @@ -706,8 +714,8 @@ module Google # Creates multiple new entities in the specified entity type. Operation # @param [String] parent - # Required. The name of the entity type to create entities in. Format: `projects/ - # /agent/entityTypes/`. + # Required. The name of the entity type to create entities in. Supported formats: + # - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest] google_cloud_dialogflow_v2beta1_batch_create_entities_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -740,8 +748,8 @@ module Google # Deletes entities in the specified entity type. Operation # @param [String] parent - # Required. The name of the entity type to delete entries for. Format: `projects/ - # /agent/entityTypes/`. + # Required. The name of the entity type to delete entries for. Supported formats: + # - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest] google_cloud_dialogflow_v2beta1_batch_delete_entities_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -776,8 +784,9 @@ module Google # does not affect entities in the entity type that aren't explicitly specified # in the request. Operation # @param [String] parent - # Required. The name of the entity type to update or create entities in. Format: - # `projects//agent/entityTypes/`. + # Required. The name of the entity type to update or create entities in. + # Supported formats: - `projects//agent/entityTypes/` - `projects//locations// + # agent/entityTypes/` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest] google_cloud_dialogflow_v2beta1_batch_update_entities_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -811,7 +820,7 @@ module Google # Returns the list of all non-draft environments of the specified agent. # @param [String] parent # Required. The agent to list all environments from. Format: - `projects//agent` - # - `projects//locations//agent + # - `projects//locations//agent` # @param [Fixnum] page_size # Optional. The maximum number of items to return in a single page. By default # 100 and at most 1000. @@ -848,10 +857,13 @@ module Google # Deletes all active contexts in the specified session. # @param [String] parent - # Required. The name of the session to delete all contexts from. Format: ` - # projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. - # If `Environment ID` is not specified we assume default 'draft' environment. - # If `User ID` is not specified, we assume default '-' user. + # Required. The name of the session to delete all contexts from. Supported + # formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/` + # , - `projects//agent/environments//users//sessions/`, - `projects//locations// + # agent/environments//users//sessions/`, If `Location ID` is not specified we + # assume default 'us' location. If `Environment ID` is not specified we assume + # default 'draft' environment. If `User ID` is not specified, we assume default ' + # -' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -884,15 +896,17 @@ module Google # session entity types to be updated, which in turn might affect results of # future queries. # @param [String] session - # Required. The name of the session this query is sent to. Format: `projects// - # agent/sessions/`, or `projects//agent/environments//users//sessions/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we are using "-". It's up to the API caller to - # choose an appropriate `Session ID` and `User Id`. They can be a random number - # or some type of user and session identifiers (preferably hashed). The length - # of the `Session ID` and `User ID` must not exceed 36 characters. For more - # information, see the [API interactions guide](https://cloud.google.com/ - # dialogflow/docs/api-overview). + # Required. The name of the session this query is sent to. Supported formats: - ` + # projects//agent/sessions/, - `projects//locations//agent/sessions/`, - ` + # projects//agent/environments//users//sessions/`, - `projects//locations//agent/ + # environments//users//sessions/`, If `Location ID` is not specified we assume + # default 'us' location. If `Environment ID` is not specified, we assume default + # 'draft' environment. If `User ID` is not specified, we are using "-". It's up + # to the API caller to choose an appropriate `Session ID` and `User Id`. They + # can be a random number or some type of user and session identifiers ( + # preferably hashed). The length of the `Session ID` and `User ID` must not + # exceed 36 characters. For more information, see the [API interactions guide]( + # https://cloud.google.com/dialogflow/docs/api-overview). # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentRequest] google_cloud_dialogflow_v2beta1_detect_intent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -926,10 +940,12 @@ module Google # Creates a context. If the specified context already exists, overrides the # context. # @param [String] parent - # Required. The session to create a context for. Format: `projects//agent/ - # sessions/` or `projects//agent/environments//users//sessions/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The session to create a context for. Supported formats: - `projects// + # agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/ + # environments//users//sessions/`, - `projects//locations//agent/environments// + # users//sessions/`, If `Location ID` is not specified we assume default 'us' + # location. If `Environment ID` is not specified, we assume default 'draft' + # environment. If `User ID` is not specified, we assume default '-' user. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context] google_cloud_dialogflow_v2beta1_context_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -962,10 +978,13 @@ module Google # Deletes the specified context. # @param [String] name - # Required. The name of the context to delete. Format: `projects//agent/sessions/ - # /contexts/` or `projects//agent/environments//users//sessions//contexts/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The name of the context to delete. Supported formats: - `projects// + # agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, + # - `projects//agent/environments//users//sessions//contexts/`, - `projects// + # locations//agent/environments//users//sessions//contexts/`, If `Location ID` + # is not specified we assume default 'us' location. If `Environment ID` is not + # specified, we assume default 'draft' environment. If `User ID` is not + # specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -995,10 +1014,13 @@ module Google # Retrieves the specified context. # @param [String] name - # Required. The name of the context. Format: `projects//agent/sessions//contexts/ - # ` or `projects//agent/environments//users//sessions//contexts/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The name of the context. Supported formats: - `projects//agent/ + # sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - ` + # projects//agent/environments//users//sessions//contexts/`, - `projects// + # locations//agent/environments//users//sessions//contexts/`, If `Location ID` + # is not specified we assume default 'us' location. If `Environment ID` is not + # specified, we assume default 'draft' environment. If `User ID` is not + # specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1028,10 +1050,12 @@ module Google # Returns the list of all contexts in the specified session. # @param [String] parent - # Required. The session to list all contexts from. Format: `projects//agent/ - # sessions/` or `projects//agent/environments//users//sessions/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The session to list all contexts from. Supported formats: - ` + # projects//agent/sessions/, - `projects//locations//agent/sessions/`, - ` + # projects//agent/environments//users//sessions/`, - `projects//locations//agent/ + # environments//users//sessions/`, If `Location ID` is not specified we assume + # default 'us' location. If `Environment ID` is not specified, we assume default + # 'draft' environment. If `User ID` is not specified, we assume default '-' user. # @param [Fixnum] page_size # Optional. The maximum number of items to return in a single page. By default # 100 and at most 1000. @@ -1068,15 +1092,16 @@ module Google # Updates the specified context. # @param [String] name - # Required. The unique identifier of the context. Format: `projects//agent/ - # sessions//contexts/`, or `projects//agent/environments//users//sessions// - # contexts/`. The `Context ID` is always converted to lowercase, may only - # contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. The following context - # names are reserved for internal use by Dialogflow. You should not use these - # contexts or create contexts with these names: * `__system_counters__` * `* - # _id_dialog_context` * `*_dialog_params_size` + # Required. The unique identifier of the context. Supported formats: - `projects/ + # /agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/` + # , - `projects//agent/environments//users//sessions//contexts/`, - `projects// + # locations//agent/environments//users//sessions//contexts/`, The `Context ID` + # is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% + # and may be at most 250 bytes long. If `Environment ID` is not specified, we + # assume default 'draft' environment. If `User ID` is not specified, we assume + # default '-' user. The following context names are reserved for internal use by + # Dialogflow. You should not use these contexts or create contexts with these + # names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context] google_cloud_dialogflow_v2beta1_context_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -1115,10 +1140,12 @@ module Google # Google Assistant integration. Contact Dialogflow support if you need to use # session entities with Google Assistant integration. # @param [String] parent - # Required. The session to create a session entity type for. Format: `projects// - # agent/sessions/` or `projects//agent/environments//users// sessions/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The session to create a session entity type for. Supported formats: - + # `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - ` + # projects//agent/environments//users//sessions/`, - `projects//locations//agent/ + # environments//users//sessions/`, If `Location ID` is not specified we assume + # default 'us' location. If `Environment ID` is not specified, we assume default + # 'draft' environment. If `User ID` is not specified, we assume default '-' user. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType] google_cloud_dialogflow_v2beta1_session_entity_type_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1153,10 +1180,13 @@ module Google # Google Assistant integration. Contact Dialogflow support if you need to use # session entities with Google Assistant integration. # @param [String] name - # Required. The name of the entity type to delete. Format: `projects//agent/ - # sessions//entityTypes/` or `projects//agent/environments//users//sessions// - # entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The name of the entity type to delete. Supported formats: - ` + # projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions/ + # /entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` + # - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If + # `Location ID` is not specified we assume default 'us' location. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1188,10 +1218,13 @@ module Google # Google Assistant integration. Contact Dialogflow support if you need to use # session entities with Google Assistant integration. # @param [String] name - # Required. The name of the session entity type. Format: `projects//agent/ - # sessions//entityTypes/` or `projects//agent/environments//users//sessions// - # entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The name of the session entity type. Supported formats: - `projects// + # agent/sessions//entityTypes/` - `projects//locations//agent/sessions// + # entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - + # `projects//locations//agent/environments/ /users//sessions//entityTypes/` If ` + # Location ID` is not specified we assume default 'us' location. If `Environment + # ID` is not specified, we assume default 'draft' environment. If `User ID` is + # not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1223,10 +1256,12 @@ module Google # method doesn't work with Google Assistant integration. Contact Dialogflow # support if you need to use session entities with Google Assistant integration. # @param [String] parent - # Required. The session to list all session entity types from. Format: `projects/ - # /agent/sessions/` or `projects//agent/environments//users// sessions/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The session to list all session entity types from. Supported formats: + # - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - ` + # projects//agent/environments//users//sessions/`, - `projects//locations//agent/ + # environments//users//sessions/`, If `Location ID` is not specified we assume + # default 'us' location. If `Environment ID` is not specified, we assume default + # 'draft' environment. If `User ID` is not specified, we assume default '-' user. # @param [Fixnum] page_size # Optional. The maximum number of items to return in a single page. By default # 100 and at most 1000. @@ -1265,12 +1300,15 @@ module Google # Google Assistant integration. Contact Dialogflow support if you need to use # session entities with Google Assistant integration. # @param [String] name - # Required. The unique identifier of this session entity type. Format: `projects/ - # /agent/sessions//entityTypes/`, or `projects//agent/environments//users// - # sessions//entityTypes/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we assume default ' - # -' user. `` must be the display name of an existing entity type in the same - # agent that will be overridden or supplemented. + # Required. The unique identifier of this session entity type. Supported formats: + # - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/ + # sessions//entityTypes/` - `projects//agent/environments//users//sessions// + # entityTypes/` - `projects//locations//agent/environments/ /users//sessions// + # entityTypes/` If `Location ID` is not specified we assume default 'us' + # location. If `Environment ID` is not specified, we assume default 'draft' + # environment. If `User ID` is not specified, we assume default '-' user. `` + # must be the display name of an existing entity type in the same agent that + # will be overridden or supplemented. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType] google_cloud_dialogflow_v2beta1_session_entity_type_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -1306,8 +1344,8 @@ module Google # Deletes intents in the specified agent. Operation # @param [String] parent - # Required. The name of the agent to delete all entities types for. Format: ` - # projects//agent`. + # Required. The name of the agent to delete all entities types for. Supported + # formats: - `projects//agent` - `projects//locations//agent` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest] google_cloud_dialogflow_v2beta1_batch_delete_intents_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1340,8 +1378,8 @@ module Google # Updates/Creates multiple intents in the specified agent. Operation # @param [String] parent - # Required. The name of the agent to update or create intents in. Format: ` - # projects//agent`. + # Required. The name of the agent to update or create intents in. Supported + # formats: - `projects//agent` - `projects//locations//agent` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest] google_cloud_dialogflow_v2beta1_batch_update_intents_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1374,7 +1412,8 @@ module Google # Creates an intent in the specified agent. # @param [String] parent - # Required. The agent to create a intent for. Format: `projects//agent`. + # Required. The agent to create a intent for. Supported formats: - `projects// + # agent` - `projects//locations//agent` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent] google_cloud_dialogflow_v2beta1_intent_object # @param [String] intent_view # Optional. The resource view to apply to the returned intent. @@ -1417,8 +1456,8 @@ module Google # Deletes the specified intent and its direct or indirect followup intents. # @param [String] name # Required. The name of the intent to delete. If this intent has direct or - # indirect followup intents, we also delete them. Format: `projects//agent/ - # intents/`. + # indirect followup intents, we also delete them. Supported formats: - `projects/ + # /agent/intents/` - `projects//locations//agent/intents/` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1448,7 +1487,8 @@ module Google # Retrieves the specified intent. # @param [String] name - # Required. The name of the intent. Format: `projects//agent/intents/`. + # Required. The name of the intent. Supported formats: - `projects//agent/ + # intents/` - `projects//locations//agent/intents/` # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code @@ -1534,8 +1574,8 @@ module Google # Updates the specified intent. # @param [String] name # Optional. The unique identifier of this intent. Required for Intents. - # UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/ - # intents/`. + # UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - ` + # projects//agent/intents/` - `projects//locations//agent/intents/` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent] google_cloud_dialogflow_v2beta1_intent_object # @param [String] intent_view # Optional. The resource view to apply to the returned intent. @@ -1982,10 +2022,13 @@ module Google # Deletes all active contexts in the specified session. # @param [String] parent - # Required. The name of the session to delete all contexts from. Format: ` - # projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. - # If `Environment ID` is not specified we assume default 'draft' environment. - # If `User ID` is not specified, we assume default '-' user. + # Required. The name of the session to delete all contexts from. Supported + # formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/` + # , - `projects//agent/environments//users//sessions/`, - `projects//locations// + # agent/environments//users//sessions/`, If `Location ID` is not specified we + # assume default 'us' location. If `Environment ID` is not specified we assume + # default 'draft' environment. If `User ID` is not specified, we assume default ' + # -' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2018,15 +2061,17 @@ module Google # session entity types to be updated, which in turn might affect results of # future queries. # @param [String] session - # Required. The name of the session this query is sent to. Format: `projects// - # agent/sessions/`, or `projects//agent/environments//users//sessions/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we are using "-". It's up to the API caller to - # choose an appropriate `Session ID` and `User Id`. They can be a random number - # or some type of user and session identifiers (preferably hashed). The length - # of the `Session ID` and `User ID` must not exceed 36 characters. For more - # information, see the [API interactions guide](https://cloud.google.com/ - # dialogflow/docs/api-overview). + # Required. The name of the session this query is sent to. Supported formats: - ` + # projects//agent/sessions/, - `projects//locations//agent/sessions/`, - ` + # projects//agent/environments//users//sessions/`, - `projects//locations//agent/ + # environments//users//sessions/`, If `Location ID` is not specified we assume + # default 'us' location. If `Environment ID` is not specified, we assume default + # 'draft' environment. If `User ID` is not specified, we are using "-". It's up + # to the API caller to choose an appropriate `Session ID` and `User Id`. They + # can be a random number or some type of user and session identifiers ( + # preferably hashed). The length of the `Session ID` and `User ID` must not + # exceed 36 characters. For more information, see the [API interactions guide]( + # https://cloud.google.com/dialogflow/docs/api-overview). # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentRequest] google_cloud_dialogflow_v2beta1_detect_intent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2060,10 +2105,12 @@ module Google # Creates a context. If the specified context already exists, overrides the # context. # @param [String] parent - # Required. The session to create a context for. Format: `projects//agent/ - # sessions/` or `projects//agent/environments//users//sessions/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The session to create a context for. Supported formats: - `projects// + # agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/ + # environments//users//sessions/`, - `projects//locations//agent/environments// + # users//sessions/`, If `Location ID` is not specified we assume default 'us' + # location. If `Environment ID` is not specified, we assume default 'draft' + # environment. If `User ID` is not specified, we assume default '-' user. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context] google_cloud_dialogflow_v2beta1_context_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2096,10 +2143,13 @@ module Google # Deletes the specified context. # @param [String] name - # Required. The name of the context to delete. Format: `projects//agent/sessions/ - # /contexts/` or `projects//agent/environments//users//sessions//contexts/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The name of the context to delete. Supported formats: - `projects// + # agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, + # - `projects//agent/environments//users//sessions//contexts/`, - `projects// + # locations//agent/environments//users//sessions//contexts/`, If `Location ID` + # is not specified we assume default 'us' location. If `Environment ID` is not + # specified, we assume default 'draft' environment. If `User ID` is not + # specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2129,10 +2179,13 @@ module Google # Retrieves the specified context. # @param [String] name - # Required. The name of the context. Format: `projects//agent/sessions//contexts/ - # ` or `projects//agent/environments//users//sessions//contexts/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The name of the context. Supported formats: - `projects//agent/ + # sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - ` + # projects//agent/environments//users//sessions//contexts/`, - `projects// + # locations//agent/environments//users//sessions//contexts/`, If `Location ID` + # is not specified we assume default 'us' location. If `Environment ID` is not + # specified, we assume default 'draft' environment. If `User ID` is not + # specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2162,10 +2215,12 @@ module Google # Returns the list of all contexts in the specified session. # @param [String] parent - # Required. The session to list all contexts from. Format: `projects//agent/ - # sessions/` or `projects//agent/environments//users//sessions/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The session to list all contexts from. Supported formats: - ` + # projects//agent/sessions/, - `projects//locations//agent/sessions/`, - ` + # projects//agent/environments//users//sessions/`, - `projects//locations//agent/ + # environments//users//sessions/`, If `Location ID` is not specified we assume + # default 'us' location. If `Environment ID` is not specified, we assume default + # 'draft' environment. If `User ID` is not specified, we assume default '-' user. # @param [Fixnum] page_size # Optional. The maximum number of items to return in a single page. By default # 100 and at most 1000. @@ -2202,15 +2257,16 @@ module Google # Updates the specified context. # @param [String] name - # Required. The unique identifier of the context. Format: `projects//agent/ - # sessions//contexts/`, or `projects//agent/environments//users//sessions// - # contexts/`. The `Context ID` is always converted to lowercase, may only - # contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. The following context - # names are reserved for internal use by Dialogflow. You should not use these - # contexts or create contexts with these names: * `__system_counters__` * `* - # _id_dialog_context` * `*_dialog_params_size` + # Required. The unique identifier of the context. Supported formats: - `projects/ + # /agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/` + # , - `projects//agent/environments//users//sessions//contexts/`, - `projects// + # locations//agent/environments//users//sessions//contexts/`, The `Context ID` + # is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% + # and may be at most 250 bytes long. If `Environment ID` is not specified, we + # assume default 'draft' environment. If `User ID` is not specified, we assume + # default '-' user. The following context names are reserved for internal use by + # Dialogflow. You should not use these contexts or create contexts with these + # names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context] google_cloud_dialogflow_v2beta1_context_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -2249,10 +2305,12 @@ module Google # Google Assistant integration. Contact Dialogflow support if you need to use # session entities with Google Assistant integration. # @param [String] parent - # Required. The session to create a session entity type for. Format: `projects// - # agent/sessions/` or `projects//agent/environments//users// sessions/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The session to create a session entity type for. Supported formats: - + # `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - ` + # projects//agent/environments//users//sessions/`, - `projects//locations//agent/ + # environments//users//sessions/`, If `Location ID` is not specified we assume + # default 'us' location. If `Environment ID` is not specified, we assume default + # 'draft' environment. If `User ID` is not specified, we assume default '-' user. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType] google_cloud_dialogflow_v2beta1_session_entity_type_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2287,10 +2345,13 @@ module Google # Google Assistant integration. Contact Dialogflow support if you need to use # session entities with Google Assistant integration. # @param [String] name - # Required. The name of the entity type to delete. Format: `projects//agent/ - # sessions//entityTypes/` or `projects//agent/environments//users//sessions// - # entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The name of the entity type to delete. Supported formats: - ` + # projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions/ + # /entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` + # - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If + # `Location ID` is not specified we assume default 'us' location. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2322,10 +2383,13 @@ module Google # Google Assistant integration. Contact Dialogflow support if you need to use # session entities with Google Assistant integration. # @param [String] name - # Required. The name of the session entity type. Format: `projects//agent/ - # sessions//entityTypes/` or `projects//agent/environments//users//sessions// - # entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The name of the session entity type. Supported formats: - `projects// + # agent/sessions//entityTypes/` - `projects//locations//agent/sessions// + # entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - + # `projects//locations//agent/environments/ /users//sessions//entityTypes/` If ` + # Location ID` is not specified we assume default 'us' location. If `Environment + # ID` is not specified, we assume default 'draft' environment. If `User ID` is + # not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2357,10 +2421,12 @@ module Google # method doesn't work with Google Assistant integration. Contact Dialogflow # support if you need to use session entities with Google Assistant integration. # @param [String] parent - # Required. The session to list all session entity types from. Format: `projects/ - # /agent/sessions/` or `projects//agent/environments//users// sessions/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The session to list all session entity types from. Supported formats: + # - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - ` + # projects//agent/environments//users//sessions/`, - `projects//locations//agent/ + # environments//users//sessions/`, If `Location ID` is not specified we assume + # default 'us' location. If `Environment ID` is not specified, we assume default + # 'draft' environment. If `User ID` is not specified, we assume default '-' user. # @param [Fixnum] page_size # Optional. The maximum number of items to return in a single page. By default # 100 and at most 1000. @@ -2399,12 +2465,15 @@ module Google # Google Assistant integration. Contact Dialogflow support if you need to use # session entities with Google Assistant integration. # @param [String] name - # Required. The unique identifier of this session entity type. Format: `projects/ - # /agent/sessions//entityTypes/`, or `projects//agent/environments//users// - # sessions//entityTypes/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we assume default ' - # -' user. `` must be the display name of an existing entity type in the same - # agent that will be overridden or supplemented. + # Required. The unique identifier of this session entity type. Supported formats: + # - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/ + # sessions//entityTypes/` - `projects//agent/environments//users//sessions// + # entityTypes/` - `projects//locations//agent/environments/ /users//sessions// + # entityTypes/` If `Location ID` is not specified we assume default 'us' + # location. If `Environment ID` is not specified, we assume default 'draft' + # environment. If `User ID` is not specified, we assume default '-' user. `` + # must be the display name of an existing entity type in the same agent that + # will be overridden or supplemented. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType] google_cloud_dialogflow_v2beta1_session_entity_type_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -2843,7 +2912,7 @@ module Google # Deletes the specified agent. # @param [String] parent # Required. The project that the agent to delete is associated with. Format: ` - # projects/`. + # projects/` or `projects//locations/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2874,7 +2943,7 @@ module Google # Retrieves the specified agent. # @param [String] parent # Required. The project that the agent to fetch is associated with. Format: ` - # projects/`. + # projects/` or `projects//locations/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2904,7 +2973,8 @@ module Google # Creates/updates the specified agent. # @param [String] parent - # Required. The project of this agent. Format: `projects/`. + # Required. The project of this agent. Format: `projects/` or `projects// + # locations/` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Agent] google_cloud_dialogflow_v2beta1_agent_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -2941,7 +3011,7 @@ module Google # Exports the specified agent to a ZIP file. Operation # @param [String] parent # Required. The project that the agent to export is associated with. Format: ` - # projects/`. + # projects/` or `projects//locations/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ExportAgentRequest] google_cloud_dialogflow_v2beta1_export_agent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2974,7 +3044,8 @@ module Google # Retrieves the fulfillment. # @param [String] name - # Required. The name of the fulfillment. Format: `projects//agent/fulfillment`. + # Required. The name of the fulfillment. Supported formats: - `projects//agent/ + # fulfillment` - `projects//locations//agent/fulfillment` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3005,7 +3076,8 @@ module Google # Gets agent validation result. Agent validation is performed during training # time and is updated automatically when training is completed. # @param [String] parent - # Required. The project that the agent is associated with. Format: `projects/`. + # Required. The project that the agent is associated with. Format: `projects/` + # or `projects//locations/`. # @param [String] language_code # Optional. The language for which you want a validation result. If not # specified, the agent's default language is used. [Many languages](https:// @@ -3050,7 +3122,7 @@ module Google # it is done training. # @param [String] parent # Required. The project that the agent to import is associated with. Format: ` - # projects/`. + # projects/` or `projects//locations/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ImportAgentRequest] google_cloud_dialogflow_v2beta1_import_agent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3091,7 +3163,7 @@ module Google # draft agent is updated not when it is done training. # @param [String] parent # Required. The project that the agent to restore is associated with. Format: ` - # projects/`. + # projects/` or `projects//locations/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1RestoreAgentRequest] google_cloud_dialogflow_v2beta1_restore_agent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3128,7 +3200,8 @@ module Google # project collection id "-". Refer to [List Sub-Collections](https://cloud. # google.com/apis/design/design_patterns#list_sub-collections). # @param [String] parent - # Required. The project to list agents from. Format: `projects/`. + # Required. The project to list agents from. Format: `projects/` or `projects// + # locations/`. # @param [Fixnum] page_size # Optional. The maximum number of items to return in a single page. By default # 100 and at most 1000. @@ -3166,7 +3239,7 @@ module Google # Trains the specified agent. Operation # @param [String] parent # Required. The project that the agent to train is associated with. Format: ` - # projects/`. + # projects/` or `projects//locations/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1TrainAgentRequest] google_cloud_dialogflow_v2beta1_train_agent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3199,8 +3272,8 @@ module Google # Updates the fulfillment. # @param [String] name - # Required. The unique identifier of the fulfillment. Format: `projects//agent/ - # fulfillment`. + # Required. The unique identifier of the fulfillment. Supported formats: - ` + # projects//agent/fulfillment` - `projects//locations//agent/fulfillment` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Fulfillment] google_cloud_dialogflow_v2beta1_fulfillment_object # @param [String] update_mask # Required. The mask to control which fields get updated. If the mask is not @@ -3237,8 +3310,8 @@ module Google # Deletes entity types in the specified agent. Operation # @param [String] parent - # Required. The name of the agent to delete all entities types for. Format: ` - # projects//agent`. + # Required. The name of the agent to delete all entities types for. Supported + # formats: - `projects//agent`, - `projects//locations//agent`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest] google_cloud_dialogflow_v2beta1_batch_delete_entity_types_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3271,8 +3344,8 @@ module Google # Updates/Creates multiple entity types in the specified agent. Operation # @param [String] parent - # Required. The name of the agent to update or create entity types in. Format: ` - # projects//agent`. + # Required. The name of the agent to update or create entity types in. Supported + # formats: - `projects//agent` - `projects//locations//agent` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest] google_cloud_dialogflow_v2beta1_batch_update_entity_types_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3305,7 +3378,8 @@ module Google # Creates an entity type in the specified agent. # @param [String] parent - # Required. The agent to create a entity type for. Format: `projects//agent`. + # Required. The agent to create a entity type for. Supported formats: - ` + # projects//agent` - `projects//locations//agent` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType] google_cloud_dialogflow_v2beta1_entity_type_object # @param [String] language_code # Optional. The language used to access language-specific data. If not specified, @@ -3344,8 +3418,8 @@ module Google # Deletes the specified entity type. # @param [String] name - # Required. The name of the entity type to delete. Format: `projects//agent/ - # entityTypes/`. + # Required. The name of the entity type to delete. Supported formats: - ` + # projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3375,7 +3449,8 @@ module Google # Retrieves the specified entity type. # @param [String] name - # Required. The name of the entity type. Format: `projects//agent/entityTypes/`. + # Required. The name of the entity type. Supported formats: - `projects//agent/ + # entityTypes/` - `projects//locations//agent/entityTypes/` # @param [String] language_code # Optional. The language used to access language-specific data. If not specified, # the agent's default language is used. For more information, see [Multilingual @@ -3411,7 +3486,8 @@ module Google # Returns the list of all entity types in the specified agent. # @param [String] parent - # Required. The agent to list all entity types from. Format: `projects//agent`. + # Required. The agent to list all entity types from. Supported formats: - ` + # projects//agent` - `projects//locations//agent` # @param [String] language_code # Optional. The language used to access language-specific data. If not specified, # the agent's default language is used. For more information, see [Multilingual @@ -3455,8 +3531,9 @@ module Google # Updates the specified entity type. # @param [String] name # The unique identifier of the entity type. Required for EntityTypes. - # UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: ` - # projects//agent/entityTypes/`. + # UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Supported + # formats: - `projects//agent/entityTypes/` - `projects//locations//agent/ + # entityTypes/` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType] google_cloud_dialogflow_v2beta1_entity_type_object # @param [String] language_code # Optional. The language used to access language-specific data. If not specified, @@ -3498,8 +3575,8 @@ module Google # Creates multiple new entities in the specified entity type. Operation # @param [String] parent - # Required. The name of the entity type to create entities in. Format: `projects/ - # /agent/entityTypes/`. + # Required. The name of the entity type to create entities in. Supported formats: + # - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest] google_cloud_dialogflow_v2beta1_batch_create_entities_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3532,8 +3609,8 @@ module Google # Deletes entities in the specified entity type. Operation # @param [String] parent - # Required. The name of the entity type to delete entries for. Format: `projects/ - # /agent/entityTypes/`. + # Required. The name of the entity type to delete entries for. Supported formats: + # - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest] google_cloud_dialogflow_v2beta1_batch_delete_entities_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3568,8 +3645,9 @@ module Google # does not affect entities in the entity type that aren't explicitly specified # in the request. Operation # @param [String] parent - # Required. The name of the entity type to update or create entities in. Format: - # `projects//agent/entityTypes/`. + # Required. The name of the entity type to update or create entities in. + # Supported formats: - `projects//agent/entityTypes/` - `projects//locations// + # agent/entityTypes/` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest] google_cloud_dialogflow_v2beta1_batch_update_entities_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3603,7 +3681,7 @@ module Google # Returns the list of all non-draft environments of the specified agent. # @param [String] parent # Required. The agent to list all environments from. Format: - `projects//agent` - # - `projects//locations//agent + # - `projects//locations//agent` # @param [Fixnum] page_size # Optional. The maximum number of items to return in a single page. By default # 100 and at most 1000. @@ -3640,10 +3718,13 @@ module Google # Deletes all active contexts in the specified session. # @param [String] parent - # Required. The name of the session to delete all contexts from. Format: ` - # projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. - # If `Environment ID` is not specified we assume default 'draft' environment. - # If `User ID` is not specified, we assume default '-' user. + # Required. The name of the session to delete all contexts from. Supported + # formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/` + # , - `projects//agent/environments//users//sessions/`, - `projects//locations// + # agent/environments//users//sessions/`, If `Location ID` is not specified we + # assume default 'us' location. If `Environment ID` is not specified we assume + # default 'draft' environment. If `User ID` is not specified, we assume default ' + # -' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3676,15 +3757,17 @@ module Google # session entity types to be updated, which in turn might affect results of # future queries. # @param [String] session - # Required. The name of the session this query is sent to. Format: `projects// - # agent/sessions/`, or `projects//agent/environments//users//sessions/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we are using "-". It's up to the API caller to - # choose an appropriate `Session ID` and `User Id`. They can be a random number - # or some type of user and session identifiers (preferably hashed). The length - # of the `Session ID` and `User ID` must not exceed 36 characters. For more - # information, see the [API interactions guide](https://cloud.google.com/ - # dialogflow/docs/api-overview). + # Required. The name of the session this query is sent to. Supported formats: - ` + # projects//agent/sessions/, - `projects//locations//agent/sessions/`, - ` + # projects//agent/environments//users//sessions/`, - `projects//locations//agent/ + # environments//users//sessions/`, If `Location ID` is not specified we assume + # default 'us' location. If `Environment ID` is not specified, we assume default + # 'draft' environment. If `User ID` is not specified, we are using "-". It's up + # to the API caller to choose an appropriate `Session ID` and `User Id`. They + # can be a random number or some type of user and session identifiers ( + # preferably hashed). The length of the `Session ID` and `User ID` must not + # exceed 36 characters. For more information, see the [API interactions guide]( + # https://cloud.google.com/dialogflow/docs/api-overview). # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentRequest] google_cloud_dialogflow_v2beta1_detect_intent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3718,10 +3801,12 @@ module Google # Creates a context. If the specified context already exists, overrides the # context. # @param [String] parent - # Required. The session to create a context for. Format: `projects//agent/ - # sessions/` or `projects//agent/environments//users//sessions/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The session to create a context for. Supported formats: - `projects// + # agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/ + # environments//users//sessions/`, - `projects//locations//agent/environments// + # users//sessions/`, If `Location ID` is not specified we assume default 'us' + # location. If `Environment ID` is not specified, we assume default 'draft' + # environment. If `User ID` is not specified, we assume default '-' user. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context] google_cloud_dialogflow_v2beta1_context_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3754,10 +3839,13 @@ module Google # Deletes the specified context. # @param [String] name - # Required. The name of the context to delete. Format: `projects//agent/sessions/ - # /contexts/` or `projects//agent/environments//users//sessions//contexts/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The name of the context to delete. Supported formats: - `projects// + # agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, + # - `projects//agent/environments//users//sessions//contexts/`, - `projects// + # locations//agent/environments//users//sessions//contexts/`, If `Location ID` + # is not specified we assume default 'us' location. If `Environment ID` is not + # specified, we assume default 'draft' environment. If `User ID` is not + # specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3787,10 +3875,13 @@ module Google # Retrieves the specified context. # @param [String] name - # Required. The name of the context. Format: `projects//agent/sessions//contexts/ - # ` or `projects//agent/environments//users//sessions//contexts/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The name of the context. Supported formats: - `projects//agent/ + # sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - ` + # projects//agent/environments//users//sessions//contexts/`, - `projects// + # locations//agent/environments//users//sessions//contexts/`, If `Location ID` + # is not specified we assume default 'us' location. If `Environment ID` is not + # specified, we assume default 'draft' environment. If `User ID` is not + # specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3820,10 +3911,12 @@ module Google # Returns the list of all contexts in the specified session. # @param [String] parent - # Required. The session to list all contexts from. Format: `projects//agent/ - # sessions/` or `projects//agent/environments//users//sessions/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The session to list all contexts from. Supported formats: - ` + # projects//agent/sessions/, - `projects//locations//agent/sessions/`, - ` + # projects//agent/environments//users//sessions/`, - `projects//locations//agent/ + # environments//users//sessions/`, If `Location ID` is not specified we assume + # default 'us' location. If `Environment ID` is not specified, we assume default + # 'draft' environment. If `User ID` is not specified, we assume default '-' user. # @param [Fixnum] page_size # Optional. The maximum number of items to return in a single page. By default # 100 and at most 1000. @@ -3860,15 +3953,16 @@ module Google # Updates the specified context. # @param [String] name - # Required. The unique identifier of the context. Format: `projects//agent/ - # sessions//contexts/`, or `projects//agent/environments//users//sessions// - # contexts/`. The `Context ID` is always converted to lowercase, may only - # contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. The following context - # names are reserved for internal use by Dialogflow. You should not use these - # contexts or create contexts with these names: * `__system_counters__` * `* - # _id_dialog_context` * `*_dialog_params_size` + # Required. The unique identifier of the context. Supported formats: - `projects/ + # /agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/` + # , - `projects//agent/environments//users//sessions//contexts/`, - `projects// + # locations//agent/environments//users//sessions//contexts/`, The `Context ID` + # is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% + # and may be at most 250 bytes long. If `Environment ID` is not specified, we + # assume default 'draft' environment. If `User ID` is not specified, we assume + # default '-' user. The following context names are reserved for internal use by + # Dialogflow. You should not use these contexts or create contexts with these + # names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context] google_cloud_dialogflow_v2beta1_context_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -3907,10 +4001,12 @@ module Google # Google Assistant integration. Contact Dialogflow support if you need to use # session entities with Google Assistant integration. # @param [String] parent - # Required. The session to create a session entity type for. Format: `projects// - # agent/sessions/` or `projects//agent/environments//users// sessions/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The session to create a session entity type for. Supported formats: - + # `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - ` + # projects//agent/environments//users//sessions/`, - `projects//locations//agent/ + # environments//users//sessions/`, If `Location ID` is not specified we assume + # default 'us' location. If `Environment ID` is not specified, we assume default + # 'draft' environment. If `User ID` is not specified, we assume default '-' user. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType] google_cloud_dialogflow_v2beta1_session_entity_type_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3945,10 +4041,13 @@ module Google # Google Assistant integration. Contact Dialogflow support if you need to use # session entities with Google Assistant integration. # @param [String] name - # Required. The name of the entity type to delete. Format: `projects//agent/ - # sessions//entityTypes/` or `projects//agent/environments//users//sessions// - # entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The name of the entity type to delete. Supported formats: - ` + # projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions/ + # /entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` + # - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If + # `Location ID` is not specified we assume default 'us' location. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3980,10 +4079,13 @@ module Google # Google Assistant integration. Contact Dialogflow support if you need to use # session entities with Google Assistant integration. # @param [String] name - # Required. The name of the session entity type. Format: `projects//agent/ - # sessions//entityTypes/` or `projects//agent/environments//users//sessions// - # entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The name of the session entity type. Supported formats: - `projects// + # agent/sessions//entityTypes/` - `projects//locations//agent/sessions// + # entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - + # `projects//locations//agent/environments/ /users//sessions//entityTypes/` If ` + # Location ID` is not specified we assume default 'us' location. If `Environment + # ID` is not specified, we assume default 'draft' environment. If `User ID` is + # not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4015,10 +4117,12 @@ module Google # method doesn't work with Google Assistant integration. Contact Dialogflow # support if you need to use session entities with Google Assistant integration. # @param [String] parent - # Required. The session to list all session entity types from. Format: `projects/ - # /agent/sessions/` or `projects//agent/environments//users// sessions/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The session to list all session entity types from. Supported formats: + # - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - ` + # projects//agent/environments//users//sessions/`, - `projects//locations//agent/ + # environments//users//sessions/`, If `Location ID` is not specified we assume + # default 'us' location. If `Environment ID` is not specified, we assume default + # 'draft' environment. If `User ID` is not specified, we assume default '-' user. # @param [Fixnum] page_size # Optional. The maximum number of items to return in a single page. By default # 100 and at most 1000. @@ -4057,12 +4161,15 @@ module Google # Google Assistant integration. Contact Dialogflow support if you need to use # session entities with Google Assistant integration. # @param [String] name - # Required. The unique identifier of this session entity type. Format: `projects/ - # /agent/sessions//entityTypes/`, or `projects//agent/environments//users// - # sessions//entityTypes/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we assume default ' - # -' user. `` must be the display name of an existing entity type in the same - # agent that will be overridden or supplemented. + # Required. The unique identifier of this session entity type. Supported formats: + # - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/ + # sessions//entityTypes/` - `projects//agent/environments//users//sessions// + # entityTypes/` - `projects//locations//agent/environments/ /users//sessions// + # entityTypes/` If `Location ID` is not specified we assume default 'us' + # location. If `Environment ID` is not specified, we assume default 'draft' + # environment. If `User ID` is not specified, we assume default '-' user. `` + # must be the display name of an existing entity type in the same agent that + # will be overridden or supplemented. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType] google_cloud_dialogflow_v2beta1_session_entity_type_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -4098,8 +4205,8 @@ module Google # Deletes intents in the specified agent. Operation # @param [String] parent - # Required. The name of the agent to delete all entities types for. Format: ` - # projects//agent`. + # Required. The name of the agent to delete all entities types for. Supported + # formats: - `projects//agent` - `projects//locations//agent` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest] google_cloud_dialogflow_v2beta1_batch_delete_intents_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4132,8 +4239,8 @@ module Google # Updates/Creates multiple intents in the specified agent. Operation # @param [String] parent - # Required. The name of the agent to update or create intents in. Format: ` - # projects//agent`. + # Required. The name of the agent to update or create intents in. Supported + # formats: - `projects//agent` - `projects//locations//agent` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest] google_cloud_dialogflow_v2beta1_batch_update_intents_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4166,7 +4273,8 @@ module Google # Creates an intent in the specified agent. # @param [String] parent - # Required. The agent to create a intent for. Format: `projects//agent`. + # Required. The agent to create a intent for. Supported formats: - `projects// + # agent` - `projects//locations//agent` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent] google_cloud_dialogflow_v2beta1_intent_object # @param [String] intent_view # Optional. The resource view to apply to the returned intent. @@ -4209,8 +4317,8 @@ module Google # Deletes the specified intent and its direct or indirect followup intents. # @param [String] name # Required. The name of the intent to delete. If this intent has direct or - # indirect followup intents, we also delete them. Format: `projects//agent/ - # intents/`. + # indirect followup intents, we also delete them. Supported formats: - `projects/ + # /agent/intents/` - `projects//locations//agent/intents/` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4240,7 +4348,8 @@ module Google # Retrieves the specified intent. # @param [String] name - # Required. The name of the intent. Format: `projects//agent/intents/`. + # Required. The name of the intent. Supported formats: - `projects//agent/ + # intents/` - `projects//locations//agent/intents/` # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code @@ -4326,8 +4435,8 @@ module Google # Updates the specified intent. # @param [String] name # Optional. The unique identifier of this intent. Required for Intents. - # UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/ - # intents/`. + # UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - ` + # projects//agent/intents/` - `projects//locations//agent/intents/` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent] google_cloud_dialogflow_v2beta1_intent_object # @param [String] intent_view # Optional. The resource view to apply to the returned intent. @@ -4372,10 +4481,13 @@ module Google # Deletes all active contexts in the specified session. # @param [String] parent - # Required. The name of the session to delete all contexts from. Format: ` - # projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. - # If `Environment ID` is not specified we assume default 'draft' environment. - # If `User ID` is not specified, we assume default '-' user. + # Required. The name of the session to delete all contexts from. Supported + # formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/` + # , - `projects//agent/environments//users//sessions/`, - `projects//locations// + # agent/environments//users//sessions/`, If `Location ID` is not specified we + # assume default 'us' location. If `Environment ID` is not specified we assume + # default 'draft' environment. If `User ID` is not specified, we assume default ' + # -' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4408,15 +4520,17 @@ module Google # session entity types to be updated, which in turn might affect results of # future queries. # @param [String] session - # Required. The name of the session this query is sent to. Format: `projects// - # agent/sessions/`, or `projects//agent/environments//users//sessions/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we are using "-". It's up to the API caller to - # choose an appropriate `Session ID` and `User Id`. They can be a random number - # or some type of user and session identifiers (preferably hashed). The length - # of the `Session ID` and `User ID` must not exceed 36 characters. For more - # information, see the [API interactions guide](https://cloud.google.com/ - # dialogflow/docs/api-overview). + # Required. The name of the session this query is sent to. Supported formats: - ` + # projects//agent/sessions/, - `projects//locations//agent/sessions/`, - ` + # projects//agent/environments//users//sessions/`, - `projects//locations//agent/ + # environments//users//sessions/`, If `Location ID` is not specified we assume + # default 'us' location. If `Environment ID` is not specified, we assume default + # 'draft' environment. If `User ID` is not specified, we are using "-". It's up + # to the API caller to choose an appropriate `Session ID` and `User Id`. They + # can be a random number or some type of user and session identifiers ( + # preferably hashed). The length of the `Session ID` and `User ID` must not + # exceed 36 characters. For more information, see the [API interactions guide]( + # https://cloud.google.com/dialogflow/docs/api-overview). # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentRequest] google_cloud_dialogflow_v2beta1_detect_intent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4450,10 +4564,12 @@ module Google # Creates a context. If the specified context already exists, overrides the # context. # @param [String] parent - # Required. The session to create a context for. Format: `projects//agent/ - # sessions/` or `projects//agent/environments//users//sessions/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The session to create a context for. Supported formats: - `projects// + # agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/ + # environments//users//sessions/`, - `projects//locations//agent/environments// + # users//sessions/`, If `Location ID` is not specified we assume default 'us' + # location. If `Environment ID` is not specified, we assume default 'draft' + # environment. If `User ID` is not specified, we assume default '-' user. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context] google_cloud_dialogflow_v2beta1_context_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4486,10 +4602,13 @@ module Google # Deletes the specified context. # @param [String] name - # Required. The name of the context to delete. Format: `projects//agent/sessions/ - # /contexts/` or `projects//agent/environments//users//sessions//contexts/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The name of the context to delete. Supported formats: - `projects// + # agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, + # - `projects//agent/environments//users//sessions//contexts/`, - `projects// + # locations//agent/environments//users//sessions//contexts/`, If `Location ID` + # is not specified we assume default 'us' location. If `Environment ID` is not + # specified, we assume default 'draft' environment. If `User ID` is not + # specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4519,10 +4638,13 @@ module Google # Retrieves the specified context. # @param [String] name - # Required. The name of the context. Format: `projects//agent/sessions//contexts/ - # ` or `projects//agent/environments//users//sessions//contexts/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The name of the context. Supported formats: - `projects//agent/ + # sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - ` + # projects//agent/environments//users//sessions//contexts/`, - `projects// + # locations//agent/environments//users//sessions//contexts/`, If `Location ID` + # is not specified we assume default 'us' location. If `Environment ID` is not + # specified, we assume default 'draft' environment. If `User ID` is not + # specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4552,10 +4674,12 @@ module Google # Returns the list of all contexts in the specified session. # @param [String] parent - # Required. The session to list all contexts from. Format: `projects//agent/ - # sessions/` or `projects//agent/environments//users//sessions/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The session to list all contexts from. Supported formats: - ` + # projects//agent/sessions/, - `projects//locations//agent/sessions/`, - ` + # projects//agent/environments//users//sessions/`, - `projects//locations//agent/ + # environments//users//sessions/`, If `Location ID` is not specified we assume + # default 'us' location. If `Environment ID` is not specified, we assume default + # 'draft' environment. If `User ID` is not specified, we assume default '-' user. # @param [Fixnum] page_size # Optional. The maximum number of items to return in a single page. By default # 100 and at most 1000. @@ -4592,15 +4716,16 @@ module Google # Updates the specified context. # @param [String] name - # Required. The unique identifier of the context. Format: `projects//agent/ - # sessions//contexts/`, or `projects//agent/environments//users//sessions// - # contexts/`. The `Context ID` is always converted to lowercase, may only - # contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. The following context - # names are reserved for internal use by Dialogflow. You should not use these - # contexts or create contexts with these names: * `__system_counters__` * `* - # _id_dialog_context` * `*_dialog_params_size` + # Required. The unique identifier of the context. Supported formats: - `projects/ + # /agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/` + # , - `projects//agent/environments//users//sessions//contexts/`, - `projects// + # locations//agent/environments//users//sessions//contexts/`, The `Context ID` + # is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% + # and may be at most 250 bytes long. If `Environment ID` is not specified, we + # assume default 'draft' environment. If `User ID` is not specified, we assume + # default '-' user. The following context names are reserved for internal use by + # Dialogflow. You should not use these contexts or create contexts with these + # names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context] google_cloud_dialogflow_v2beta1_context_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -4639,10 +4764,12 @@ module Google # Google Assistant integration. Contact Dialogflow support if you need to use # session entities with Google Assistant integration. # @param [String] parent - # Required. The session to create a session entity type for. Format: `projects// - # agent/sessions/` or `projects//agent/environments//users// sessions/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The session to create a session entity type for. Supported formats: - + # `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - ` + # projects//agent/environments//users//sessions/`, - `projects//locations//agent/ + # environments//users//sessions/`, If `Location ID` is not specified we assume + # default 'us' location. If `Environment ID` is not specified, we assume default + # 'draft' environment. If `User ID` is not specified, we assume default '-' user. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType] google_cloud_dialogflow_v2beta1_session_entity_type_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4677,10 +4804,13 @@ module Google # Google Assistant integration. Contact Dialogflow support if you need to use # session entities with Google Assistant integration. # @param [String] name - # Required. The name of the entity type to delete. Format: `projects//agent/ - # sessions//entityTypes/` or `projects//agent/environments//users//sessions// - # entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The name of the entity type to delete. Supported formats: - ` + # projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions/ + # /entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` + # - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If + # `Location ID` is not specified we assume default 'us' location. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4712,10 +4842,13 @@ module Google # Google Assistant integration. Contact Dialogflow support if you need to use # session entities with Google Assistant integration. # @param [String] name - # Required. The name of the session entity type. Format: `projects//agent/ - # sessions//entityTypes/` or `projects//agent/environments//users//sessions// - # entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The name of the session entity type. Supported formats: - `projects// + # agent/sessions//entityTypes/` - `projects//locations//agent/sessions// + # entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - + # `projects//locations//agent/environments/ /users//sessions//entityTypes/` If ` + # Location ID` is not specified we assume default 'us' location. If `Environment + # ID` is not specified, we assume default 'draft' environment. If `User ID` is + # not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4747,10 +4880,12 @@ module Google # method doesn't work with Google Assistant integration. Contact Dialogflow # support if you need to use session entities with Google Assistant integration. # @param [String] parent - # Required. The session to list all session entity types from. Format: `projects/ - # /agent/sessions/` or `projects//agent/environments//users// sessions/`. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. + # Required. The session to list all session entity types from. Supported formats: + # - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - ` + # projects//agent/environments//users//sessions/`, - `projects//locations//agent/ + # environments//users//sessions/`, If `Location ID` is not specified we assume + # default 'us' location. If `Environment ID` is not specified, we assume default + # 'draft' environment. If `User ID` is not specified, we assume default '-' user. # @param [Fixnum] page_size # Optional. The maximum number of items to return in a single page. By default # 100 and at most 1000. @@ -4789,12 +4924,15 @@ module Google # Google Assistant integration. Contact Dialogflow support if you need to use # session entities with Google Assistant integration. # @param [String] name - # Required. The unique identifier of this session entity type. Format: `projects/ - # /agent/sessions//entityTypes/`, or `projects//agent/environments//users// - # sessions//entityTypes/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we assume default ' - # -' user. `` must be the display name of an existing entity type in the same - # agent that will be overridden or supplemented. + # Required. The unique identifier of this session entity type. Supported formats: + # - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/ + # sessions//entityTypes/` - `projects//agent/environments//users//sessions// + # entityTypes/` - `projects//locations//agent/environments/ /users//sessions// + # entityTypes/` If `Location ID` is not specified we assume default 'us' + # location. If `Environment ID` is not specified, we assume default 'draft' + # environment. If `User ID` is not specified, we assume default '-' user. `` + # must be the display name of an existing entity type in the same agent that + # will be overridden or supplemented. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType] google_cloud_dialogflow_v2beta1_session_entity_type_object # @param [String] update_mask # Optional. The mask to control which fields get updated. diff --git a/generated/google/apis/dialogflow_v3beta1.rb b/generated/google/apis/dialogflow_v3beta1.rb index 4df893cd9..882ce4e54 100644 --- a/generated/google/apis/dialogflow_v3beta1.rb +++ b/generated/google/apis/dialogflow_v3beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/dialogflow/ module DialogflowV3beta1 VERSION = 'V3beta1' - REVISION = '20200823' + REVISION = '20200903' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dialogflow_v3beta1/classes.rb b/generated/google/apis/dialogflow_v3beta1/classes.rb index 3c89feeb8..7a1e8b1a2 100644 --- a/generated/google/apis/dialogflow_v3beta1/classes.rb +++ b/generated/google/apis/dialogflow_v3beta1/classes.rb @@ -1755,12 +1755,6 @@ module Google # @return [Float] attr_accessor :classification_threshold - # Indicates if automatic spell correction is enabled in detect intent requests. - # Corresponds to the JSON property `enableSpellCorrection` - # @return [Boolean] - attr_accessor :enable_spell_correction - alias_method :enable_spell_correction?, :enable_spell_correction - # Indicates NLU model training mode. # Corresponds to the JSON property `modelTrainingMode` # @return [String] @@ -1778,7 +1772,6 @@ module Google # Update properties of this object def update!(**args) @classification_threshold = args[:classification_threshold] if args.key?(:classification_threshold) - @enable_spell_correction = args[:enable_spell_correction] if args.key?(:enable_spell_correction) @model_training_mode = args[:model_training_mode] if args.key?(:model_training_mode) @model_type = args[:model_type] if args.key?(:model_type) end @@ -2468,6 +2461,13 @@ module Google class GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText include Google::Apis::Core::Hashable + # Output only. Whether the playback of this message can be interrupted by the + # end user's speech and the client can then starts the next Dialogflow request. + # Corresponds to the JSON property `allowPlaybackInterruption` + # @return [Boolean] + attr_accessor :allow_playback_interruption + alias_method :allow_playback_interruption?, :allow_playback_interruption + # The SSML text to be synthesized. For more information, see [SSML](/speech/text- # to-speech/docs/ssml). # Corresponds to the JSON property `ssml` @@ -2485,6 +2485,7 @@ module Google # Update properties of this object def update!(**args) + @allow_playback_interruption = args[:allow_playback_interruption] if args.key?(:allow_playback_interruption) @ssml = args[:ssml] if args.key?(:ssml) @text = args[:text] if args.key?(:text) end @@ -4911,8 +4912,8 @@ module Google # may provide additional information in the payload. In particular, for the # Dialogflow Phone Gateway integration, this field has the form: ` "telephony": ` # "caller_id": "+18558363987" ` ` Note: The caller ID field (`caller_id`) will - # be redacted for Standard Edition agents and populated with the caller ID in [E. - # 164 format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents. + # be redacted for Trial Edition agents and populated with the caller ID in [E. + # 164 format](https://en.wikipedia.org/wiki/E.164) for Essentials Edition agents. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload @@ -5475,15 +5476,16 @@ module Google # @return [Fixnum] attr_accessor :lifespan_count - # Required. The unique identifier of the context. Format: `projects//agent/ - # sessions//contexts/`, or `projects//agent/environments//users//sessions// - # contexts/`. The `Context ID` is always converted to lowercase, may only - # contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If ` - # Environment ID` is not specified, we assume default 'draft' environment. If ` - # User ID` is not specified, we assume default '-' user. The following context - # names are reserved for internal use by Dialogflow. You should not use these - # contexts or create contexts with these names: * `__system_counters__` * `* - # _id_dialog_context` * `*_dialog_params_size` + # Required. The unique identifier of the context. Supported formats: - `projects/ + # /agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/` + # , - `projects//agent/environments//users//sessions//contexts/`, - `projects// + # locations//agent/environments//users//sessions//contexts/`, The `Context ID` + # is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% + # and may be at most 250 bytes long. If `Environment ID` is not specified, we + # assume default 'draft' environment. If `User ID` is not specified, we assume + # default '-' user. The following context names are reserved for internal use by + # Dialogflow. You should not use these contexts or create contexts with these + # names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -5551,8 +5553,9 @@ module Google attr_accessor :kind # The unique identifier of the entity type. Required for EntityTypes. - # UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: ` - # projects//agent/entityTypes/`. + # UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Supported + # formats: - `projects//agent/entityTypes/` - `projects//locations//agent/ + # entityTypes/` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -5725,7 +5728,8 @@ module Google attr_accessor :followup_intent_info # Optional. The list of context names required for this intent to be triggered. - # Format: `projects//agent/sessions/-/contexts/`. + # Formats: - `projects//agent/sessions/-/contexts/` - `projects//locations// + # agent/sessions/-/contexts/` # Corresponds to the JSON property `inputContextNames` # @return [Array] attr_accessor :input_context_names @@ -5765,8 +5769,8 @@ module Google alias_method :ml_enabled?, :ml_enabled # Optional. The unique identifier of this intent. Required for Intents. - # UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/ - # intents/`. + # UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - ` + # projects//agent/intents/` - `projects//locations//agent/intents/` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -7514,8 +7518,8 @@ module Google # may provide additional information in the payload. In particular, for the # Dialogflow Phone Gateway integration, this field has the form: ` "telephony": ` # "caller_id": "+18558363987" ` ` Note: The caller ID field (`caller_id`) will - # be redacted for Standard Edition agents and populated with the caller ID in [E. - # 164 format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents. + # be redacted for Trial Edition agents and populated with the caller ID in [E. + # 164 format](https://en.wikipedia.org/wiki/E.164) for Essentials Edition agents. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload @@ -7779,12 +7783,15 @@ module Google # @return [String] attr_accessor :entity_override_mode - # Required. The unique identifier of this session entity type. Format: `projects/ - # /agent/sessions//entityTypes/`, or `projects//agent/environments//users// - # sessions//entityTypes/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we assume default ' - # -' user. `` must be the display name of an existing entity type in the same - # agent that will be overridden or supplemented. + # Required. The unique identifier of this session entity type. Supported formats: + # - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/ + # sessions//entityTypes/` - `projects//agent/environments//users//sessions// + # entityTypes/` - `projects//locations//agent/environments/ /users//sessions// + # entityTypes/` If `Location ID` is not specified we assume default 'us' + # location. If `Environment ID` is not specified, we assume default 'draft' + # environment. If `User ID` is not specified, we assume default '-' user. `` + # must be the display name of an existing entity type in the same agent that + # will be overridden or supplemented. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -7828,8 +7835,10 @@ module Google attr_accessor :response_id # The unique identifier of detectIntent request session. Can be used to identify - # end-user inside webhook implementation. Format: `projects//agent/sessions/`, - # or `projects//agent/environments//users//sessions/`. + # end-user inside webhook implementation. Supported formats: - `projects//agent/ + # sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/ + # environments//users//sessions/`, - `projects//locations//agent/environments// + # users//sessions/`, # Corresponds to the JSON property `session` # @return [String] attr_accessor :session diff --git a/generated/google/apis/dialogflow_v3beta1/representations.rb b/generated/google/apis/dialogflow_v3beta1/representations.rb index d4d18b7c0..2e61927d9 100644 --- a/generated/google/apis/dialogflow_v3beta1/representations.rb +++ b/generated/google/apis/dialogflow_v3beta1/representations.rb @@ -1741,7 +1741,6 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :classification_threshold, as: 'classificationThreshold' - property :enable_spell_correction, as: 'enableSpellCorrection' property :model_training_mode, as: 'modelTrainingMode' property :model_type, as: 'modelType' end @@ -1914,6 +1913,7 @@ module Google class GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText # @private class Representation < Google::Apis::Core::JsonRepresentation + property :allow_playback_interruption, as: 'allowPlaybackInterruption' property :ssml, as: 'ssml' property :text, as: 'text' end diff --git a/generated/google/apis/digitalassetlinks_v1.rb b/generated/google/apis/digitalassetlinks_v1.rb index 801413c6a..82af5c8d9 100644 --- a/generated/google/apis/digitalassetlinks_v1.rb +++ b/generated/google/apis/digitalassetlinks_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/digital-asset-links/ module DigitalassetlinksV1 VERSION = 'V1' - REVISION = '20200222' + REVISION = '20200829' end end end diff --git a/generated/google/apis/digitalassetlinks_v1/classes.rb b/generated/google/apis/digitalassetlinks_v1/classes.rb index 3b1dda18f..db4c8e962 100644 --- a/generated/google/apis/digitalassetlinks_v1/classes.rb +++ b/generated/google/apis/digitalassetlinks_v1/classes.rb @@ -31,10 +31,9 @@ module Google # @return [Google::Apis::DigitalassetlinksV1::CertificateInfo] attr_accessor :certificate - # Android App assets are naturally identified by their Java package name. - # For example, the Google Maps app uses the package name - # `com.google.android.apps.maps`. - # REQUIRED + # Android App assets are naturally identified by their Java package name. For + # example, the Google Maps app uses the package name `com.google.android.apps. + # maps`. REQUIRED # Corresponds to the JSON property `packageName` # @return [String] attr_accessor :package_name @@ -50,10 +49,9 @@ module Google end end - # Uniquely identifies an asset. - # A digital asset is an identifiable and addressable online entity that - # typically provides some service or content. Examples of assets are websites, - # Android apps, Twitter feeds, and Plus Pages. + # Uniquely identifies an asset. A digital asset is an identifiable and + # addressable online entity that typically provides some service or content. + # Examples of assets are websites, Android apps, Twitter feeds, and Plus Pages. class Asset include Google::Apis::Core::Hashable @@ -82,22 +80,18 @@ module Google class CertificateInfo include Google::Apis::Core::Hashable - # The uppercase SHA-265 fingerprint of the certificate. From the PEM - # certificate, it can be acquired like this: - # $ keytool -printcert -file $CERTFILE | grep SHA256: - # SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ - # 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 - # or like this: - # $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 - # SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ - # 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 - # In this example, the contents of this field would be `14:6D:E9:83:C5:73: - # 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: - # 44:E5`. - # If these tools are not available to you, you can convert the PEM - # certificate into the DER format, compute the SHA-256 hash of that string - # and represent the result as a hexstring (that is, uppercase hexadecimal - # representations of each octet, separated by colons). + # The uppercase SHA-265 fingerprint of the certificate. From the PEM certificate, + # it can be acquired like this: $ keytool -printcert -file $CERTFILE | grep + # SHA256: SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ 42: + # E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in $CERTFILE + # -noout -fingerprint -sha256 SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE: + # B9:95:2F:34:FC:64: \ 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this + # example, the contents of this field would be `14:6D:E9:83:C5:73: 06:50:D8:EE: + # B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5`. If these + # tools are not available to you, you can convert the PEM certificate into the + # DER format, compute the SHA-256 hash of that string and represent the result + # as a hexstring (that is, uppercase hexadecimal representations of each octet, + # separated by colons). # Corresponds to the JSON property `sha256Fingerprint` # @return [String] attr_accessor :sha256_fingerprint @@ -117,13 +111,12 @@ module Google include Google::Apis::Core::Hashable # Human-readable message containing information intended to help end users - # understand, reproduce and debug the result. - # The message will be in English and we are currently not planning to offer - # any translations. - # Please note that no guarantees are made about the contents or format of - # this string. Any aspect of it may be subject to change without notice. - # You should not attempt to programmatically parse this data. For - # programmatic access, use the error_code field below. + # understand, reproduce and debug the result. The message will be in English and + # we are currently not planning to offer any translations. Please note that no + # guarantees are made about the contents or format of this string. Any aspect of + # it may be subject to change without notice. You should not attempt to + # programmatically parse this data. For programmatic access, use the error_code + # field below. # Corresponds to the JSON property `debugString` # @return [String] attr_accessor :debug_string @@ -133,16 +126,15 @@ module Google # @return [Array] attr_accessor :error_code - # Set to true if the assets specified in the request are linked by the - # relation specified in the request. + # Set to true if the assets specified in the request are linked by the relation + # specified in the request. # Corresponds to the JSON property `linked` # @return [Boolean] attr_accessor :linked alias_method :linked?, :linked # From serving time, how much longer the response should be considered valid - # barring further updates. - # REQUIRED + # barring further updates. REQUIRED # Corresponds to the JSON property `maxAge` # @return [String] attr_accessor :max_age @@ -165,13 +157,12 @@ module Google include Google::Apis::Core::Hashable # Human-readable message containing information intended to help end users - # understand, reproduce and debug the result. - # The message will be in English and we are currently not planning to offer - # any translations. - # Please note that no guarantees are made about the contents or format of - # this string. Any aspect of it may be subject to change without notice. - # You should not attempt to programmatically parse this data. For - # programmatic access, use the error_code field below. + # understand, reproduce and debug the result. The message will be in English and + # we are currently not planning to offer any translations. Please note that no + # guarantees are made about the contents or format of this string. Any aspect of + # it may be subject to change without notice. You should not attempt to + # programmatically parse this data. For programmatic access, use the error_code + # field below. # Corresponds to the JSON property `debugString` # @return [String] attr_accessor :debug_string @@ -182,8 +173,7 @@ module Google attr_accessor :error_code # From serving time, how much longer the response should be considered valid - # barring further updates. - # REQUIRED + # barring further updates. REQUIRED # Corresponds to the JSON property `maxAge` # @return [String] attr_accessor :max_age @@ -207,42 +197,36 @@ module Google end # Describes a reliable statement that has been made about the relationship - # between a source asset and a target asset. - # Statements are always made by the source asset, either directly or by - # delegating to a statement list that is stored elsewhere. - # For more detailed definitions of statements and assets, please refer - # to our [API documentation landing - # page](/digital-asset-links/v1/getting-started). + # between a source asset and a target asset. Statements are always made by the + # source asset, either directly or by delegating to a statement list that is + # stored elsewhere. For more detailed definitions of statements and assets, + # please refer to our [API documentation landing page](/digital-asset-links/v1/ + # getting-started). class Statement include Google::Apis::Core::Hashable # The relation identifies the use of the statement as intended by the source - # asset's owner (that is, the person or entity who issued the statement). - # Every complete statement has a relation. - # We identify relations with strings of the format `/`, where - # `` must be one of a set of pre-defined purpose categories, and - # `` is a free-form lowercase alphanumeric string that describes the - # specific use case of the statement. - # Refer to [our API documentation](/digital-asset-links/v1/relation-strings) - # for the current list of supported relations. - # Example: `delegate_permission/common.handle_all_urls` - # REQUIRED + # asset's owner (that is, the person or entity who issued the statement). Every + # complete statement has a relation. We identify relations with strings of the + # format `/`, where `` must be one of a set of pre-defined purpose categories, + # and `` is a free-form lowercase alphanumeric string that describes the + # specific use case of the statement. Refer to [our API documentation](/digital- + # asset-links/v1/relation-strings) for the current list of supported relations. + # Example: `delegate_permission/common.handle_all_urls` REQUIRED # Corresponds to the JSON property `relation` # @return [String] attr_accessor :relation - # Uniquely identifies an asset. - # A digital asset is an identifiable and addressable online entity that - # typically provides some service or content. Examples of assets are websites, - # Android apps, Twitter feeds, and Plus Pages. + # Uniquely identifies an asset. A digital asset is an identifiable and + # addressable online entity that typically provides some service or content. + # Examples of assets are websites, Android apps, Twitter feeds, and Plus Pages. # Corresponds to the JSON property `source` # @return [Google::Apis::DigitalassetlinksV1::Asset] attr_accessor :source - # Uniquely identifies an asset. - # A digital asset is an identifiable and addressable online entity that - # typically provides some service or content. Examples of assets are websites, - # Android apps, Twitter feeds, and Plus Pages. + # Uniquely identifies an asset. A digital asset is an identifiable and + # addressable online entity that typically provides some service or content. + # Examples of assets are websites, Android apps, Twitter feeds, and Plus Pages. # Corresponds to the JSON property `target` # @return [Google::Apis::DigitalassetlinksV1::Asset] attr_accessor :target @@ -263,30 +247,20 @@ module Google class WebAsset include Google::Apis::Core::Hashable - # Web assets are identified by a URL that contains only the scheme, hostname - # and port parts. The format is - # http[s]://[:] - # Hostnames must be fully qualified: they must end in a single period - # ("`.`"). - # Only the schemes "http" and "https" are currently allowed. - # Port numbers are given as a decimal number, and they must be omitted if the - # standard port numbers are used: 80 for http and 443 for https. - # We call this limited URL the "site". All URLs that share the same scheme, - # hostname and port are considered to be a part of the site and thus belong - # to the web asset. - # Example: the asset with the site `https://www.google.com` contains all - # these URLs: - # * `https://www.google.com/` - # * `https://www.google.com:443/` - # * `https://www.google.com/foo` - # * `https://www.google.com/foo?bar` - # * `https://www.google.com/foo#bar` - # * `https://user@password:www.google.com/` - # But it does not contain these URLs: - # * `http://www.google.com/` (wrong scheme) - # * `https://google.com/` (hostname does not match) - # * `https://www.google.com:444/` (port does not match) - # REQUIRED + # Web assets are identified by a URL that contains only the scheme, hostname and + # port parts. The format is http[s]://[:] Hostnames must be fully qualified: + # they must end in a single period ("`.`"). Only the schemes "http" and "https" + # are currently allowed. Port numbers are given as a decimal number, and they + # must be omitted if the standard port numbers are used: 80 for http and 443 for + # https. We call this limited URL the "site". All URLs that share the same + # scheme, hostname and port are considered to be a part of the site and thus + # belong to the web asset. Example: the asset with the site `https://www.google. + # com` contains all these URLs: * `https://www.google.com/` * `https://www. + # google.com:443/` * `https://www.google.com/foo` * `https://www.google.com/foo? + # bar` * `https://www.google.com/foo#bar` * `https://user@password:www.google. + # com/` But it does not contain these URLs: * `http://www.google.com/` (wrong + # scheme) * `https://google.com/` (hostname does not match) * `https://www. + # google.com:444/` (port does not match) REQUIRED # Corresponds to the JSON property `site` # @return [String] attr_accessor :site diff --git a/generated/google/apis/digitalassetlinks_v1/service.rb b/generated/google/apis/digitalassetlinks_v1/service.rb index 3781a1caa..02a1e108d 100644 --- a/generated/google/apis/digitalassetlinks_v1/service.rb +++ b/generated/google/apis/digitalassetlinks_v1/service.rb @@ -47,134 +47,98 @@ module Google @batch_path = 'batch' end - # Determines whether the specified (directional) relationship exists between - # the specified source and target assets. - # The relation describes the intent of the link between the two assets as - # claimed by the source asset. An example for such relationships is the - # delegation of privileges or permissions. - # This command is most often used by infrastructure systems to check - # preconditions for an action. For example, a client may want to know if it - # is OK to send a web URL to a particular mobile app instead. The client can - # check for the relevant asset link from the website to the mobile app to - # decide if the operation should be allowed. - # A note about security: if you specify a secure asset as the source, such as - # an HTTPS website or an Android app, the API will ensure that any - # statements used to generate the response have been made in a secure way by - # the owner of that asset. Conversely, if the source asset is an insecure - # HTTP website (that is, the URL starts with `http://` instead of - # `https://`), the API cannot verify its statements securely, and it is not + # Determines whether the specified (directional) relationship exists between the + # specified source and target assets. The relation describes the intent of the + # link between the two assets as claimed by the source asset. An example for + # such relationships is the delegation of privileges or permissions. This + # command is most often used by infrastructure systems to check preconditions + # for an action. For example, a client may want to know if it is OK to send a + # web URL to a particular mobile app instead. The client can check for the + # relevant asset link from the website to the mobile app to decide if the + # operation should be allowed. A note about security: if you specify a secure + # asset as the source, such as an HTTPS website or an Android app, the API will + # ensure that any statements used to generate the response have been made in a + # secure way by the owner of that asset. Conversely, if the source asset is an + # insecure HTTP website (that is, the URL starts with `http://` instead of ` + # https://`), the API cannot verify its statements securely, and it is not # possible to ensure that the website's statements have not been altered by a - # third party. For more information, see the [Digital Asset Links technical - # design - # specification](https://github.com/google/digitalassetlinks/blob/master/well- - # known/details.md). + # third party. For more information, see the [Digital Asset Links technical + # design specification](https://github.com/google/digitalassetlinks/blob/master/ + # well-known/details.md). # @param [String] relation - # Query string for the relation. - # We identify relations with strings of the format `/`, where - # `` must be one of a set of pre-defined purpose categories, and - # `` is a free-form lowercase alphanumeric string that describes the - # specific use case of the statement. - # Refer to [our API documentation](/digital-asset-links/v1/relation-strings) - # for the current list of supported relations. + # Query string for the relation. We identify relations with strings of the + # format `/`, where `` must be one of a set of pre-defined purpose categories, + # and `` is a free-form lowercase alphanumeric string that describes the + # specific use case of the statement. Refer to [our API documentation](/digital- + # asset-links/v1/relation-strings) for the current list of supported relations. # For a query to match an asset link, both the query's and the asset link's - # relation strings must match exactly. - # Example: A query with relation `delegate_permission/common.handle_all_urls` - # matches an asset link with relation - # `delegate_permission/common.handle_all_urls`. + # relation strings must match exactly. Example: A query with relation ` + # delegate_permission/common.handle_all_urls` matches an asset link with + # relation `delegate_permission/common.handle_all_urls`. # @param [String] source_android_app_certificate_sha256_fingerprint - # The uppercase SHA-265 fingerprint of the certificate. From the PEM - # certificate, it can be acquired like this: - # $ keytool -printcert -file $CERTFILE | grep SHA256: - # SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ - # 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 - # or like this: - # $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 - # SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ - # 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 - # In this example, the contents of this field would be `14:6D:E9:83:C5:73: - # 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: - # 44:E5`. - # If these tools are not available to you, you can convert the PEM - # certificate into the DER format, compute the SHA-256 hash of that string - # and represent the result as a hexstring (that is, uppercase hexadecimal - # representations of each octet, separated by colons). + # The uppercase SHA-265 fingerprint of the certificate. From the PEM certificate, + # it can be acquired like this: $ keytool -printcert -file $CERTFILE | grep + # SHA256: SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ 42: + # E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in $CERTFILE + # -noout -fingerprint -sha256 SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE: + # B9:95:2F:34:FC:64: \ 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this + # example, the contents of this field would be `14:6D:E9:83:C5:73: 06:50:D8:EE: + # B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5`. If these + # tools are not available to you, you can convert the PEM certificate into the + # DER format, compute the SHA-256 hash of that string and represent the result + # as a hexstring (that is, uppercase hexadecimal representations of each octet, + # separated by colons). # @param [String] source_android_app_package_name - # Android App assets are naturally identified by their Java package name. - # For example, the Google Maps app uses the package name - # `com.google.android.apps.maps`. - # REQUIRED + # Android App assets are naturally identified by their Java package name. For + # example, the Google Maps app uses the package name `com.google.android.apps. + # maps`. REQUIRED # @param [String] source_web_site - # Web assets are identified by a URL that contains only the scheme, hostname - # and port parts. The format is - # http[s]://[:] - # Hostnames must be fully qualified: they must end in a single period - # ("`.`"). - # Only the schemes "http" and "https" are currently allowed. - # Port numbers are given as a decimal number, and they must be omitted if the - # standard port numbers are used: 80 for http and 443 for https. - # We call this limited URL the "site". All URLs that share the same scheme, - # hostname and port are considered to be a part of the site and thus belong - # to the web asset. - # Example: the asset with the site `https://www.google.com` contains all - # these URLs: - # * `https://www.google.com/` - # * `https://www.google.com:443/` - # * `https://www.google.com/foo` - # * `https://www.google.com/foo?bar` - # * `https://www.google.com/foo#bar` - # * `https://user@password:www.google.com/` - # But it does not contain these URLs: - # * `http://www.google.com/` (wrong scheme) - # * `https://google.com/` (hostname does not match) - # * `https://www.google.com:444/` (port does not match) - # REQUIRED + # Web assets are identified by a URL that contains only the scheme, hostname and + # port parts. The format is http[s]://[:] Hostnames must be fully qualified: + # they must end in a single period ("`.`"). Only the schemes "http" and "https" + # are currently allowed. Port numbers are given as a decimal number, and they + # must be omitted if the standard port numbers are used: 80 for http and 443 for + # https. We call this limited URL the "site". All URLs that share the same + # scheme, hostname and port are considered to be a part of the site and thus + # belong to the web asset. Example: the asset with the site `https://www.google. + # com` contains all these URLs: * `https://www.google.com/` * `https://www. + # google.com:443/` * `https://www.google.com/foo` * `https://www.google.com/foo? + # bar` * `https://www.google.com/foo#bar` * `https://user@password:www.google. + # com/` But it does not contain these URLs: * `http://www.google.com/` (wrong + # scheme) * `https://google.com/` (hostname does not match) * `https://www. + # google.com:444/` (port does not match) REQUIRED # @param [String] target_android_app_certificate_sha256_fingerprint - # The uppercase SHA-265 fingerprint of the certificate. From the PEM - # certificate, it can be acquired like this: - # $ keytool -printcert -file $CERTFILE | grep SHA256: - # SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ - # 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 - # or like this: - # $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 - # SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ - # 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 - # In this example, the contents of this field would be `14:6D:E9:83:C5:73: - # 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: - # 44:E5`. - # If these tools are not available to you, you can convert the PEM - # certificate into the DER format, compute the SHA-256 hash of that string - # and represent the result as a hexstring (that is, uppercase hexadecimal - # representations of each octet, separated by colons). + # The uppercase SHA-265 fingerprint of the certificate. From the PEM certificate, + # it can be acquired like this: $ keytool -printcert -file $CERTFILE | grep + # SHA256: SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ 42: + # E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in $CERTFILE + # -noout -fingerprint -sha256 SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE: + # B9:95:2F:34:FC:64: \ 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this + # example, the contents of this field would be `14:6D:E9:83:C5:73: 06:50:D8:EE: + # B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5`. If these + # tools are not available to you, you can convert the PEM certificate into the + # DER format, compute the SHA-256 hash of that string and represent the result + # as a hexstring (that is, uppercase hexadecimal representations of each octet, + # separated by colons). # @param [String] target_android_app_package_name - # Android App assets are naturally identified by their Java package name. - # For example, the Google Maps app uses the package name - # `com.google.android.apps.maps`. - # REQUIRED + # Android App assets are naturally identified by their Java package name. For + # example, the Google Maps app uses the package name `com.google.android.apps. + # maps`. REQUIRED # @param [String] target_web_site - # Web assets are identified by a URL that contains only the scheme, hostname - # and port parts. The format is - # http[s]://[:] - # Hostnames must be fully qualified: they must end in a single period - # ("`.`"). - # Only the schemes "http" and "https" are currently allowed. - # Port numbers are given as a decimal number, and they must be omitted if the - # standard port numbers are used: 80 for http and 443 for https. - # We call this limited URL the "site". All URLs that share the same scheme, - # hostname and port are considered to be a part of the site and thus belong - # to the web asset. - # Example: the asset with the site `https://www.google.com` contains all - # these URLs: - # * `https://www.google.com/` - # * `https://www.google.com:443/` - # * `https://www.google.com/foo` - # * `https://www.google.com/foo?bar` - # * `https://www.google.com/foo#bar` - # * `https://user@password:www.google.com/` - # But it does not contain these URLs: - # * `http://www.google.com/` (wrong scheme) - # * `https://google.com/` (hostname does not match) - # * `https://www.google.com:444/` (port does not match) - # REQUIRED + # Web assets are identified by a URL that contains only the scheme, hostname and + # port parts. The format is http[s]://[:] Hostnames must be fully qualified: + # they must end in a single period ("`.`"). Only the schemes "http" and "https" + # are currently allowed. Port numbers are given as a decimal number, and they + # must be omitted if the standard port numbers are used: 80 for http and 443 for + # https. We call this limited URL the "site". All URLs that share the same + # scheme, hostname and port are considered to be a part of the site and thus + # belong to the web asset. Example: the asset with the site `https://www.google. + # com` contains all these URLs: * `https://www.google.com/` * `https://www. + # google.com:443/` * `https://www.google.com/foo` * `https://www.google.com/foo? + # bar` * `https://www.google.com/foo#bar` * `https://user@password:www.google. + # com/` But it does not contain these URLs: * `http://www.google.com/` (wrong + # scheme) * `https://google.com/` (hostname does not match) * `https://www. + # google.com:444/` (port does not match) REQUIRED # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -209,79 +173,58 @@ module Google end # Retrieves a list of all statements from a given source that match the - # specified target and statement string. - # The API guarantees that all statements with secure source assets, such as - # HTTPS websites or Android apps, have been made in a secure way by the owner - # of those assets, as described in the [Digital Asset Links technical design - # specification](https://github.com/google/digitalassetlinks/blob/master/well- - # known/details.md). - # Specifically, you should consider that for insecure websites (that is, - # where the URL starts with `http://` instead of `https://`), this guarantee - # cannot be made. - # The `List` command is most useful in cases where the API client wants to - # know all the ways in which two assets are related, or enumerate all the - # relationships from a particular source asset. Example: a feature that - # helps users navigate to related items. When a mobile app is running on a - # device, the feature would make it easy to navigate to the corresponding web - # site or Google+ profile. + # specified target and statement string. The API guarantees that all statements + # with secure source assets, such as HTTPS websites or Android apps, have been + # made in a secure way by the owner of those assets, as described in the [ + # Digital Asset Links technical design specification](https://github.com/google/ + # digitalassetlinks/blob/master/well-known/details.md). Specifically, you should + # consider that for insecure websites (that is, where the URL starts with `http:/ + # /` instead of `https://`), this guarantee cannot be made. The `List` command + # is most useful in cases where the API client wants to know all the ways in + # which two assets are related, or enumerate all the relationships from a + # particular source asset. Example: a feature that helps users navigate to + # related items. When a mobile app is running on a device, the feature would + # make it easy to navigate to the corresponding web site or Google+ profile. # @param [String] relation - # Use only associations that match the specified relation. - # See the [`Statement`](#Statement) message for a detailed definition of - # relation strings. - # For a query to match a statement, one of the following must be true: - # * both the query's and the statement's relation strings match exactly, - # or - # * the query's relation string is empty or missing. - # Example: A query with relation `delegate_permission/common.handle_all_urls` - # matches an asset link with relation - # `delegate_permission/common.handle_all_urls`. + # Use only associations that match the specified relation. See the [`Statement`]( + # #Statement) message for a detailed definition of relation strings. For a query + # to match a statement, one of the following must be true: * both the query's + # and the statement's relation strings match exactly, or * the query's relation + # string is empty or missing. Example: A query with relation ` + # delegate_permission/common.handle_all_urls` matches an asset link with + # relation `delegate_permission/common.handle_all_urls`. # @param [String] source_android_app_certificate_sha256_fingerprint - # The uppercase SHA-265 fingerprint of the certificate. From the PEM - # certificate, it can be acquired like this: - # $ keytool -printcert -file $CERTFILE | grep SHA256: - # SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ - # 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 - # or like this: - # $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 - # SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ - # 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 - # In this example, the contents of this field would be `14:6D:E9:83:C5:73: - # 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: - # 44:E5`. - # If these tools are not available to you, you can convert the PEM - # certificate into the DER format, compute the SHA-256 hash of that string - # and represent the result as a hexstring (that is, uppercase hexadecimal - # representations of each octet, separated by colons). + # The uppercase SHA-265 fingerprint of the certificate. From the PEM certificate, + # it can be acquired like this: $ keytool -printcert -file $CERTFILE | grep + # SHA256: SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ 42: + # E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in $CERTFILE + # -noout -fingerprint -sha256 SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE: + # B9:95:2F:34:FC:64: \ 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this + # example, the contents of this field would be `14:6D:E9:83:C5:73: 06:50:D8:EE: + # B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5`. If these + # tools are not available to you, you can convert the PEM certificate into the + # DER format, compute the SHA-256 hash of that string and represent the result + # as a hexstring (that is, uppercase hexadecimal representations of each octet, + # separated by colons). # @param [String] source_android_app_package_name - # Android App assets are naturally identified by their Java package name. - # For example, the Google Maps app uses the package name - # `com.google.android.apps.maps`. - # REQUIRED + # Android App assets are naturally identified by their Java package name. For + # example, the Google Maps app uses the package name `com.google.android.apps. + # maps`. REQUIRED # @param [String] source_web_site - # Web assets are identified by a URL that contains only the scheme, hostname - # and port parts. The format is - # http[s]://[:] - # Hostnames must be fully qualified: they must end in a single period - # ("`.`"). - # Only the schemes "http" and "https" are currently allowed. - # Port numbers are given as a decimal number, and they must be omitted if the - # standard port numbers are used: 80 for http and 443 for https. - # We call this limited URL the "site". All URLs that share the same scheme, - # hostname and port are considered to be a part of the site and thus belong - # to the web asset. - # Example: the asset with the site `https://www.google.com` contains all - # these URLs: - # * `https://www.google.com/` - # * `https://www.google.com:443/` - # * `https://www.google.com/foo` - # * `https://www.google.com/foo?bar` - # * `https://www.google.com/foo#bar` - # * `https://user@password:www.google.com/` - # But it does not contain these URLs: - # * `http://www.google.com/` (wrong scheme) - # * `https://google.com/` (hostname does not match) - # * `https://www.google.com:444/` (port does not match) - # REQUIRED + # Web assets are identified by a URL that contains only the scheme, hostname and + # port parts. The format is http[s]://[:] Hostnames must be fully qualified: + # they must end in a single period ("`.`"). Only the schemes "http" and "https" + # are currently allowed. Port numbers are given as a decimal number, and they + # must be omitted if the standard port numbers are used: 80 for http and 443 for + # https. We call this limited URL the "site". All URLs that share the same + # scheme, hostname and port are considered to be a part of the site and thus + # belong to the web asset. Example: the asset with the site `https://www.google. + # com` contains all these URLs: * `https://www.google.com/` * `https://www. + # google.com:443/` * `https://www.google.com/foo` * `https://www.google.com/foo? + # bar` * `https://www.google.com/foo#bar` * `https://user@password:www.google. + # com/` But it does not contain these URLs: * `http://www.google.com/` (wrong + # scheme) * `https://google.com/` (hostname does not match) * `https://www. + # google.com:444/` (port does not match) REQUIRED # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/displayvideo_v1.rb b/generated/google/apis/displayvideo_v1.rb index ddb607f1c..5b8cfdfa2 100644 --- a/generated/google/apis/displayvideo_v1.rb +++ b/generated/google/apis/displayvideo_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/display-video/ module DisplayvideoV1 VERSION = 'V1' - REVISION = '20200820' + REVISION = '20200901' # Create, see, edit, and permanently delete your Display & Video 360 entities and reports AUTH_DISPLAY_VIDEO = 'https://www.googleapis.com/auth/display-video' diff --git a/generated/google/apis/displayvideo_v1/service.rb b/generated/google/apis/displayvideo_v1/service.rb index 6b25dfd14..d296bffb8 100644 --- a/generated/google/apis/displayvideo_v1/service.rb +++ b/generated/google/apis/displayvideo_v1/service.rb @@ -281,8 +281,8 @@ module Google # expressions are made up of one or more restrictions. * Restrictions can be # combined by `AND` or `OR` logical operators. A sequence of restrictions # implicitly uses `AND`. * A restriction has the form of ``field` `operator` ` - # value``. * The operator must be `EQUALS (=)`. * Supported fields: . - ` - # advertiserId` . - `displayName` - `entityStatus` Examples: * All active + # value``. * The operator must be `EQUALS (=)`. * Supported fields: - ` + # advertiserId` - `displayName` - `entityStatus` Examples: * All active # advertisers under a partner: `entityStatus="ENTITY_STATUS_ACTIVE"` The length # of this field should be no more than 500 characters. # @param [String] order_by diff --git a/generated/google/apis/displayvideo_v1beta.rb b/generated/google/apis/displayvideo_v1beta.rb new file mode 100644 index 000000000..bd149c659 --- /dev/null +++ b/generated/google/apis/displayvideo_v1beta.rb @@ -0,0 +1,38 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/displayvideo_v1beta/service.rb' +require 'google/apis/displayvideo_v1beta/classes.rb' +require 'google/apis/displayvideo_v1beta/representations.rb' + +module Google + module Apis + # Display & Video 360 API + # + # Display & Video 360 API allows users to manage and create campaigns and + # reports. + # + # @see https://developers.google.com/display-video/ + module DisplayvideoV1beta + VERSION = 'V1beta' + REVISION = '20200825' + + # Create, see, edit, and permanently delete your Display & Video 360 entities and reports + AUTH_DISPLAY_VIDEO = 'https://www.googleapis.com/auth/display-video' + + # View and manage your reports in DoubleClick Bid Manager + AUTH_DOUBLECLICKBIDMANAGER = 'https://www.googleapis.com/auth/doubleclickbidmanager' + end + end +end diff --git a/generated/google/apis/displayvideo_v1beta/classes.rb b/generated/google/apis/displayvideo_v1beta/classes.rb new file mode 100644 index 000000000..80941ba12 --- /dev/null +++ b/generated/google/apis/displayvideo_v1beta/classes.rb @@ -0,0 +1,146 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DisplayvideoV1beta + + # Media resource. + class GoogleBytestreamMedia + include Google::Apis::Core::Hashable + + # Name of the media resource. + # Corresponds to the JSON property `resourceName` + # @return [String] + attr_accessor :resource_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @resource_name = args[:resource_name] if args.key?(:resource_name) + end + end + + # This resource represents a long-running operation that is the result of a + # network API call. + class Operation + include Google::Apis::Core::Hashable + + # If the value is `false`, it means the operation is still in progress. If `true` + # , the operation is completed, and either `error` or `response` is available. + # Corresponds to the JSON property `done` + # @return [Boolean] + attr_accessor :done + alias_method :done?, :done + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). + # Corresponds to the JSON property `error` + # @return [Google::Apis::DisplayvideoV1beta::Status] + attr_accessor :error + + # Service-specific metadata associated with the operation. It typically contains + # progress information and common metadata such as create time. Some services + # might not provide such metadata. Any method that returns a long-running + # operation should document the metadata type, if any. + # Corresponds to the JSON property `metadata` + # @return [Hash] + attr_accessor :metadata + + # The server-assigned name, which is only unique within the same service that + # originally returns it. If you use the default HTTP mapping, the `name` should + # be a resource name ending with `operations/`unique_id``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The normal response of the operation in case of success. If the original + # method returns no data on success, such as `Delete`, the response is `google. + # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, + # the response should be the resource. For other methods, the response should + # have the type `XxxResponse`, where `Xxx` is the original method name. For + # example, if the original method name is `TakeSnapshot()`, the inferred + # response type is `TakeSnapshotResponse`. + # Corresponds to the JSON property `response` + # @return [Hash] + attr_accessor :response + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @done = args[:done] if args.key?(:done) + @error = args[:error] if args.key?(:error) + @metadata = args[:metadata] if args.key?(:metadata) + @name = args[:name] if args.key?(:name) + @response = args[:response] if args.key?(:response) + end + end + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). + class Status + include Google::Apis::Core::Hashable + + # The status code, which should be an enum value of google.rpc.Code. + # Corresponds to the JSON property `code` + # @return [Fixnum] + attr_accessor :code + + # A list of messages that carry the error details. There is a common set of + # message types for APIs to use. + # Corresponds to the JSON property `details` + # @return [Array>] + attr_accessor :details + + # A developer-facing error message, which should be in English. Any user-facing + # error message should be localized and sent in the google.rpc.Status.details + # field, or localized by the client. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @details = args[:details] if args.key?(:details) + @message = args[:message] if args.key?(:message) + end + end + end + end +end diff --git a/generated/google/apis/displayvideo_v1beta/representations.rb b/generated/google/apis/displayvideo_v1beta/representations.rb new file mode 100644 index 000000000..81149d505 --- /dev/null +++ b/generated/google/apis/displayvideo_v1beta/representations.rb @@ -0,0 +1,72 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DisplayvideoV1beta + + class GoogleBytestreamMedia + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Operation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Status + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleBytestreamMedia + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :resource_name, as: 'resourceName' + end + end + + class Operation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :done, as: 'done' + property :error, as: 'error', class: Google::Apis::DisplayvideoV1beta::Status, decorator: Google::Apis::DisplayvideoV1beta::Status::Representation + + hash :metadata, as: 'metadata' + property :name, as: 'name' + hash :response, as: 'response' + end + end + + class Status + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :details, as: 'details' + property :message, as: 'message' + end + end + end + end +end diff --git a/generated/google/apis/displayvideo_v1beta/service.rb b/generated/google/apis/displayvideo_v1beta/service.rb new file mode 100644 index 000000000..3db217b44 --- /dev/null +++ b/generated/google/apis/displayvideo_v1beta/service.rb @@ -0,0 +1,161 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DisplayvideoV1beta + # Display & Video 360 API + # + # Display & Video 360 API allows users to manage and create campaigns and + # reports. + # + # @example + # require 'google/apis/displayvideo_v1beta' + # + # Displayvideo = Google::Apis::DisplayvideoV1beta # Alias the module + # service = Displayvideo::DisplayVideoService.new + # + # @see https://developers.google.com/display-video/ + class DisplayVideoService < Google::Apis::Core::BaseService + # @return [String] + # 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. + attr_accessor :key + + # @return [String] + # 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. + attr_accessor :quota_user + + def initialize + super('https://displayvideo.googleapis.com/', '') + @batch_path = 'batch' + end + + # Downloads media. Download is supported on the URI `/download/`resource_name=**` + # ?alt=media.` **Note**: Download requests will not be successful without + # including `alt=media` query string. + # @param [String] resource_name + # Name of the media that is being downloaded. See ReadRequest.resource_name. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [IO, String] download_dest + # IO stream or filename to receive content download + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1beta::GoogleBytestreamMedia] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1beta::GoogleBytestreamMedia] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def download_medium(resource_name, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block) + if download_dest.nil? + command = make_simple_command(:get, 'download/{+resourceName}', options) + else + command = make_download_command(:get, 'download/{+resourceName}', options) + command.download_dest = download_dest + end + command.response_representation = Google::Apis::DisplayvideoV1beta::GoogleBytestreamMedia::Representation + command.response_class = Google::Apis::DisplayvideoV1beta::GoogleBytestreamMedia + command.params['resourceName'] = resource_name unless resource_name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the latest state of an asynchronous SDF download task operation. Clients + # should poll this method at intervals of 30 seconds. + # @param [String] name + # The name of the operation resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1beta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1beta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_sdfdownloadtask_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::DisplayvideoV1beta::Operation::Representation + command.response_class = Google::Apis::DisplayvideoV1beta::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the latest state of an asynchronous SDF download task operation. Clients + # should poll this method at intervals of 30 seconds. + # @param [String] name + # The name of the operation resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1beta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1beta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_sdfdownloadtasks_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::DisplayvideoV1beta::Operation::Representation + command.response_class = Google::Apis::DisplayvideoV1beta::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/displayvideo_v1beta2.rb b/generated/google/apis/displayvideo_v1beta2.rb new file mode 100644 index 000000000..6cea5402d --- /dev/null +++ b/generated/google/apis/displayvideo_v1beta2.rb @@ -0,0 +1,38 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/displayvideo_v1beta2/service.rb' +require 'google/apis/displayvideo_v1beta2/classes.rb' +require 'google/apis/displayvideo_v1beta2/representations.rb' + +module Google + module Apis + # Display & Video 360 API + # + # Display & Video 360 API allows users to manage and create campaigns and + # reports. + # + # @see https://developers.google.com/display-video/ + module DisplayvideoV1beta2 + VERSION = 'V1beta2' + REVISION = '20200825' + + # Create, see, edit, and permanently delete your Display & Video 360 entities and reports + AUTH_DISPLAY_VIDEO = 'https://www.googleapis.com/auth/display-video' + + # View and manage your reports in DoubleClick Bid Manager + AUTH_DOUBLECLICKBIDMANAGER = 'https://www.googleapis.com/auth/doubleclickbidmanager' + end + end +end diff --git a/generated/google/apis/displayvideo_v1beta2/classes.rb b/generated/google/apis/displayvideo_v1beta2/classes.rb new file mode 100644 index 000000000..eb5744e53 --- /dev/null +++ b/generated/google/apis/displayvideo_v1beta2/classes.rb @@ -0,0 +1,146 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DisplayvideoV1beta2 + + # Media resource. + class GoogleBytestreamMedia + include Google::Apis::Core::Hashable + + # Name of the media resource. + # Corresponds to the JSON property `resourceName` + # @return [String] + attr_accessor :resource_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @resource_name = args[:resource_name] if args.key?(:resource_name) + end + end + + # This resource represents a long-running operation that is the result of a + # network API call. + class Operation + include Google::Apis::Core::Hashable + + # If the value is `false`, it means the operation is still in progress. If `true` + # , the operation is completed, and either `error` or `response` is available. + # Corresponds to the JSON property `done` + # @return [Boolean] + attr_accessor :done + alias_method :done?, :done + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). + # Corresponds to the JSON property `error` + # @return [Google::Apis::DisplayvideoV1beta2::Status] + attr_accessor :error + + # Service-specific metadata associated with the operation. It typically contains + # progress information and common metadata such as create time. Some services + # might not provide such metadata. Any method that returns a long-running + # operation should document the metadata type, if any. + # Corresponds to the JSON property `metadata` + # @return [Hash] + attr_accessor :metadata + + # The server-assigned name, which is only unique within the same service that + # originally returns it. If you use the default HTTP mapping, the `name` should + # be a resource name ending with `operations/`unique_id``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The normal response of the operation in case of success. If the original + # method returns no data on success, such as `Delete`, the response is `google. + # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, + # the response should be the resource. For other methods, the response should + # have the type `XxxResponse`, where `Xxx` is the original method name. For + # example, if the original method name is `TakeSnapshot()`, the inferred + # response type is `TakeSnapshotResponse`. + # Corresponds to the JSON property `response` + # @return [Hash] + attr_accessor :response + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @done = args[:done] if args.key?(:done) + @error = args[:error] if args.key?(:error) + @metadata = args[:metadata] if args.key?(:metadata) + @name = args[:name] if args.key?(:name) + @response = args[:response] if args.key?(:response) + end + end + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). + class Status + include Google::Apis::Core::Hashable + + # The status code, which should be an enum value of google.rpc.Code. + # Corresponds to the JSON property `code` + # @return [Fixnum] + attr_accessor :code + + # A list of messages that carry the error details. There is a common set of + # message types for APIs to use. + # Corresponds to the JSON property `details` + # @return [Array>] + attr_accessor :details + + # A developer-facing error message, which should be in English. Any user-facing + # error message should be localized and sent in the google.rpc.Status.details + # field, or localized by the client. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @details = args[:details] if args.key?(:details) + @message = args[:message] if args.key?(:message) + end + end + end + end +end diff --git a/generated/google/apis/displayvideo_v1beta2/representations.rb b/generated/google/apis/displayvideo_v1beta2/representations.rb new file mode 100644 index 000000000..7dc597463 --- /dev/null +++ b/generated/google/apis/displayvideo_v1beta2/representations.rb @@ -0,0 +1,72 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DisplayvideoV1beta2 + + class GoogleBytestreamMedia + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Operation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Status + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleBytestreamMedia + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :resource_name, as: 'resourceName' + end + end + + class Operation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :done, as: 'done' + property :error, as: 'error', class: Google::Apis::DisplayvideoV1beta2::Status, decorator: Google::Apis::DisplayvideoV1beta2::Status::Representation + + hash :metadata, as: 'metadata' + property :name, as: 'name' + hash :response, as: 'response' + end + end + + class Status + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :details, as: 'details' + property :message, as: 'message' + end + end + end + end +end diff --git a/generated/google/apis/displayvideo_v1beta2/service.rb b/generated/google/apis/displayvideo_v1beta2/service.rb new file mode 100644 index 000000000..f92cc1a71 --- /dev/null +++ b/generated/google/apis/displayvideo_v1beta2/service.rb @@ -0,0 +1,130 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DisplayvideoV1beta2 + # Display & Video 360 API + # + # Display & Video 360 API allows users to manage and create campaigns and + # reports. + # + # @example + # require 'google/apis/displayvideo_v1beta2' + # + # Displayvideo = Google::Apis::DisplayvideoV1beta2 # Alias the module + # service = Displayvideo::DisplayVideoService.new + # + # @see https://developers.google.com/display-video/ + class DisplayVideoService < Google::Apis::Core::BaseService + # @return [String] + # 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. + attr_accessor :key + + # @return [String] + # 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. + attr_accessor :quota_user + + def initialize + super('https://displayvideo.googleapis.com/', '') + @batch_path = 'batch' + end + + # Downloads media. Download is supported on the URI `/download/`resource_name=**` + # ?alt=media.` **Note**: Download requests will not be successful without + # including `alt=media` query string. + # @param [String] resource_name + # Name of the media that is being downloaded. See ReadRequest.resource_name. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [IO, String] download_dest + # IO stream or filename to receive content download + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1beta2::GoogleBytestreamMedia] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1beta2::GoogleBytestreamMedia] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def download_medium(resource_name, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block) + if download_dest.nil? + command = make_simple_command(:get, 'download/{+resourceName}', options) + else + command = make_download_command(:get, 'download/{+resourceName}', options) + command.download_dest = download_dest + end + command.response_representation = Google::Apis::DisplayvideoV1beta2::GoogleBytestreamMedia::Representation + command.response_class = Google::Apis::DisplayvideoV1beta2::GoogleBytestreamMedia + command.params['resourceName'] = resource_name unless resource_name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the latest state of an asynchronous SDF download task operation. Clients + # should poll this method at intervals of 30 seconds. + # @param [String] name + # The name of the operation resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1beta2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1beta2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_sdfdownloadtask_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta2/{+name}', options) + command.response_representation = Google::Apis::DisplayvideoV1beta2::Operation::Representation + command.response_class = Google::Apis::DisplayvideoV1beta2::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/displayvideo_v1dev.rb b/generated/google/apis/displayvideo_v1dev.rb new file mode 100644 index 000000000..4771131f4 --- /dev/null +++ b/generated/google/apis/displayvideo_v1dev.rb @@ -0,0 +1,38 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/displayvideo_v1dev/service.rb' +require 'google/apis/displayvideo_v1dev/classes.rb' +require 'google/apis/displayvideo_v1dev/representations.rb' + +module Google + module Apis + # Display & Video 360 API + # + # Display & Video 360 API allows users to manage and create campaigns and + # reports. + # + # @see https://developers.google.com/display-video/ + module DisplayvideoV1dev + VERSION = 'V1dev' + REVISION = '20200825' + + # Create, see, edit, and permanently delete your Display & Video 360 entities and reports + AUTH_DISPLAY_VIDEO = 'https://www.googleapis.com/auth/display-video' + + # View and manage your reports in DoubleClick Bid Manager + AUTH_DOUBLECLICKBIDMANAGER = 'https://www.googleapis.com/auth/doubleclickbidmanager' + end + end +end diff --git a/generated/google/apis/displayvideo_v1dev/classes.rb b/generated/google/apis/displayvideo_v1dev/classes.rb new file mode 100644 index 000000000..a3b39e7b6 --- /dev/null +++ b/generated/google/apis/displayvideo_v1dev/classes.rb @@ -0,0 +1,146 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DisplayvideoV1dev + + # Media resource. + class GoogleBytestreamMedia + include Google::Apis::Core::Hashable + + # Name of the media resource. + # Corresponds to the JSON property `resourceName` + # @return [String] + attr_accessor :resource_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @resource_name = args[:resource_name] if args.key?(:resource_name) + end + end + + # This resource represents a long-running operation that is the result of a + # network API call. + class Operation + include Google::Apis::Core::Hashable + + # If the value is `false`, it means the operation is still in progress. If `true` + # , the operation is completed, and either `error` or `response` is available. + # Corresponds to the JSON property `done` + # @return [Boolean] + attr_accessor :done + alias_method :done?, :done + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). + # Corresponds to the JSON property `error` + # @return [Google::Apis::DisplayvideoV1dev::Status] + attr_accessor :error + + # Service-specific metadata associated with the operation. It typically contains + # progress information and common metadata such as create time. Some services + # might not provide such metadata. Any method that returns a long-running + # operation should document the metadata type, if any. + # Corresponds to the JSON property `metadata` + # @return [Hash] + attr_accessor :metadata + + # The server-assigned name, which is only unique within the same service that + # originally returns it. If you use the default HTTP mapping, the `name` should + # be a resource name ending with `operations/`unique_id``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The normal response of the operation in case of success. If the original + # method returns no data on success, such as `Delete`, the response is `google. + # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, + # the response should be the resource. For other methods, the response should + # have the type `XxxResponse`, where `Xxx` is the original method name. For + # example, if the original method name is `TakeSnapshot()`, the inferred + # response type is `TakeSnapshotResponse`. + # Corresponds to the JSON property `response` + # @return [Hash] + attr_accessor :response + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @done = args[:done] if args.key?(:done) + @error = args[:error] if args.key?(:error) + @metadata = args[:metadata] if args.key?(:metadata) + @name = args[:name] if args.key?(:name) + @response = args[:response] if args.key?(:response) + end + end + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). + class Status + include Google::Apis::Core::Hashable + + # The status code, which should be an enum value of google.rpc.Code. + # Corresponds to the JSON property `code` + # @return [Fixnum] + attr_accessor :code + + # A list of messages that carry the error details. There is a common set of + # message types for APIs to use. + # Corresponds to the JSON property `details` + # @return [Array>] + attr_accessor :details + + # A developer-facing error message, which should be in English. Any user-facing + # error message should be localized and sent in the google.rpc.Status.details + # field, or localized by the client. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @details = args[:details] if args.key?(:details) + @message = args[:message] if args.key?(:message) + end + end + end + end +end diff --git a/generated/google/apis/displayvideo_v1dev/representations.rb b/generated/google/apis/displayvideo_v1dev/representations.rb new file mode 100644 index 000000000..b2e853c9c --- /dev/null +++ b/generated/google/apis/displayvideo_v1dev/representations.rb @@ -0,0 +1,72 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DisplayvideoV1dev + + class GoogleBytestreamMedia + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Operation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Status + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleBytestreamMedia + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :resource_name, as: 'resourceName' + end + end + + class Operation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :done, as: 'done' + property :error, as: 'error', class: Google::Apis::DisplayvideoV1dev::Status, decorator: Google::Apis::DisplayvideoV1dev::Status::Representation + + hash :metadata, as: 'metadata' + property :name, as: 'name' + hash :response, as: 'response' + end + end + + class Status + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :details, as: 'details' + property :message, as: 'message' + end + end + end + end +end diff --git a/generated/google/apis/displayvideo_v1dev/service.rb b/generated/google/apis/displayvideo_v1dev/service.rb new file mode 100644 index 000000000..d0312132b --- /dev/null +++ b/generated/google/apis/displayvideo_v1dev/service.rb @@ -0,0 +1,130 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DisplayvideoV1dev + # Display & Video 360 API + # + # Display & Video 360 API allows users to manage and create campaigns and + # reports. + # + # @example + # require 'google/apis/displayvideo_v1dev' + # + # Displayvideo = Google::Apis::DisplayvideoV1dev # Alias the module + # service = Displayvideo::DisplayVideoService.new + # + # @see https://developers.google.com/display-video/ + class DisplayVideoService < Google::Apis::Core::BaseService + # @return [String] + # 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. + attr_accessor :key + + # @return [String] + # 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. + attr_accessor :quota_user + + def initialize + super('https://displayvideo.googleapis.com/', '') + @batch_path = 'batch' + end + + # Downloads media. Download is supported on the URI `/download/`resource_name=**` + # ?alt=media.` **Note**: Download requests will not be successful without + # including `alt=media` query string. + # @param [String] resource_name + # Name of the media that is being downloaded. See ReadRequest.resource_name. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [IO, String] download_dest + # IO stream or filename to receive content download + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1dev::GoogleBytestreamMedia] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1dev::GoogleBytestreamMedia] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def download_medium(resource_name, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block) + if download_dest.nil? + command = make_simple_command(:get, 'download/{+resourceName}', options) + else + command = make_download_command(:get, 'download/{+resourceName}', options) + command.download_dest = download_dest + end + command.response_representation = Google::Apis::DisplayvideoV1dev::GoogleBytestreamMedia::Representation + command.response_class = Google::Apis::DisplayvideoV1dev::GoogleBytestreamMedia + command.params['resourceName'] = resource_name unless resource_name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the latest state of an asynchronous SDF download task operation. Clients + # should poll this method at intervals of 30 seconds. + # @param [String] name + # The name of the operation resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1dev::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1dev::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_sdfdownloadtask_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1dev/{+name}', options) + command.response_representation = Google::Apis::DisplayvideoV1dev::Operation::Representation + command.response_class = Google::Apis::DisplayvideoV1dev::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/dlp_v2.rb b/generated/google/apis/dlp_v2.rb index 7a00d9c3c..5675499cb 100644 --- a/generated/google/apis/dlp_v2.rb +++ b/generated/google/apis/dlp_v2.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/dlp/docs/ module DlpV2 VERSION = 'V2' - REVISION = '20200821' + REVISION = '20200905' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dlp_v2/classes.rb b/generated/google/apis/dlp_v2/classes.rb index ba1b0ab9a..ffc881771 100644 --- a/generated/google/apis/dlp_v2/classes.rb +++ b/generated/google/apis/dlp_v2/classes.rb @@ -1107,7 +1107,7 @@ module Google attr_accessor :location_id # The template id can contain uppercase and lowercase letters, numbers, and - # hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The + # hyphens; that is, it must match the regular expression: `[a-zA-Z\d-_]+`. The # maximum length is 100 characters. Can be empty to allow the system to generate # one. # Corresponds to the JSON property `templateId` @@ -1137,7 +1137,7 @@ module Google attr_accessor :inspect_job # The job id can contain uppercase and lowercase letters, numbers, and hyphens; - # that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The maximum + # that is, it must match the regular expression: `[a-zA-Z\d-_]+`. The maximum # length is 100 characters. Can be empty to allow the system to generate one. # Corresponds to the JSON property `jobId` # @return [String] @@ -1185,7 +1185,7 @@ module Google attr_accessor :location_id # The template id can contain uppercase and lowercase letters, numbers, and - # hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The + # hyphens; that is, it must match the regular expression: `[a-zA-Z\d-_]+`. The # maximum length is 100 characters. Can be empty to allow the system to generate # one. # Corresponds to the JSON property `templateId` @@ -1220,7 +1220,7 @@ module Google attr_accessor :location_id # The trigger id can contain uppercase and lowercase letters, numbers, and - # hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The + # hyphens; that is, it must match the regular expression: `[a-zA-Z\d-_]+`. The # maximum length is 100 characters. Can be empty to allow the system to generate # one. # Corresponds to the JSON property `triggerId` @@ -1256,7 +1256,7 @@ module Google attr_accessor :location_id # The storedInfoType ID can contain uppercase and lowercase letters, numbers, - # and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. + # and hyphens; that is, it must match the regular expression: `[a-zA-Z\d-_]+`. # The maximum length is 100 characters. Can be empty to allow the system to # generate one. # Corresponds to the JSON property `storedInfoTypeId` diff --git a/generated/google/apis/documentai_v1beta2.rb b/generated/google/apis/documentai_v1beta2.rb index b3394b41a..8a2f2e0b3 100644 --- a/generated/google/apis/documentai_v1beta2.rb +++ b/generated/google/apis/documentai_v1beta2.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/document-ai/docs/ module DocumentaiV1beta2 VERSION = 'V1beta2' - REVISION = '20200807' + REVISION = '20200828' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/documentai_v1beta2/classes.rb b/generated/google/apis/documentai_v1beta2/classes.rb index be6f3b315..2c614141a 100644 --- a/generated/google/apis/documentai_v1beta2/classes.rb +++ b/generated/google/apis/documentai_v1beta2/classes.rb @@ -402,6 +402,11 @@ module Google # @return [Array] attr_accessor :pages + # Revision history of this document. + # Corresponds to the JSON property `revisions` + # @return [Array] + attr_accessor :revisions + # For a large document, sharding may be performed to produce several document # shards. Each document shard contains this field to detail which shard it is. # Corresponds to the JSON property `shardInfo` @@ -413,6 +418,13 @@ module Google # @return [String] attr_accessor :text + # 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. + # Corresponds to the JSON property `textChanges` + # @return [Array] + attr_accessor :text_changes + # Styles for the Document.text. # Corresponds to the JSON property `textStyles` # @return [Array] @@ -444,8 +456,10 @@ module Google @error = args[:error] if args.key?(:error) @mime_type = args[:mime_type] if args.key?(:mime_type) @pages = args[:pages] if args.key?(:pages) + @revisions = args[:revisions] if args.key?(:revisions) @shard_info = args[:shard_info] if args.key?(:shard_info) @text = args[:text] if args.key?(:text) + @text_changes = args[:text_changes] if args.key?(:text_changes) @text_styles = args[:text_styles] if args.key?(:text_styles) @translations = args[:translations] if args.key?(:translations) @uri = args[:uri] if args.key?(:uri) @@ -462,6 +476,12 @@ module Google # @return [Float] attr_accessor :confidence + # Optional. Canonical id. This will be a unique value in the entity list for + # this document. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + # Deprecated. Use `id` field instead. # Corresponds to the JSON property `mentionId` # @return [String] @@ -477,6 +497,25 @@ module Google # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue] attr_accessor :normalized_value + # Referencing the visual context of the entity in the Document.pages. Page + # anchors can be cross-page, consist of multiple bounding polygons and + # optionally reference specific layout element types. + # Corresponds to the JSON property `pageAnchor` + # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageAnchor] + attr_accessor :page_anchor + + # Optional. Entities can be nested to form a hierarchical data structure + # representing the content in the document. + # Corresponds to the JSON property `properties` + # @return [Array] + attr_accessor :properties + + # Structure to identify provenance relationships between annotations in + # different revisions. + # Corresponds to the JSON property `provenance` + # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentProvenance] + attr_accessor :provenance + # Optional. Whether the entity will be redacted for de-identification purposes. # Corresponds to the JSON property `redacted` # @return [Boolean] @@ -500,9 +539,13 @@ module Google # Update properties of this object def update!(**args) @confidence = args[:confidence] if args.key?(:confidence) + @id = args[:id] if args.key?(:id) @mention_id = args[:mention_id] if args.key?(:mention_id) @mention_text = args[:mention_text] if args.key?(:mention_text) @normalized_value = args[:normalized_value] if args.key?(:normalized_value) + @page_anchor = args[:page_anchor] if args.key?(:page_anchor) + @properties = args[:properties] if args.key?(:properties) + @provenance = args[:provenance] if args.key?(:provenance) @redacted = args[:redacted] if args.key?(:redacted) @text_anchor = args[:text_anchor] if args.key?(:text_anchor) @type = args[:type] if args.key?(:type) @@ -513,6 +556,20 @@ module Google class GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue include Google::Apis::Core::Hashable + # Represents a postal address, e.g. for postal delivery or payments addresses. + # Given a postal address, a postal service can deliver items to a premise, P.O. + # Box or similar. It is not intended to model geographical locations (roads, + # towns, mountains). In typical usage an address would be created via user input + # or from importing existing data, depending on the type of process. Advice on + # address input / editing: - Use an i18n-ready address widget such as https:// + # github.com/google/libaddressinput) - Users should not be presented with UI + # elements for input or editing of fields outside countries where that field is + # used. For more guidance on how to use this schema, please see: https://support. + # google.com/business/answer/6397478 + # Corresponds to the JSON property `addressValue` + # @return [Google::Apis::DocumentaiV1beta2::GoogleTypePostalAddress] + attr_accessor :address_value + # Represents a whole or partial calendar date, e.g. a birthday. The time of day # and time zone are either specified elsewhere or are not significant. The date # is relative to the Proleptic Gregorian Calendar. This can represent: * A full @@ -559,6 +616,7 @@ module Google # Update properties of this object def update!(**args) + @address_value = args[:address_value] if args.key?(:address_value) @date_value = args[:date_value] if args.key?(:date_value) @datetime_value = args[:datetime_value] if args.key?(:datetime_value) @money_value = args[:money_value] if args.key?(:money_value) @@ -623,6 +681,11 @@ module Google # @return [Array] attr_accessor :form_fields + # Rendered image contents for this page. + # Corresponds to the JSON property `image` + # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageImage] + attr_accessor :image + # Visual element describing a layout unit on a page. # Corresponds to the JSON property `layout` # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageLayout] @@ -656,6 +719,12 @@ module Google # @return [Array] attr_accessor :tokens + # Transformation matrices that were applied to the original document image to + # produce Page.image. + # Corresponds to the JSON property `transforms` + # @return [Array] + attr_accessor :transforms + # A list of detected non-text visual elements e.g. checkbox, signature etc. on # the page. # Corresponds to the JSON property `visualElements` @@ -672,16 +741,76 @@ module Google @detected_languages = args[:detected_languages] if args.key?(:detected_languages) @dimension = args[:dimension] if args.key?(:dimension) @form_fields = args[:form_fields] if args.key?(:form_fields) + @image = args[:image] if args.key?(:image) @layout = args[:layout] if args.key?(:layout) @lines = args[:lines] if args.key?(:lines) @page_number = args[:page_number] if args.key?(:page_number) @paragraphs = args[:paragraphs] if args.key?(:paragraphs) @tables = args[:tables] if args.key?(:tables) @tokens = args[:tokens] if args.key?(:tokens) + @transforms = args[:transforms] if args.key?(:transforms) @visual_elements = args[:visual_elements] if args.key?(:visual_elements) end end + # Referencing the visual context of the entity in the Document.pages. Page + # anchors can be cross-page, consist of multiple bounding polygons and + # optionally reference specific layout element types. + class GoogleCloudDocumentaiV1beta1DocumentPageAnchor + include Google::Apis::Core::Hashable + + # One or more references to visual page elements + # Corresponds to the JSON property `pageRefs` + # @return [Array] + attr_accessor :page_refs + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @page_refs = args[:page_refs] if args.key?(:page_refs) + end + end + + # Represents a weak reference to a page element within a document. + class GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef + include Google::Apis::Core::Hashable + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingPoly` + # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1BoundingPoly] + attr_accessor :bounding_poly + + # Optional. Deprecated. Use PageRef.bounding_poly instead. + # Corresponds to the JSON property `layoutId` + # @return [String] + attr_accessor :layout_id + + # Optional. The type of the layout element that is being referenced if any. + # Corresponds to the JSON property `layoutType` + # @return [String] + attr_accessor :layout_type + + # Required. Index into the Document.pages element + # Corresponds to the JSON property `page` + # @return [Fixnum] + attr_accessor :page + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) + @layout_id = args[:layout_id] if args.key?(:layout_id) + @layout_type = args[:layout_type] if args.key?(:layout_type) + @page = args[:page] if args.key?(:page) + end + end + # A block has a set of lines (collected into paragraphs) that have a common line- # spacing and orientation. class GoogleCloudDocumentaiV1beta1DocumentPageBlock @@ -697,6 +826,12 @@ module Google # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageLayout] attr_accessor :layout + # Structure to identify provenance relationships between annotations in + # different revisions. + # Corresponds to the JSON property `provenance` + # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentProvenance] + attr_accessor :provenance + def initialize(**args) update!(**args) end @@ -705,6 +840,7 @@ module Google def update!(**args) @detected_languages = args[:detected_languages] if args.key?(:detected_languages) @layout = args[:layout] if args.key?(:layout) + @provenance = args[:provenance] if args.key?(:provenance) end end @@ -789,6 +925,13 @@ module Google # @return [Array] attr_accessor :value_detected_languages + # 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" + # Corresponds to the JSON property `valueType` + # @return [String] + attr_accessor :value_type + def initialize(**args) update!(**args) end @@ -799,6 +942,45 @@ module Google @field_value = args[:field_value] if args.key?(:field_value) @name_detected_languages = args[:name_detected_languages] if args.key?(:name_detected_languages) @value_detected_languages = args[:value_detected_languages] if args.key?(:value_detected_languages) + @value_type = args[:value_type] if args.key?(:value_type) + end + end + + # Rendered image contents for this page. + class GoogleCloudDocumentaiV1beta1DocumentPageImage + include Google::Apis::Core::Hashable + + # Raw byte content of the image. + # Corresponds to the JSON property `content` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :content + + # Height of the image in pixels. + # Corresponds to the JSON property `height` + # @return [Fixnum] + attr_accessor :height + + # Encoding mime type for the image. + # Corresponds to the JSON property `mimeType` + # @return [String] + attr_accessor :mime_type + + # Width of the image in pixels. + # Corresponds to the JSON property `width` + # @return [Fixnum] + attr_accessor :width + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content = args[:content] if args.key?(:content) + @height = args[:height] if args.key?(:height) + @mime_type = args[:mime_type] if args.key?(:mime_type) + @width = args[:width] if args.key?(:width) end end @@ -856,6 +1038,12 @@ module Google # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageLayout] attr_accessor :layout + # Structure to identify provenance relationships between annotations in + # different revisions. + # Corresponds to the JSON property `provenance` + # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentProvenance] + attr_accessor :provenance + def initialize(**args) update!(**args) end @@ -864,6 +1052,49 @@ module Google def update!(**args) @detected_languages = args[:detected_languages] if args.key?(:detected_languages) @layout = args[:layout] if args.key?(:layout) + @provenance = args[:provenance] if args.key?(:provenance) + end + end + + # Representation for transformation matrix, intended to be compatible and used + # with OpenCV format for image manipulation. + class GoogleCloudDocumentaiV1beta1DocumentPageMatrix + include Google::Apis::Core::Hashable + + # Number of columns in the matrix. + # Corresponds to the JSON property `cols` + # @return [Fixnum] + attr_accessor :cols + + # The matrix data. + # Corresponds to the JSON property `data` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :data + + # Number of rows in the matrix. + # Corresponds to the JSON property `rows` + # @return [Fixnum] + attr_accessor :rows + + # This encodes information about what data type the matrix uses. For example, 0 ( + # CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data + # types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/ + # group__core__hal__interface.html + # Corresponds to the JSON property `type` + # @return [Fixnum] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cols = args[:cols] if args.key?(:cols) + @data = args[:data] if args.key?(:data) + @rows = args[:rows] if args.key?(:rows) + @type = args[:type] if args.key?(:type) end end @@ -881,6 +1112,12 @@ module Google # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageLayout] attr_accessor :layout + # Structure to identify provenance relationships between annotations in + # different revisions. + # Corresponds to the JSON property `provenance` + # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentProvenance] + attr_accessor :provenance + def initialize(**args) update!(**args) end @@ -889,6 +1126,7 @@ module Google def update!(**args) @detected_languages = args[:detected_languages] if args.key?(:detected_languages) @layout = args[:layout] if args.key?(:layout) + @provenance = args[:provenance] if args.key?(:provenance) end end @@ -1004,6 +1242,12 @@ module Google # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageLayout] attr_accessor :layout + # Structure to identify provenance relationships between annotations in + # different revisions. + # Corresponds to the JSON property `provenance` + # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentProvenance] + attr_accessor :provenance + def initialize(**args) update!(**args) end @@ -1013,6 +1257,7 @@ module Google @detected_break = args[:detected_break] if args.key?(:detected_break) @detected_languages = args[:detected_languages] if args.key?(:detected_languages) @layout = args[:layout] if args.key?(:layout) + @provenance = args[:provenance] if args.key?(:provenance) end end @@ -1066,6 +1311,148 @@ module Google end end + # Structure to identify provenance relationships between annotations in + # different revisions. + class GoogleCloudDocumentaiV1beta1DocumentProvenance + include Google::Apis::Core::Hashable + + # The Id of this operation. Needs to be unique within the scope of the revision. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # References to the original elements that are replaced. + # Corresponds to the JSON property `parents` + # @return [Array] + attr_accessor :parents + + # The index of the revision that produced this element. + # Corresponds to the JSON property `revision` + # @return [Fixnum] + attr_accessor :revision + + # The type of provenance operation. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @parents = args[:parents] if args.key?(:parents) + @revision = args[:revision] if args.key?(:revision) + @type = args[:type] if args.key?(:type) + end + end + + # Structure for referencing parent provenances. When an element replaces one of + # more other elements parent references identify the elements that are replaced. + class GoogleCloudDocumentaiV1beta1DocumentProvenanceParent + include Google::Apis::Core::Hashable + + # The id of the parent provenance. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # The index of the [Document.revisions] identifying the parent revision. + # Corresponds to the JSON property `revision` + # @return [Fixnum] + attr_accessor :revision + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @revision = args[:revision] if args.key?(:revision) + end + end + + # Contains past or forward revisions of this document. + class GoogleCloudDocumentaiV1beta1DocumentRevision + include Google::Apis::Core::Hashable + + # If the change was made by a person specify the name or id of that person. + # Corresponds to the JSON property `agent` + # @return [String] + attr_accessor :agent + + # The time that the revision was created. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Human Review information of the document. + # Corresponds to the JSON property `humanReview` + # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview] + attr_accessor :human_review + + # Id of the revision. Unique within the context of the document. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # The revisions that this revision is based on. This can include one or more + # parent (when documents are merged.) This field represents the index into the ` + # revisions` field. + # Corresponds to the JSON property `parent` + # @return [Array] + attr_accessor :parent + + # If the annotation was made by processor identify the processor by its resource + # name. + # Corresponds to the JSON property `processor` + # @return [String] + attr_accessor :processor + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @agent = args[:agent] if args.key?(:agent) + @create_time = args[:create_time] if args.key?(:create_time) + @human_review = args[:human_review] if args.key?(:human_review) + @id = args[:id] if args.key?(:id) + @parent = args[:parent] if args.key?(:parent) + @processor = args[:processor] if args.key?(:processor) + end + end + + # Human Review information of the document. + class GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview + include Google::Apis::Core::Hashable + + # Human review state. e.g. `requested`, `succeeded`, `rejected`. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # A message providing more details about the current state of processing. For + # example, the rejection reason when the state is `rejected`. + # Corresponds to the JSON property `stateMessage` + # @return [String] + attr_accessor :state_message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @state = args[:state] if args.key?(:state) + @state_message = args[:state_message] if args.key?(:state_message) + end + end + # For a large document, sharding may be performed to produce several document # shards. Each document shard contains this field to detail which shard it is. class GoogleCloudDocumentaiV1beta1DocumentShardInfo @@ -1275,6 +1662,12 @@ module Google class GoogleCloudDocumentaiV1beta1DocumentTextAnchor include Google::Apis::Core::Hashable + # Contains the content of the text span so that users do not have to look it up + # in the text_segments. + # Corresponds to the JSON property `content` + # @return [String] + attr_accessor :content + # The text segments from the Document.text. # Corresponds to the JSON property `textSegments` # @return [Array] @@ -1286,6 +1679,7 @@ module Google # Update properties of this object def update!(**args) + @content = args[:content] if args.key?(:content) @text_segments = args[:text_segments] if args.key?(:text_segments) end end @@ -1317,6 +1711,37 @@ module Google end end + # This message is used for text changes aka. OCR corrections. + class GoogleCloudDocumentaiV1beta1DocumentTextChange + include Google::Apis::Core::Hashable + + # The text that replaces the text identified in the `text_anchor`. + # Corresponds to the JSON property `changedText` + # @return [String] + attr_accessor :changed_text + + # The history of this annotation. + # Corresponds to the JSON property `provenance` + # @return [Array] + attr_accessor :provenance + + # Text reference indexing into the Document.text. + # Corresponds to the JSON property `textAnchor` + # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentTextAnchor] + attr_accessor :text_anchor + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @changed_text = args[:changed_text] if args.key?(:changed_text) + @provenance = args[:provenance] if args.key?(:provenance) + @text_anchor = args[:text_anchor] if args.key?(:text_anchor) + end + end + # A translation of the text segment. class GoogleCloudDocumentaiV1beta1DocumentTranslation include Google::Apis::Core::Hashable @@ -1327,6 +1752,11 @@ module Google # @return [String] attr_accessor :language_code + # The history of this annotation. + # Corresponds to the JSON property `provenance` + # @return [Array] + attr_accessor :provenance + # Text reference indexing into the Document.text. # Corresponds to the JSON property `textAnchor` # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentTextAnchor] @@ -1344,6 +1774,7 @@ module Google # Update properties of this object def update!(**args) @language_code = args[:language_code] if args.key?(:language_code) + @provenance = args[:provenance] if args.key?(:provenance) @text_anchor = args[:text_anchor] if args.key?(:text_anchor) @translated_text = args[:translated_text] if args.key?(:translated_text) end @@ -1700,6 +2131,11 @@ module Google # @return [Array] attr_accessor :pages + # Revision history of this document. + # Corresponds to the JSON property `revisions` + # @return [Array] + attr_accessor :revisions + # For a large document, sharding may be performed to produce several document # shards. Each document shard contains this field to detail which shard it is. # Corresponds to the JSON property `shardInfo` @@ -1711,6 +2147,13 @@ module Google # @return [String] attr_accessor :text + # 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. + # Corresponds to the JSON property `textChanges` + # @return [Array] + attr_accessor :text_changes + # Styles for the Document.text. # Corresponds to the JSON property `textStyles` # @return [Array] @@ -1743,8 +2186,10 @@ module Google @labels = args[:labels] if args.key?(:labels) @mime_type = args[:mime_type] if args.key?(:mime_type) @pages = args[:pages] if args.key?(:pages) + @revisions = args[:revisions] if args.key?(:revisions) @shard_info = args[:shard_info] if args.key?(:shard_info) @text = args[:text] if args.key?(:text) + @text_changes = args[:text_changes] if args.key?(:text_changes) @text_styles = args[:text_styles] if args.key?(:text_styles) @translations = args[:translations] if args.key?(:translations) @uri = args[:uri] if args.key?(:uri) @@ -1761,6 +2206,12 @@ module Google # @return [Float] attr_accessor :confidence + # Optional. Canonical id. This will be a unique value in the entity list for + # this document. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + # Deprecated. Use `id` field instead. # Corresponds to the JSON property `mentionId` # @return [String] @@ -1776,6 +2227,25 @@ module Google # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue] attr_accessor :normalized_value + # Referencing the visual context of the entity in the Document.pages. Page + # anchors can be cross-page, consist of multiple bounding polygons and + # optionally reference specific layout element types. + # Corresponds to the JSON property `pageAnchor` + # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageAnchor] + attr_accessor :page_anchor + + # Optional. Entities can be nested to form a hierarchical data structure + # representing the content in the document. + # Corresponds to the JSON property `properties` + # @return [Array] + attr_accessor :properties + + # Structure to identify provenance relationships between annotations in + # different revisions. + # Corresponds to the JSON property `provenance` + # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenance] + attr_accessor :provenance + # Optional. Whether the entity will be redacted for de-identification purposes. # Corresponds to the JSON property `redacted` # @return [Boolean] @@ -1799,9 +2269,13 @@ module Google # Update properties of this object def update!(**args) @confidence = args[:confidence] if args.key?(:confidence) + @id = args[:id] if args.key?(:id) @mention_id = args[:mention_id] if args.key?(:mention_id) @mention_text = args[:mention_text] if args.key?(:mention_text) @normalized_value = args[:normalized_value] if args.key?(:normalized_value) + @page_anchor = args[:page_anchor] if args.key?(:page_anchor) + @properties = args[:properties] if args.key?(:properties) + @provenance = args[:provenance] if args.key?(:provenance) @redacted = args[:redacted] if args.key?(:redacted) @text_anchor = args[:text_anchor] if args.key?(:text_anchor) @type = args[:type] if args.key?(:type) @@ -1812,6 +2286,20 @@ module Google class GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue include Google::Apis::Core::Hashable + # Represents a postal address, e.g. for postal delivery or payments addresses. + # Given a postal address, a postal service can deliver items to a premise, P.O. + # Box or similar. It is not intended to model geographical locations (roads, + # towns, mountains). In typical usage an address would be created via user input + # or from importing existing data, depending on the type of process. Advice on + # address input / editing: - Use an i18n-ready address widget such as https:// + # github.com/google/libaddressinput) - Users should not be presented with UI + # elements for input or editing of fields outside countries where that field is + # used. For more guidance on how to use this schema, please see: https://support. + # google.com/business/answer/6397478 + # Corresponds to the JSON property `addressValue` + # @return [Google::Apis::DocumentaiV1beta2::GoogleTypePostalAddress] + attr_accessor :address_value + # Represents a whole or partial calendar date, e.g. a birthday. The time of day # and time zone are either specified elsewhere or are not significant. The date # is relative to the Proleptic Gregorian Calendar. This can represent: * A full @@ -1858,6 +2346,7 @@ module Google # Update properties of this object def update!(**args) + @address_value = args[:address_value] if args.key?(:address_value) @date_value = args[:date_value] if args.key?(:date_value) @datetime_value = args[:datetime_value] if args.key?(:datetime_value) @money_value = args[:money_value] if args.key?(:money_value) @@ -1959,6 +2448,11 @@ module Google # @return [Array] attr_accessor :form_fields + # Rendered image contents for this page. + # Corresponds to the JSON property `image` + # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageImage] + attr_accessor :image + # Visual element describing a layout unit on a page. # Corresponds to the JSON property `layout` # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageLayout] @@ -1992,6 +2486,12 @@ module Google # @return [Array] attr_accessor :tokens + # Transformation matrices that were applied to the original document image to + # produce Page.image. + # Corresponds to the JSON property `transforms` + # @return [Array] + attr_accessor :transforms + # A list of detected non-text visual elements e.g. checkbox, signature etc. on # the page. # Corresponds to the JSON property `visualElements` @@ -2008,16 +2508,76 @@ module Google @detected_languages = args[:detected_languages] if args.key?(:detected_languages) @dimension = args[:dimension] if args.key?(:dimension) @form_fields = args[:form_fields] if args.key?(:form_fields) + @image = args[:image] if args.key?(:image) @layout = args[:layout] if args.key?(:layout) @lines = args[:lines] if args.key?(:lines) @page_number = args[:page_number] if args.key?(:page_number) @paragraphs = args[:paragraphs] if args.key?(:paragraphs) @tables = args[:tables] if args.key?(:tables) @tokens = args[:tokens] if args.key?(:tokens) + @transforms = args[:transforms] if args.key?(:transforms) @visual_elements = args[:visual_elements] if args.key?(:visual_elements) end end + # Referencing the visual context of the entity in the Document.pages. Page + # anchors can be cross-page, consist of multiple bounding polygons and + # optionally reference specific layout element types. + class GoogleCloudDocumentaiV1beta2DocumentPageAnchor + include Google::Apis::Core::Hashable + + # One or more references to visual page elements + # Corresponds to the JSON property `pageRefs` + # @return [Array] + attr_accessor :page_refs + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @page_refs = args[:page_refs] if args.key?(:page_refs) + end + end + + # Represents a weak reference to a page element within a document. + class GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef + include Google::Apis::Core::Hashable + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingPoly` + # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2BoundingPoly] + attr_accessor :bounding_poly + + # Optional. Deprecated. Use PageRef.bounding_poly instead. + # Corresponds to the JSON property `layoutId` + # @return [String] + attr_accessor :layout_id + + # Optional. The type of the layout element that is being referenced if any. + # Corresponds to the JSON property `layoutType` + # @return [String] + attr_accessor :layout_type + + # Required. Index into the Document.pages element + # Corresponds to the JSON property `page` + # @return [Fixnum] + attr_accessor :page + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) + @layout_id = args[:layout_id] if args.key?(:layout_id) + @layout_type = args[:layout_type] if args.key?(:layout_type) + @page = args[:page] if args.key?(:page) + end + end + # A block has a set of lines (collected into paragraphs) that have a common line- # spacing and orientation. class GoogleCloudDocumentaiV1beta2DocumentPageBlock @@ -2033,6 +2593,12 @@ module Google # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageLayout] attr_accessor :layout + # Structure to identify provenance relationships between annotations in + # different revisions. + # Corresponds to the JSON property `provenance` + # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenance] + attr_accessor :provenance + def initialize(**args) update!(**args) end @@ -2041,6 +2607,7 @@ module Google def update!(**args) @detected_languages = args[:detected_languages] if args.key?(:detected_languages) @layout = args[:layout] if args.key?(:layout) + @provenance = args[:provenance] if args.key?(:provenance) end end @@ -2146,6 +2713,44 @@ module Google end end + # Rendered image contents for this page. + class GoogleCloudDocumentaiV1beta2DocumentPageImage + include Google::Apis::Core::Hashable + + # Raw byte content of the image. + # Corresponds to the JSON property `content` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :content + + # Height of the image in pixels. + # Corresponds to the JSON property `height` + # @return [Fixnum] + attr_accessor :height + + # Encoding mime type for the image. + # Corresponds to the JSON property `mimeType` + # @return [String] + attr_accessor :mime_type + + # Width of the image in pixels. + # Corresponds to the JSON property `width` + # @return [Fixnum] + attr_accessor :width + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content = args[:content] if args.key?(:content) + @height = args[:height] if args.key?(:height) + @mime_type = args[:mime_type] if args.key?(:mime_type) + @width = args[:width] if args.key?(:width) + end + end + # Visual element describing a layout unit on a page. class GoogleCloudDocumentaiV1beta2DocumentPageLayout include Google::Apis::Core::Hashable @@ -2200,6 +2805,12 @@ module Google # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageLayout] attr_accessor :layout + # Structure to identify provenance relationships between annotations in + # different revisions. + # Corresponds to the JSON property `provenance` + # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenance] + attr_accessor :provenance + def initialize(**args) update!(**args) end @@ -2208,6 +2819,49 @@ module Google def update!(**args) @detected_languages = args[:detected_languages] if args.key?(:detected_languages) @layout = args[:layout] if args.key?(:layout) + @provenance = args[:provenance] if args.key?(:provenance) + end + end + + # Representation for transformation matrix, intended to be compatible and used + # with OpenCV format for image manipulation. + class GoogleCloudDocumentaiV1beta2DocumentPageMatrix + include Google::Apis::Core::Hashable + + # Number of columns in the matrix. + # Corresponds to the JSON property `cols` + # @return [Fixnum] + attr_accessor :cols + + # The matrix data. + # Corresponds to the JSON property `data` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :data + + # Number of rows in the matrix. + # Corresponds to the JSON property `rows` + # @return [Fixnum] + attr_accessor :rows + + # This encodes information about what data type the matrix uses. For example, 0 ( + # CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data + # types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/ + # group__core__hal__interface.html + # Corresponds to the JSON property `type` + # @return [Fixnum] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cols = args[:cols] if args.key?(:cols) + @data = args[:data] if args.key?(:data) + @rows = args[:rows] if args.key?(:rows) + @type = args[:type] if args.key?(:type) end end @@ -2225,6 +2879,12 @@ module Google # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageLayout] attr_accessor :layout + # Structure to identify provenance relationships between annotations in + # different revisions. + # Corresponds to the JSON property `provenance` + # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenance] + attr_accessor :provenance + def initialize(**args) update!(**args) end @@ -2233,6 +2893,7 @@ module Google def update!(**args) @detected_languages = args[:detected_languages] if args.key?(:detected_languages) @layout = args[:layout] if args.key?(:layout) + @provenance = args[:provenance] if args.key?(:provenance) end end @@ -2348,6 +3009,12 @@ module Google # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageLayout] attr_accessor :layout + # Structure to identify provenance relationships between annotations in + # different revisions. + # Corresponds to the JSON property `provenance` + # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenance] + attr_accessor :provenance + def initialize(**args) update!(**args) end @@ -2357,6 +3024,7 @@ module Google @detected_break = args[:detected_break] if args.key?(:detected_break) @detected_languages = args[:detected_languages] if args.key?(:detected_languages) @layout = args[:layout] if args.key?(:layout) + @provenance = args[:provenance] if args.key?(:provenance) end end @@ -2410,6 +3078,148 @@ module Google end end + # Structure to identify provenance relationships between annotations in + # different revisions. + class GoogleCloudDocumentaiV1beta2DocumentProvenance + include Google::Apis::Core::Hashable + + # The Id of this operation. Needs to be unique within the scope of the revision. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # References to the original elements that are replaced. + # Corresponds to the JSON property `parents` + # @return [Array] + attr_accessor :parents + + # The index of the revision that produced this element. + # Corresponds to the JSON property `revision` + # @return [Fixnum] + attr_accessor :revision + + # The type of provenance operation. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @parents = args[:parents] if args.key?(:parents) + @revision = args[:revision] if args.key?(:revision) + @type = args[:type] if args.key?(:type) + end + end + + # Structure for referencing parent provenances. When an element replaces one of + # more other elements parent references identify the elements that are replaced. + class GoogleCloudDocumentaiV1beta2DocumentProvenanceParent + include Google::Apis::Core::Hashable + + # The id of the parent provenance. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # The index of the [Document.revisions] identifying the parent revision. + # Corresponds to the JSON property `revision` + # @return [Fixnum] + attr_accessor :revision + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @revision = args[:revision] if args.key?(:revision) + end + end + + # Contains past or forward revisions of this document. + class GoogleCloudDocumentaiV1beta2DocumentRevision + include Google::Apis::Core::Hashable + + # If the change was made by a person specify the name or id of that person. + # Corresponds to the JSON property `agent` + # @return [String] + attr_accessor :agent + + # The time that the revision was created. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Human Review information of the document. + # Corresponds to the JSON property `humanReview` + # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview] + attr_accessor :human_review + + # Id of the revision. Unique within the context of the document. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # The revisions that this revision is based on. This can include one or more + # parent (when documents are merged.) This field represents the index into the ` + # revisions` field. + # Corresponds to the JSON property `parent` + # @return [Array] + attr_accessor :parent + + # If the annotation was made by processor identify the processor by its resource + # name. + # Corresponds to the JSON property `processor` + # @return [String] + attr_accessor :processor + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @agent = args[:agent] if args.key?(:agent) + @create_time = args[:create_time] if args.key?(:create_time) + @human_review = args[:human_review] if args.key?(:human_review) + @id = args[:id] if args.key?(:id) + @parent = args[:parent] if args.key?(:parent) + @processor = args[:processor] if args.key?(:processor) + end + end + + # Human Review information of the document. + class GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview + include Google::Apis::Core::Hashable + + # Human review state. e.g. `requested`, `succeeded`, `rejected`. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # A message providing more details about the current state of processing. For + # example, the rejection reason when the state is `rejected`. + # Corresponds to the JSON property `stateMessage` + # @return [String] + attr_accessor :state_message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @state = args[:state] if args.key?(:state) + @state_message = args[:state_message] if args.key?(:state_message) + end + end + # For a large document, sharding may be performed to produce several document # shards. Each document shard contains this field to detail which shard it is. class GoogleCloudDocumentaiV1beta2DocumentShardInfo @@ -2619,6 +3429,12 @@ module Google class GoogleCloudDocumentaiV1beta2DocumentTextAnchor include Google::Apis::Core::Hashable + # Contains the content of the text span so that users do not have to look it up + # in the text_segments. + # Corresponds to the JSON property `content` + # @return [String] + attr_accessor :content + # The text segments from the Document.text. # Corresponds to the JSON property `textSegments` # @return [Array] @@ -2630,6 +3446,7 @@ module Google # Update properties of this object def update!(**args) + @content = args[:content] if args.key?(:content) @text_segments = args[:text_segments] if args.key?(:text_segments) end end @@ -2661,6 +3478,37 @@ module Google end end + # This message is used for text changes aka. OCR corrections. + class GoogleCloudDocumentaiV1beta2DocumentTextChange + include Google::Apis::Core::Hashable + + # The text that replaces the text identified in the `text_anchor`. + # Corresponds to the JSON property `changedText` + # @return [String] + attr_accessor :changed_text + + # The history of this annotation. + # Corresponds to the JSON property `provenance` + # @return [Array] + attr_accessor :provenance + + # Text reference indexing into the Document.text. + # Corresponds to the JSON property `textAnchor` + # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentTextAnchor] + attr_accessor :text_anchor + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @changed_text = args[:changed_text] if args.key?(:changed_text) + @provenance = args[:provenance] if args.key?(:provenance) + @text_anchor = args[:text_anchor] if args.key?(:text_anchor) + end + end + # A translation of the text segment. class GoogleCloudDocumentaiV1beta2DocumentTranslation include Google::Apis::Core::Hashable @@ -2671,6 +3519,11 @@ module Google # @return [String] attr_accessor :language_code + # The history of this annotation. + # Corresponds to the JSON property `provenance` + # @return [Array] + attr_accessor :provenance + # Text reference indexing into the Document.text. # Corresponds to the JSON property `textAnchor` # @return [Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentTextAnchor] @@ -2688,6 +3541,7 @@ module Google # Update properties of this object def update!(**args) @language_code = args[:language_code] if args.key?(:language_code) + @provenance = args[:provenance] if args.key?(:provenance) @text_anchor = args[:text_anchor] if args.key?(:text_anchor) @translated_text = args[:translated_text] if args.key?(:translated_text) end @@ -3217,6 +4071,14 @@ module Google class GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus include Google::Apis::Core::Hashable + # The name of the operation triggered by the processed document. If the human + # review process is not triggered, this field will be empty. It has the same + # response type and metadata as the long running operation returned by + # ReviewDocument method. + # Corresponds to the JSON property `humanReviewOperation` + # @return [String] + attr_accessor :human_review_operation + # The source of the document, same as the [input_gcs_source] field in the # request when the batch process started. The batch process is started by take # snapshot of that document, since a user can move or change that document @@ -3247,6 +4109,7 @@ module Google # Update properties of this object def update!(**args) + @human_review_operation = args[:human_review_operation] if args.key?(:human_review_operation) @input_gcs_source = args[:input_gcs_source] if args.key?(:input_gcs_source) @output_gcs_destination = args[:output_gcs_destination] if args.key?(:output_gcs_destination) @status = args[:status] if args.key?(:status) @@ -3266,6 +4129,63 @@ module Google end end + # The long running operation metadata for review document method. + class GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata + include Google::Apis::Core::Hashable + + # The creation time of the operation. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Used only when Operation.done is false. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # A message providing more details about the current state of processing. For + # example, the error message if the operation is failed. + # Corresponds to the JSON property `stateMessage` + # @return [String] + attr_accessor :state_message + + # The last update time of the operation. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @create_time = args[:create_time] if args.key?(:create_time) + @state = args[:state] if args.key?(:state) + @state_message = args[:state_message] if args.key?(:state_message) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + + # Response message for review document method. + class GoogleCloudDocumentaiV1beta3ReviewDocumentResponse + include Google::Apis::Core::Hashable + + # The Cloud Storage uri for the human reviewed document. + # Corresponds to the JSON property `gcsDestination` + # @return [String] + attr_accessor :gcs_destination + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination) + end + end + # This resource represents a long-running operation that is the result of a # network API call. class GoogleLongrunningOperation @@ -3630,6 +4550,139 @@ module Google end end + # Represents a postal address, e.g. for postal delivery or payments addresses. + # Given a postal address, a postal service can deliver items to a premise, P.O. + # Box or similar. It is not intended to model geographical locations (roads, + # towns, mountains). In typical usage an address would be created via user input + # or from importing existing data, depending on the type of process. Advice on + # address input / editing: - Use an i18n-ready address widget such as https:// + # github.com/google/libaddressinput) - Users should not be presented with UI + # elements for input or editing of fields outside countries where that field is + # used. For more guidance on how to use this schema, please see: https://support. + # google.com/business/answer/6397478 + class GoogleTypePostalAddress + include Google::Apis::Core::Hashable + + # Unstructured address lines describing the lower levels of an address. Because + # values in address_lines do not have type information and may sometimes contain + # multiple values in a single field (e.g. "Austin, TX"), it is important that + # the line order is clear. The order of address lines should be "envelope order" + # for the country/region of the address. In places where this can vary (e.g. + # Japan), address_language is used to make it explicit (e.g. "ja" for large-to- + # small ordering and "ja-Latn" or "en" for small-to-large). This way, the most + # specific line of an address can be selected based on the language. The minimum + # permitted structural representation of an address consists of a region_code + # with all remaining information placed in the address_lines. It would be + # possible to format such an address very approximately without geocoding, but + # no semantic reasoning could be made about any of the address components until + # it was at least partially resolved. Creating an address only containing a + # region_code and address_lines, and then geocoding is the recommended way to + # handle completely unstructured addresses (as opposed to guessing which parts + # of the address should be localities or administrative areas). + # Corresponds to the JSON property `addressLines` + # @return [Array] + attr_accessor :address_lines + + # Optional. Highest administrative subdivision which is used for postal + # addresses of a country or region. For example, this can be a state, a province, + # an oblast, or a prefecture. Specifically, for Spain this is the province and + # not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many + # countries don't use an administrative area in postal addresses. E.g. in + # Switzerland this should be left unpopulated. + # Corresponds to the JSON property `administrativeArea` + # @return [String] + attr_accessor :administrative_area + + # Optional. BCP-47 language code of the contents of this address (if known). + # This is often the UI language of the input form or is expected to match one of + # the languages used in the address' country/region, or their transliterated + # equivalents. This can affect formatting in certain countries, but is not + # critical to the correctness of the data and will never affect any validation + # or other non-formatting related operations. If this value is not known, it + # should be omitted (rather than specifying a possibly incorrect default). + # Examples: "zh-Hant", "ja", "ja-Latn", "en". + # Corresponds to the JSON property `languageCode` + # @return [String] + attr_accessor :language_code + + # Optional. Generally refers to the city/town portion of the address. Examples: + # US city, IT comune, UK post town. In regions of the world where localities are + # not well defined or do not fit into this structure well, leave locality empty + # and use address_lines. + # Corresponds to the JSON property `locality` + # @return [String] + attr_accessor :locality + + # Optional. The name of the organization at the address. + # Corresponds to the JSON property `organization` + # @return [String] + attr_accessor :organization + + # Optional. Postal code of the address. Not all countries use or require postal + # codes to be present, but where they are used, they may trigger additional + # validation with other parts of the address (e.g. state/zip validation in the U. + # S.A.). + # Corresponds to the JSON property `postalCode` + # @return [String] + attr_accessor :postal_code + + # Optional. The recipient at the address. This field may, under certain + # circumstances, contain multiline information. For example, it might contain " + # care of" information. + # Corresponds to the JSON property `recipients` + # @return [Array] + attr_accessor :recipients + + # Required. CLDR region code of the country/region of the address. This is never + # inferred and it is up to the user to ensure the value is correct. See http:// + # cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/ + # territory_information.html for details. Example: "CH" for Switzerland. + # Corresponds to the JSON property `regionCode` + # @return [String] + attr_accessor :region_code + + # The schema revision of the `PostalAddress`. This must be set to 0, which is + # the latest revision. All new revisions **must** be backward compatible with + # old revisions. + # Corresponds to the JSON property `revision` + # @return [Fixnum] + attr_accessor :revision + + # Optional. Additional, country-specific, sorting code. This is not used in most + # regions. Where it is used, the value is either a string like "CEDEX", + # optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, + # representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) + # or "post office indicator" (e.g. Côte d'Ivoire). + # Corresponds to the JSON property `sortingCode` + # @return [String] + attr_accessor :sorting_code + + # Optional. Sublocality of the address. For example, this can be neighborhoods, + # boroughs, districts. + # Corresponds to the JSON property `sublocality` + # @return [String] + attr_accessor :sublocality + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @address_lines = args[:address_lines] if args.key?(:address_lines) + @administrative_area = args[:administrative_area] if args.key?(:administrative_area) + @language_code = args[:language_code] if args.key?(:language_code) + @locality = args[:locality] if args.key?(:locality) + @organization = args[:organization] if args.key?(:organization) + @postal_code = args[:postal_code] if args.key?(:postal_code) + @recipients = args[:recipients] if args.key?(:recipients) + @region_code = args[:region_code] if args.key?(:region_code) + @revision = args[:revision] if args.key?(:revision) + @sorting_code = args[:sorting_code] if args.key?(:sorting_code) + @sublocality = args[:sublocality] if args.key?(:sublocality) + end + end + # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/ # time-zones). class GoogleTypeTimeZone diff --git a/generated/google/apis/documentai_v1beta2/representations.rb b/generated/google/apis/documentai_v1beta2/representations.rb index 9dd756bfb..3c5097438 100644 --- a/generated/google/apis/documentai_v1beta2/representations.rb +++ b/generated/google/apis/documentai_v1beta2/representations.rb @@ -118,6 +118,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiV1beta1DocumentPageAnchor + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiV1beta1DocumentPageBlock class Representation < Google::Apis::Core::JsonRepresentation; end @@ -142,6 +154,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiV1beta1DocumentPageImage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiV1beta1DocumentPageLayout class Representation < Google::Apis::Core::JsonRepresentation; end @@ -154,6 +172,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiV1beta1DocumentPageMatrix + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiV1beta1DocumentPageParagraph class Representation < Google::Apis::Core::JsonRepresentation; end @@ -196,6 +220,30 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiV1beta1DocumentProvenance + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiV1beta1DocumentProvenanceParent + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiV1beta1DocumentRevision + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiV1beta1DocumentShardInfo class Representation < Google::Apis::Core::JsonRepresentation; end @@ -226,6 +274,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiV1beta1DocumentTextChange + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiV1beta1DocumentTranslation class Representation < Google::Apis::Core::JsonRepresentation; end @@ -340,6 +394,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiV1beta2DocumentPageAnchor + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiV1beta2DocumentPageBlock class Representation < Google::Apis::Core::JsonRepresentation; end @@ -364,6 +430,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiV1beta2DocumentPageImage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiV1beta2DocumentPageLayout class Representation < Google::Apis::Core::JsonRepresentation; end @@ -376,6 +448,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiV1beta2DocumentPageMatrix + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiV1beta2DocumentPageParagraph class Representation < Google::Apis::Core::JsonRepresentation; end @@ -418,6 +496,30 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiV1beta2DocumentProvenance + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiV1beta2DocumentProvenanceParent + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiV1beta2DocumentRevision + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiV1beta2DocumentShardInfo class Representation < Google::Apis::Core::JsonRepresentation; end @@ -448,6 +550,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiV1beta2DocumentTextChange + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiV1beta2DocumentTranslation class Representation < Google::Apis::Core::JsonRepresentation; end @@ -562,6 +670,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiV1beta3ReviewDocumentResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleLongrunningOperation class Representation < Google::Apis::Core::JsonRepresentation; end @@ -604,6 +724,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleTypePostalAddress + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleTypeTimeZone class Representation < Google::Apis::Core::JsonRepresentation; end @@ -722,9 +848,13 @@ module Google property :mime_type, as: 'mimeType' collection :pages, as: 'pages', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPage, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPage::Representation + collection :revisions, as: 'revisions', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentRevision, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentRevision::Representation + property :shard_info, as: 'shardInfo', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentShardInfo, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentShardInfo::Representation property :text, as: 'text' + collection :text_changes, as: 'textChanges', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentTextChange, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentTextChange::Representation + collection :text_styles, as: 'textStyles', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentStyle, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentStyle::Representation collection :translations, as: 'translations', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentTranslation, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentTranslation::Representation @@ -737,10 +867,17 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :confidence, as: 'confidence' + property :id, as: 'id' property :mention_id, as: 'mentionId' property :mention_text, as: 'mentionText' property :normalized_value, as: 'normalizedValue', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue::Representation + property :page_anchor, as: 'pageAnchor', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageAnchor, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageAnchor::Representation + + collection :properties, as: 'properties', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentEntity, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentEntity::Representation + + property :provenance, as: 'provenance', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentProvenance, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentProvenance::Representation + property :redacted, as: 'redacted' property :text_anchor, as: 'textAnchor', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentTextAnchor, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentTextAnchor::Representation @@ -751,6 +888,8 @@ module Google class GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue # @private class Representation < Google::Apis::Core::JsonRepresentation + property :address_value, as: 'addressValue', class: Google::Apis::DocumentaiV1beta2::GoogleTypePostalAddress, decorator: Google::Apis::DocumentaiV1beta2::GoogleTypePostalAddress::Representation + property :date_value, as: 'dateValue', class: Google::Apis::DocumentaiV1beta2::GoogleTypeDate, decorator: Google::Apis::DocumentaiV1beta2::GoogleTypeDate::Representation property :datetime_value, as: 'datetimeValue', class: Google::Apis::DocumentaiV1beta2::GoogleTypeDateTime, decorator: Google::Apis::DocumentaiV1beta2::GoogleTypeDateTime::Representation @@ -781,6 +920,8 @@ module Google collection :form_fields, as: 'formFields', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageFormField, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageFormField::Representation + property :image, as: 'image', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageImage, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageImage::Representation + property :layout, as: 'layout', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageLayout, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageLayout::Representation collection :lines, as: 'lines', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageLine, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageLine::Representation @@ -792,11 +933,32 @@ module Google collection :tokens, as: 'tokens', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageToken, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageToken::Representation + collection :transforms, as: 'transforms', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageMatrix, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageMatrix::Representation + collection :visual_elements, as: 'visualElements', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageVisualElement, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageVisualElement::Representation end end + class GoogleCloudDocumentaiV1beta1DocumentPageAnchor + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :page_refs, as: 'pageRefs', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef::Representation + + end + end + + class GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bounding_poly, as: 'boundingPoly', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1BoundingPoly, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1BoundingPoly::Representation + + property :layout_id, as: 'layoutId' + property :layout_type, as: 'layoutType' + property :page, :numeric_string => true, as: 'page' + end + end + class GoogleCloudDocumentaiV1beta1DocumentPageBlock # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -804,6 +966,8 @@ module Google property :layout, as: 'layout', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageLayout, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageLayout::Representation + property :provenance, as: 'provenance', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentProvenance, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentProvenance::Representation + end end @@ -835,6 +999,17 @@ module Google collection :value_detected_languages, as: 'valueDetectedLanguages', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage::Representation + property :value_type, as: 'valueType' + end + end + + class GoogleCloudDocumentaiV1beta1DocumentPageImage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content, :base64 => true, as: 'content' + property :height, as: 'height' + property :mime_type, as: 'mimeType' + property :width, as: 'width' end end @@ -857,6 +1032,18 @@ module Google property :layout, as: 'layout', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageLayout, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageLayout::Representation + property :provenance, as: 'provenance', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentProvenance, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentProvenance::Representation + + end + end + + class GoogleCloudDocumentaiV1beta1DocumentPageMatrix + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cols, as: 'cols' + property :data, :base64 => true, as: 'data' + property :rows, as: 'rows' + property :type, as: 'type' end end @@ -867,6 +1054,8 @@ module Google property :layout, as: 'layout', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageLayout, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageLayout::Representation + property :provenance, as: 'provenance', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentProvenance, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentProvenance::Representation + end end @@ -913,6 +1102,8 @@ module Google property :layout, as: 'layout', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageLayout, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageLayout::Representation + property :provenance, as: 'provenance', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentProvenance, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentProvenance::Representation + end end @@ -934,6 +1125,46 @@ module Google end end + class GoogleCloudDocumentaiV1beta1DocumentProvenance + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + collection :parents, as: 'parents', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentProvenanceParent, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentProvenanceParent::Representation + + property :revision, as: 'revision' + property :type, as: 'type' + end + end + + class GoogleCloudDocumentaiV1beta1DocumentProvenanceParent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + property :revision, as: 'revision' + end + end + + class GoogleCloudDocumentaiV1beta1DocumentRevision + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :agent, as: 'agent' + property :create_time, as: 'createTime' + property :human_review, as: 'humanReview', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview::Representation + + property :id, as: 'id' + collection :parent, as: 'parent' + property :processor, as: 'processor' + end + end + + class GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :state, as: 'state' + property :state_message, as: 'stateMessage' + end + end + class GoogleCloudDocumentaiV1beta1DocumentShardInfo # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -971,6 +1202,7 @@ module Google class GoogleCloudDocumentaiV1beta1DocumentTextAnchor # @private class Representation < Google::Apis::Core::JsonRepresentation + property :content, as: 'content' collection :text_segments, as: 'textSegments', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment::Representation end @@ -984,10 +1216,23 @@ module Google end end + class GoogleCloudDocumentaiV1beta1DocumentTextChange + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :changed_text, as: 'changedText' + collection :provenance, as: 'provenance', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentProvenance, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentProvenance::Representation + + property :text_anchor, as: 'textAnchor', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentTextAnchor, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentTextAnchor::Representation + + end + end + class GoogleCloudDocumentaiV1beta1DocumentTranslation # @private class Representation < Google::Apis::Core::JsonRepresentation property :language_code, as: 'languageCode' + collection :provenance, as: 'provenance', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentProvenance, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentProvenance::Representation + property :text_anchor, as: 'textAnchor', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentTextAnchor, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentTextAnchor::Representation property :translated_text, as: 'translatedText' @@ -1110,9 +1355,13 @@ module Google property :mime_type, as: 'mimeType' collection :pages, as: 'pages', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPage, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPage::Representation + collection :revisions, as: 'revisions', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentRevision, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentRevision::Representation + property :shard_info, as: 'shardInfo', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentShardInfo, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentShardInfo::Representation property :text, as: 'text' + collection :text_changes, as: 'textChanges', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentTextChange, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentTextChange::Representation + collection :text_styles, as: 'textStyles', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentStyle, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentStyle::Representation collection :translations, as: 'translations', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentTranslation, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentTranslation::Representation @@ -1125,10 +1374,17 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :confidence, as: 'confidence' + property :id, as: 'id' property :mention_id, as: 'mentionId' property :mention_text, as: 'mentionText' property :normalized_value, as: 'normalizedValue', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue::Representation + property :page_anchor, as: 'pageAnchor', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageAnchor, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageAnchor::Representation + + collection :properties, as: 'properties', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentEntity, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentEntity::Representation + + property :provenance, as: 'provenance', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenance, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenance::Representation + property :redacted, as: 'redacted' property :text_anchor, as: 'textAnchor', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentTextAnchor, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentTextAnchor::Representation @@ -1139,6 +1395,8 @@ module Google class GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue # @private class Representation < Google::Apis::Core::JsonRepresentation + property :address_value, as: 'addressValue', class: Google::Apis::DocumentaiV1beta2::GoogleTypePostalAddress, decorator: Google::Apis::DocumentaiV1beta2::GoogleTypePostalAddress::Representation + property :date_value, as: 'dateValue', class: Google::Apis::DocumentaiV1beta2::GoogleTypeDate, decorator: Google::Apis::DocumentaiV1beta2::GoogleTypeDate::Representation property :datetime_value, as: 'datetimeValue', class: Google::Apis::DocumentaiV1beta2::GoogleTypeDateTime, decorator: Google::Apis::DocumentaiV1beta2::GoogleTypeDateTime::Representation @@ -1178,6 +1436,8 @@ module Google collection :form_fields, as: 'formFields', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageFormField, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageFormField::Representation + property :image, as: 'image', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageImage, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageImage::Representation + property :layout, as: 'layout', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageLayout, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageLayout::Representation collection :lines, as: 'lines', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageLine, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageLine::Representation @@ -1189,11 +1449,32 @@ module Google collection :tokens, as: 'tokens', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageToken, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageToken::Representation + collection :transforms, as: 'transforms', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageMatrix, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageMatrix::Representation + collection :visual_elements, as: 'visualElements', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageVisualElement, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageVisualElement::Representation end end + class GoogleCloudDocumentaiV1beta2DocumentPageAnchor + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :page_refs, as: 'pageRefs', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef::Representation + + end + end + + class GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bounding_poly, as: 'boundingPoly', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2BoundingPoly, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2BoundingPoly::Representation + + property :layout_id, as: 'layoutId' + property :layout_type, as: 'layoutType' + property :page, :numeric_string => true, as: 'page' + end + end + class GoogleCloudDocumentaiV1beta2DocumentPageBlock # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1201,6 +1482,8 @@ module Google property :layout, as: 'layout', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageLayout, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageLayout::Representation + property :provenance, as: 'provenance', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenance, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenance::Representation + end end @@ -1236,6 +1519,16 @@ module Google end end + class GoogleCloudDocumentaiV1beta2DocumentPageImage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content, :base64 => true, as: 'content' + property :height, as: 'height' + property :mime_type, as: 'mimeType' + property :width, as: 'width' + end + end + class GoogleCloudDocumentaiV1beta2DocumentPageLayout # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1255,6 +1548,18 @@ module Google property :layout, as: 'layout', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageLayout, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageLayout::Representation + property :provenance, as: 'provenance', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenance, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenance::Representation + + end + end + + class GoogleCloudDocumentaiV1beta2DocumentPageMatrix + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cols, as: 'cols' + property :data, :base64 => true, as: 'data' + property :rows, as: 'rows' + property :type, as: 'type' end end @@ -1265,6 +1570,8 @@ module Google property :layout, as: 'layout', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageLayout, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageLayout::Representation + property :provenance, as: 'provenance', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenance, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenance::Representation + end end @@ -1311,6 +1618,8 @@ module Google property :layout, as: 'layout', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageLayout, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentPageLayout::Representation + property :provenance, as: 'provenance', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenance, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenance::Representation + end end @@ -1332,6 +1641,46 @@ module Google end end + class GoogleCloudDocumentaiV1beta2DocumentProvenance + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + collection :parents, as: 'parents', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenanceParent, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenanceParent::Representation + + property :revision, as: 'revision' + property :type, as: 'type' + end + end + + class GoogleCloudDocumentaiV1beta2DocumentProvenanceParent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + property :revision, as: 'revision' + end + end + + class GoogleCloudDocumentaiV1beta2DocumentRevision + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :agent, as: 'agent' + property :create_time, as: 'createTime' + property :human_review, as: 'humanReview', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview::Representation + + property :id, as: 'id' + collection :parent, as: 'parent' + property :processor, as: 'processor' + end + end + + class GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :state, as: 'state' + property :state_message, as: 'stateMessage' + end + end + class GoogleCloudDocumentaiV1beta2DocumentShardInfo # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1369,6 +1718,7 @@ module Google class GoogleCloudDocumentaiV1beta2DocumentTextAnchor # @private class Representation < Google::Apis::Core::JsonRepresentation + property :content, as: 'content' collection :text_segments, as: 'textSegments', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment::Representation end @@ -1382,10 +1732,23 @@ module Google end end + class GoogleCloudDocumentaiV1beta2DocumentTextChange + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :changed_text, as: 'changedText' + collection :provenance, as: 'provenance', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenance, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenance::Representation + + property :text_anchor, as: 'textAnchor', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentTextAnchor, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentTextAnchor::Representation + + end + end + class GoogleCloudDocumentaiV1beta2DocumentTranslation # @private class Representation < Google::Apis::Core::JsonRepresentation property :language_code, as: 'languageCode' + collection :provenance, as: 'provenance', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenance, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenance::Representation + property :text_anchor, as: 'textAnchor', class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentTextAnchor, decorator: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentTextAnchor::Representation property :translated_text, as: 'translatedText' @@ -1551,6 +1914,7 @@ module Google class GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus # @private class Representation < Google::Apis::Core::JsonRepresentation + property :human_review_operation, as: 'humanReviewOperation' property :input_gcs_source, as: 'inputGcsSource' property :output_gcs_destination, as: 'outputGcsDestination' property :status, as: 'status', class: Google::Apis::DocumentaiV1beta2::GoogleRpcStatus, decorator: Google::Apis::DocumentaiV1beta2::GoogleRpcStatus::Representation @@ -1564,6 +1928,23 @@ module Google end end + class GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :create_time, as: 'createTime' + property :state, as: 'state' + property :state_message, as: 'stateMessage' + property :update_time, as: 'updateTime' + end + end + + class GoogleCloudDocumentaiV1beta3ReviewDocumentResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :gcs_destination, as: 'gcsDestination' + end + end + class GoogleLongrunningOperation # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1635,6 +2016,23 @@ module Google end end + class GoogleTypePostalAddress + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :address_lines, as: 'addressLines' + property :administrative_area, as: 'administrativeArea' + property :language_code, as: 'languageCode' + property :locality, as: 'locality' + property :organization, as: 'organization' + property :postal_code, as: 'postalCode' + collection :recipients, as: 'recipients' + property :region_code, as: 'regionCode' + property :revision, as: 'revision' + property :sorting_code, as: 'sortingCode' + property :sublocality, as: 'sublocality' + end + end + class GoogleTypeTimeZone # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/doubleclickbidmanager_v1.rb b/generated/google/apis/doubleclickbidmanager_v1.rb index 27198abda..bcb71eadb 100644 --- a/generated/google/apis/doubleclickbidmanager_v1.rb +++ b/generated/google/apis/doubleclickbidmanager_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/bid-manager/ module DoubleclickbidmanagerV1 VERSION = 'V1' - REVISION = '20200819' + REVISION = '20200827' # View and manage your reports in DoubleClick Bid Manager AUTH_DOUBLECLICKBIDMANAGER = 'https://www.googleapis.com/auth/doubleclickbidmanager' diff --git a/generated/google/apis/doubleclickbidmanager_v1/classes.rb b/generated/google/apis/doubleclickbidmanager_v1/classes.rb index 612104a03..d8b3495d8 100644 --- a/generated/google/apis/doubleclickbidmanager_v1/classes.rb +++ b/generated/google/apis/doubleclickbidmanager_v1/classes.rb @@ -461,8 +461,7 @@ module Google # @return [String] attr_accessor :frequency - # Time of day at which a new report will be generated, represented as minutes - # past midnight. Range is 0 to 1439. Only applies to scheduled reports. + # Deprecated. This field has no effect. # Corresponds to the JSON property `nextRunMinuteOfDay` # @return [Fixnum] attr_accessor :next_run_minute_of_day diff --git a/generated/google/apis/doubleclickbidmanager_v1_1.rb b/generated/google/apis/doubleclickbidmanager_v1_1.rb index d952a279e..e51326ffc 100644 --- a/generated/google/apis/doubleclickbidmanager_v1_1.rb +++ b/generated/google/apis/doubleclickbidmanager_v1_1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/bid-manager/ module DoubleclickbidmanagerV1_1 VERSION = 'V1_1' - REVISION = '20200819' + REVISION = '20200827' # View and manage your reports in DoubleClick Bid Manager AUTH_DOUBLECLICKBIDMANAGER = 'https://www.googleapis.com/auth/doubleclickbidmanager' diff --git a/generated/google/apis/doubleclickbidmanager_v1_1/classes.rb b/generated/google/apis/doubleclickbidmanager_v1_1/classes.rb index fc2206d00..1864d050b 100644 --- a/generated/google/apis/doubleclickbidmanager_v1_1/classes.rb +++ b/generated/google/apis/doubleclickbidmanager_v1_1/classes.rb @@ -668,8 +668,7 @@ module Google # @return [String] attr_accessor :frequency - # Time of day at which a new report will be generated, represented as minutes - # past midnight. Range is 0 to 1439. Only applies to scheduled reports. + # Deprecated. This field has no effect. # Corresponds to the JSON property `nextRunMinuteOfDay` # @return [Fixnum] attr_accessor :next_run_minute_of_day diff --git a/generated/google/apis/firebase_v1beta1.rb b/generated/google/apis/firebase_v1beta1.rb index b1ac6773d..884e6e8e6 100644 --- a/generated/google/apis/firebase_v1beta1.rb +++ b/generated/google/apis/firebase_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://firebase.google.com module FirebaseV1beta1 VERSION = 'V1beta1' - REVISION = '20200822' + REVISION = '20200911' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/firebase_v1beta1/classes.rb b/generated/google/apis/firebase_v1beta1/classes.rb index 5bc223cfa..e3b40f1af 100644 --- a/generated/google/apis/firebase_v1beta1/classes.rb +++ b/generated/google/apis/firebase_v1beta1/classes.rb @@ -1250,13 +1250,17 @@ module Google attr_accessor :location_id # The unique Google-assigned identifier of the Google Analytics web stream - # associated with the Firebase Web App. Firebase SDKs use this ID to interact - # with Google Analytics APIs. This field is only present if the App is linked to + # associated with the `WebApp`. Firebase SDKs use this ID to interact with + # Google Analytics APIs. This field is only present if the `WebApp` is linked to # a web stream in a Google Analytics App + Web property. Learn more about this # ID and Google Analytics web streams in the [Analytics documentation](https:// # support.google.com/analytics/topic/9303475). To generate a `measurementId` and - # link the Web App with a Google Analytics web stream, call [`AddGoogleAnalytics` - # ](../../v1beta1/projects/addGoogleAnalytics). + # link the `WebApp` with a Google Analytics web stream, call [` + # AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics). For apps + # using the Firebase JavaScript SDK v7.20.0 and later, Firebase dynamically + # fetches the `measurementId` when your app initializes Analytics. Having this + # ID in your config object is optional, but it does serve as a fallback in the + # rare case that the dynamic fetch fails. # Corresponds to the JSON property `measurementId` # @return [String] attr_accessor :measurement_id diff --git a/generated/google/apis/firebasedynamiclinks_v1.rb b/generated/google/apis/firebasedynamiclinks_v1.rb index e3da07f4b..6fee15f9f 100644 --- a/generated/google/apis/firebasedynamiclinks_v1.rb +++ b/generated/google/apis/firebasedynamiclinks_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://firebase.google.com/docs/dynamic-links/ module FirebasedynamiclinksV1 VERSION = 'V1' - REVISION = '20200803' + REVISION = '20200905' # View and administer all your Firebase data and settings AUTH_FIREBASE = 'https://www.googleapis.com/auth/firebase' diff --git a/generated/google/apis/firebasehosting_v1beta1.rb b/generated/google/apis/firebasehosting_v1beta1.rb index 4a890799f..2912dc72a 100644 --- a/generated/google/apis/firebasehosting_v1beta1.rb +++ b/generated/google/apis/firebasehosting_v1beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://firebase.google.com/docs/hosting/ module FirebasehostingV1beta1 VERSION = 'V1beta1' - REVISION = '20200811' + REVISION = '20200901' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/firebasehosting_v1beta1/classes.rb b/generated/google/apis/firebasehosting_v1beta1/classes.rb index ca80f65f1..57ad93754 100644 --- a/generated/google/apis/firebasehosting_v1beta1/classes.rb +++ b/generated/google/apis/firebasehosting_v1beta1/classes.rb @@ -102,6 +102,120 @@ module Google end end + # A `Channel` represents a stream of releases for a site. All sites have a + # default `live` channel that serves content to the live Firebase-provided + # domains and any connected custom domains. + class Channel + include Google::Apis::Core::Hashable + + # Output only. The time at which the channel was created. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # The time at which the channel will be automatically deleted. If null, the + # channel will not be automatically deleted. This field is present in output + # whether set directly or via the `ttl` field. + # Corresponds to the JSON property `expireTime` + # @return [String] + attr_accessor :expire_time + + # Text labels used for extra metadata and/or filtering. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # The fully-qualified identifier of the Channel. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # A `Release` is a particular [collection of configurations and files](sites. + # versions) that is set to be public at a particular time. + # Corresponds to the JSON property `release` + # @return [Google::Apis::FirebasehostingV1beta1::Release] + attr_accessor :release + + # The number of previous releases to retain on the channel for rollback or other + # purposes. Must be a number between 1-100. Defaults to 10 for new channels. + # Corresponds to the JSON property `retainedReleaseCount` + # @return [Fixnum] + attr_accessor :retained_release_count + + # Input only. A time-to-live for this channel. Sets `expire_time` to the + # provided duration past the time of the request. + # Corresponds to the JSON property `ttl` + # @return [String] + attr_accessor :ttl + + # Output only. The time at which the channel was last updated. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + + # Output only. The URL at which the channel can be viewed. For the `live` + # channel, the content of the current release may also be visible at other URLs. + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @create_time = args[:create_time] if args.key?(:create_time) + @expire_time = args[:expire_time] if args.key?(:expire_time) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + @release = args[:release] if args.key?(:release) + @retained_release_count = args[:retained_release_count] if args.key?(:retained_release_count) + @ttl = args[:ttl] if args.key?(:ttl) + @update_time = args[:update_time] if args.key?(:update_time) + @url = args[:url] if args.key?(:url) + end + end + + # The request sent to CloneVersion. + class CloneVersionRequest + include Google::Apis::Core::Hashable + + # A representation of filter path. + # Corresponds to the JSON property `exclude` + # @return [Google::Apis::FirebasehostingV1beta1::PathFilter] + attr_accessor :exclude + + # If true, immediately finalize the version after cloning is complete. + # Corresponds to the JSON property `finalize` + # @return [Boolean] + attr_accessor :finalize + alias_method :finalize?, :finalize + + # A representation of filter path. + # Corresponds to the JSON property `include` + # @return [Google::Apis::FirebasehostingV1beta1::PathFilter] + attr_accessor :include + + # Required. The name of the version to be cloned, in the format: `sites/`site`/ + # versions/`version`` + # Corresponds to the JSON property `sourceVersion` + # @return [String] + attr_accessor :source_version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @exclude = args[:exclude] if args.key?(:exclude) + @finalize = args[:finalize] if args.key?(:finalize) + @include = args[:include] if args.key?(:include) + @source_version = args[:source_version] if args.key?(:source_version) + end + end + # A configured rewrite that directs requests to a Cloud Run service. If the # Cloud Run service does not exist when setting or updating your Firebase # Hosting configuration, then the request fails. Any errors from the Cloud Run @@ -344,6 +458,33 @@ module Google end end + # The response returned by ListChannels. + class ListChannelsResponse + include Google::Apis::Core::Hashable + + # The list of channels. + # Corresponds to the JSON property `channels` + # @return [Array] + attr_accessor :channels + + # If there are additional releases remaining beyond the ones in this response, + # then supply this token in the next [`list`](../sites.channels/list) call to + # continue with the next set of releases. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @channels = args[:channels] if args.key?(:channels) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + # The response to listing Domains. class ListDomainsResponse include Google::Apis::Core::Hashable @@ -508,6 +649,25 @@ module Google end end + # A representation of filter path. + class PathFilter + include Google::Apis::Core::Hashable + + # An array of regexes to filter by. + # Corresponds to the JSON property `regexes` + # @return [Array] + attr_accessor :regexes + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @regexes = args[:regexes] if args.key?(:regexes) + end + end + # The request to populate a Version's Files. class PopulateVersionFilesRequest include Google::Apis::Core::Hashable diff --git a/generated/google/apis/firebasehosting_v1beta1/representations.rb b/generated/google/apis/firebasehosting_v1beta1/representations.rb index 4b968a77e..7c94fd021 100644 --- a/generated/google/apis/firebasehosting_v1beta1/representations.rb +++ b/generated/google/apis/firebasehosting_v1beta1/representations.rb @@ -40,6 +40,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Channel + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CloneVersionRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class CloudRunRewrite class Representation < Google::Apis::Core::JsonRepresentation; end @@ -82,6 +94,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ListChannelsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ListDomainsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -112,6 +130,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class PathFilter + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class PopulateVersionFilesRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -202,6 +226,34 @@ module Google end end + class Channel + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :create_time, as: 'createTime' + property :expire_time, as: 'expireTime' + hash :labels, as: 'labels' + property :name, as: 'name' + property :release, as: 'release', class: Google::Apis::FirebasehostingV1beta1::Release, decorator: Google::Apis::FirebasehostingV1beta1::Release::Representation + + property :retained_release_count, as: 'retainedReleaseCount' + property :ttl, as: 'ttl' + property :update_time, as: 'updateTime' + property :url, as: 'url' + end + end + + class CloneVersionRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :exclude, as: 'exclude', class: Google::Apis::FirebasehostingV1beta1::PathFilter, decorator: Google::Apis::FirebasehostingV1beta1::PathFilter::Representation + + property :finalize, as: 'finalize' + property :include, as: 'include', class: Google::Apis::FirebasehostingV1beta1::PathFilter, decorator: Google::Apis::FirebasehostingV1beta1::PathFilter::Representation + + property :source_version, as: 'sourceVersion' + end + end + class CloudRunRewrite # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -270,6 +322,15 @@ module Google end end + class ListChannelsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :channels, as: 'channels', class: Google::Apis::FirebasehostingV1beta1::Channel, decorator: Google::Apis::FirebasehostingV1beta1::Channel::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + class ListDomainsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -318,6 +379,13 @@ module Google end end + class PathFilter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :regexes, as: 'regexes' + end + end + class PopulateVersionFilesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/firebasehosting_v1beta1/service.rb b/generated/google/apis/firebasehosting_v1beta1/service.rb index aee5b5c71..d5d4ef7d6 100644 --- a/generated/google/apis/firebasehosting_v1beta1/service.rb +++ b/generated/google/apis/firebasehosting_v1beta1/service.rb @@ -151,6 +151,178 @@ module Google execute_or_queue_command(command, &block) end + # Creates a new channel in the specified site. + # @param [String] parent + # Required. The site in which this channel should be created. + # @param [Google::Apis::FirebasehostingV1beta1::Channel] channel_object + # @param [String] channel_id + # Required. Immutable. A unique id within the site to identify the channel. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Channel] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::Channel] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_site_channel(parent, channel_object = nil, channel_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+parent}/channels', options) + command.request_representation = Google::Apis::FirebasehostingV1beta1::Channel::Representation + command.request_object = channel_object + command.response_representation = Google::Apis::FirebasehostingV1beta1::Channel::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::Channel + command.params['parent'] = parent unless parent.nil? + command.query['channelId'] = channel_id unless channel_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a channel of a site. The `live` channel cannot be deleted. + # @param [String] name + # Required. The fully-qualified identifier for the site. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_site_channel(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::FirebasehostingV1beta1::Empty::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves information for the specified channel of a site. + # @param [String] name + # Required. The fully-qualified identifier for the channel. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Channel] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::Channel] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_site_channel(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::FirebasehostingV1beta1::Channel::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::Channel + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the channels for the specified site. All sites have a default "live" + # channel. + # @param [String] parent + # Required. The site from which to list channels. + # @param [Fixnum] page_size + # The maximum number of versions to return. The service may return fewer than + # this value. If unspecified, at most 25 channels will be returned. The maximum + # value is 100; valuupdateses above 100 will be coerced to 100 + # @param [String] page_token + # The next_page_token from a previous request, if provided. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::ListChannelsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::ListChannelsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_site_channels(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+parent}/channels', options) + command.response_representation = Google::Apis::FirebasehostingV1beta1::ListChannelsResponse::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::ListChannelsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates information for the specified channel of a site. This method will + # implicitly create a channel if it doesn't exist. + # @param [String] name + # The fully-qualified identifier of the Channel. + # @param [Google::Apis::FirebasehostingV1beta1::Channel] channel_object + # @param [String] update_mask + # A comma-separated list of fields to be updated in this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Channel] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::Channel] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_site_channel(name, channel_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta1/{+name}', options) + command.request_representation = Google::Apis::FirebasehostingV1beta1::Channel::Representation + command.request_object = channel_object + command.response_representation = Google::Apis::FirebasehostingV1beta1::Channel::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::Channel + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a new release which makes the content of the specified version # actively display on the appropriate URL(s). # @param [String] parent @@ -471,6 +643,41 @@ module Google execute_or_queue_command(command, &block) end + # Creates a new version on the target site using the content of the specified + # version. + # @param [String] parent + # Required. The target site where the cloned version will reside, in the format: + # `sites/`site`` + # @param [Google::Apis::FirebasehostingV1beta1::CloneVersionRequest] clone_version_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def clone_project_site_version(parent, clone_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+parent}/versions:clone', options) + command.request_representation = Google::Apis::FirebasehostingV1beta1::CloneVersionRequest::Representation + command.request_object = clone_version_request_object + command.response_representation = Google::Apis::FirebasehostingV1beta1::Operation::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a new version for a site. # @param [String] parent # Required. The parent to create the version for, in the format: sites/ site- @@ -779,6 +986,178 @@ module Google execute_or_queue_command(command, &block) end + # Creates a new channel in the specified site. + # @param [String] parent + # Required. The site in which this channel should be created. + # @param [Google::Apis::FirebasehostingV1beta1::Channel] channel_object + # @param [String] channel_id + # Required. Immutable. A unique id within the site to identify the channel. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Channel] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::Channel] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_site_channel(parent, channel_object = nil, channel_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+parent}/channels', options) + command.request_representation = Google::Apis::FirebasehostingV1beta1::Channel::Representation + command.request_object = channel_object + command.response_representation = Google::Apis::FirebasehostingV1beta1::Channel::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::Channel + command.params['parent'] = parent unless parent.nil? + command.query['channelId'] = channel_id unless channel_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a channel of a site. The `live` channel cannot be deleted. + # @param [String] name + # Required. The fully-qualified identifier for the site. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_site_channel(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::FirebasehostingV1beta1::Empty::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves information for the specified channel of a site. + # @param [String] name + # Required. The fully-qualified identifier for the channel. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Channel] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::Channel] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_site_channel(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::FirebasehostingV1beta1::Channel::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::Channel + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the channels for the specified site. All sites have a default "live" + # channel. + # @param [String] parent + # Required. The site from which to list channels. + # @param [Fixnum] page_size + # The maximum number of versions to return. The service may return fewer than + # this value. If unspecified, at most 25 channels will be returned. The maximum + # value is 100; valuupdateses above 100 will be coerced to 100 + # @param [String] page_token + # The next_page_token from a previous request, if provided. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::ListChannelsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::ListChannelsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_site_channels(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+parent}/channels', options) + command.response_representation = Google::Apis::FirebasehostingV1beta1::ListChannelsResponse::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::ListChannelsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates information for the specified channel of a site. This method will + # implicitly create a channel if it doesn't exist. + # @param [String] name + # The fully-qualified identifier of the Channel. + # @param [Google::Apis::FirebasehostingV1beta1::Channel] channel_object + # @param [String] update_mask + # A comma-separated list of fields to be updated in this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Channel] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::Channel] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_site_channel(name, channel_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta1/{+name}', options) + command.request_representation = Google::Apis::FirebasehostingV1beta1::Channel::Representation + command.request_object = channel_object + command.response_representation = Google::Apis::FirebasehostingV1beta1::Channel::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::Channel + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a new release which makes the content of the specified version # actively display on the appropriate URL(s). # @param [String] parent @@ -1099,6 +1478,41 @@ module Google execute_or_queue_command(command, &block) end + # Creates a new version on the target site using the content of the specified + # version. + # @param [String] parent + # Required. The target site where the cloned version will reside, in the format: + # `sites/`site`` + # @param [Google::Apis::FirebasehostingV1beta1::CloneVersionRequest] clone_version_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def clone_site_version(parent, clone_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+parent}/versions:clone', options) + command.request_representation = Google::Apis::FirebasehostingV1beta1::CloneVersionRequest::Representation + command.request_object = clone_version_request_object + command.response_representation = Google::Apis::FirebasehostingV1beta1::Operation::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a new version for a site. # @param [String] parent # Required. The parent to create the version for, in the format: sites/ site- diff --git a/generated/google/apis/firebaseml_v1beta2.rb b/generated/google/apis/firebaseml_v1beta2.rb index e56095f64..b87d857aa 100644 --- a/generated/google/apis/firebaseml_v1beta2.rb +++ b/generated/google/apis/firebaseml_v1beta2.rb @@ -25,7 +25,7 @@ module Google # @see https://firebase.google.com module FirebasemlV1beta2 VERSION = 'V1beta2' - REVISION = '20200814' + REVISION = '20200905' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/firebaseml_v1beta2/classes.rb b/generated/google/apis/firebaseml_v1beta2/classes.rb index f64aa82bd..68b7a2577 100644 --- a/generated/google/apis/firebaseml_v1beta2/classes.rb +++ b/generated/google/apis/firebaseml_v1beta2/classes.rb @@ -307,6 +307,13 @@ module Google class TfLiteModel include Google::Apis::Core::Hashable + # The AutoML model id referencing a model you created with the AutoML API. The + # name should have format 'projects//locations//models/' (This is the model + # resource name returned from the AutoML API) + # Corresponds to the JSON property `automlModel` + # @return [String] + attr_accessor :automl_model + # The TfLite file containing the model. (Stored in Google Cloud). The # gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite Note: If # you update the file in the original location, it is necessary to call @@ -326,6 +333,7 @@ module Google # Update properties of this object def update!(**args) + @automl_model = args[:automl_model] if args.key?(:automl_model) @gcs_tflite_uri = args[:gcs_tflite_uri] if args.key?(:gcs_tflite_uri) @size_bytes = args[:size_bytes] if args.key?(:size_bytes) end diff --git a/generated/google/apis/firebaseml_v1beta2/representations.rb b/generated/google/apis/firebaseml_v1beta2/representations.rb index 12450f4dd..137be7a9f 100644 --- a/generated/google/apis/firebaseml_v1beta2/representations.rb +++ b/generated/google/apis/firebaseml_v1beta2/representations.rb @@ -145,6 +145,7 @@ module Google class TfLiteModel # @private class Representation < Google::Apis::Core::JsonRepresentation + property :automl_model, as: 'automlModel' property :gcs_tflite_uri, as: 'gcsTfliteUri' property :size_bytes, as: 'sizeBytes' end diff --git a/generated/google/apis/firestore_v1.rb b/generated/google/apis/firestore_v1.rb index d075d912a..6ff837aa1 100644 --- a/generated/google/apis/firestore_v1.rb +++ b/generated/google/apis/firestore_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/firestore module FirestoreV1 VERSION = 'V1' - REVISION = '20200818' + REVISION = '20200821' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/firestore_v1beta1.rb b/generated/google/apis/firestore_v1beta1.rb index 73a04d8e2..c86e0c12f 100644 --- a/generated/google/apis/firestore_v1beta1.rb +++ b/generated/google/apis/firestore_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/firestore module FirestoreV1beta1 VERSION = 'V1beta1' - REVISION = '20200818' + REVISION = '20200822' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/fitness_v1.rb b/generated/google/apis/fitness_v1.rb index cae4a4f5b..3064345a0 100644 --- a/generated/google/apis/fitness_v1.rb +++ b/generated/google/apis/fitness_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/fit/rest/v1/get-started module FitnessV1 VERSION = 'V1' - REVISION = '20200825' + REVISION = '20200907' # Use Google Fit to see and store your physical activity data AUTH_FITNESS_ACTIVITY_READ = 'https://www.googleapis.com/auth/fitness.activity.read' @@ -75,10 +75,10 @@ module Google # See and add info about your oxygen saturation in Google Fit. I consent to Google sharing my oxygen saturation information with this app. AUTH_FITNESS_OXYGEN_SATURATION_WRITE = 'https://www.googleapis.com/auth/fitness.oxygen_saturation.write' - # See info about your reproductive health in Google Fit. I consent to Google sharing my reporductive health information with this app. + # See info about your reproductive health in Google Fit. I consent to Google sharing my reproductive health information with this app. AUTH_FITNESS_REPRODUCTIVE_HEALTH_READ = 'https://www.googleapis.com/auth/fitness.reproductive_health.read' - # See and add info about your reproductive health in Google Fit. I consent to Google sharing my reporductive health information with this app. + # See and add info about your reproductive health in Google Fit. I consent to Google sharing my reproductive health information with this app. AUTH_FITNESS_REPRODUCTIVE_HEALTH_WRITE = 'https://www.googleapis.com/auth/fitness.reproductive_health.write' end end diff --git a/generated/google/apis/fitness_v1/classes.rb b/generated/google/apis/fitness_v1/classes.rb index 1cf91f242..12359295f 100644 --- a/generated/google/apis/fitness_v1/classes.rb +++ b/generated/google/apis/fitness_v1/classes.rb @@ -120,7 +120,7 @@ module Google # @return [Array] attr_accessor :aggregate_by - # Specifies that data be aggregated each activity segment recored for a user. + # Specifies that data be aggregated each activity segment recorded for a user. # Similar to bucketByActivitySegment, but bucketing is done for each activity # segment rather than all segments of the same type. Mutually exclusive of other # bucketing specifications. @@ -639,10 +639,10 @@ module Google # @return [String] attr_accessor :next_page_token - # A partial list of data points contained in the dataset, ordered by largest - # endTimeNanos first. This list is considered complete when retrieving a small - # dataset and partial when patching a dataset or retrieving a dataset that is - # too large to include in a single response. + # A partial list of data points contained in the dataset, ordered by + # endTimeNanos. This list is considered complete when retrieving a small dataset + # and partial when patching a dataset or retrieving a dataset that is too large + # to include in a single response. # Corresponds to the JSON property `point` # @return [Array] attr_accessor :point diff --git a/generated/google/apis/games_v1.rb b/generated/google/apis/games_v1.rb index a7ea6e10e..3c7cb557d 100644 --- a/generated/google/apis/games_v1.rb +++ b/generated/google/apis/games_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/games/ module GamesV1 VERSION = 'V1' - REVISION = '20200811' + REVISION = '20200826' # View and manage its own configuration data in your Google Drive AUTH_DRIVE_APPDATA = 'https://www.googleapis.com/auth/drive.appdata' diff --git a/generated/google/apis/gameservices_v1.rb b/generated/google/apis/gameservices_v1.rb index 195103fab..d15134063 100644 --- a/generated/google/apis/gameservices_v1.rb +++ b/generated/google/apis/gameservices_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/solutions/gaming/ module GameservicesV1 VERSION = 'V1' - REVISION = '20200730' + REVISION = '20200827' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/gameservices_v1/classes.rb b/generated/google/apis/gameservices_v1/classes.rb index 4f5b8e92e..042a87c36 100644 --- a/generated/google/apis/gameservices_v1/classes.rb +++ b/generated/google/apis/gameservices_v1/classes.rb @@ -129,6 +129,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: @@ -190,6 +196,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) diff --git a/generated/google/apis/gameservices_v1/representations.rb b/generated/google/apis/gameservices_v1/representations.rb index ea1c15b55..b11dfcc41 100644 --- a/generated/google/apis/gameservices_v1/representations.rb +++ b/generated/google/apis/gameservices_v1/representations.rb @@ -411,6 +411,7 @@ module Google class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::GameservicesV1::Expr, decorator: Google::Apis::GameservicesV1::Expr::Representation collection :members, as: 'members' diff --git a/generated/google/apis/gameservices_v1beta.rb b/generated/google/apis/gameservices_v1beta.rb index b97cf3f55..f909484bc 100644 --- a/generated/google/apis/gameservices_v1beta.rb +++ b/generated/google/apis/gameservices_v1beta.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/solutions/gaming/ module GameservicesV1beta VERSION = 'V1beta' - REVISION = '20200730' + REVISION = '20200827' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/gameservices_v1beta/classes.rb b/generated/google/apis/gameservices_v1beta/classes.rb index 96111d323..ff5d64c72 100644 --- a/generated/google/apis/gameservices_v1beta/classes.rb +++ b/generated/google/apis/gameservices_v1beta/classes.rb @@ -129,6 +129,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: @@ -190,6 +196,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) diff --git a/generated/google/apis/gameservices_v1beta/representations.rb b/generated/google/apis/gameservices_v1beta/representations.rb index d6b2aca91..1a9e6d76a 100644 --- a/generated/google/apis/gameservices_v1beta/representations.rb +++ b/generated/google/apis/gameservices_v1beta/representations.rb @@ -411,6 +411,7 @@ module Google class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::GameservicesV1beta::Expr, decorator: Google::Apis::GameservicesV1beta::Expr::Representation collection :members, as: 'members' diff --git a/generated/google/apis/healthcare_v1.rb b/generated/google/apis/healthcare_v1.rb index 9086f64a5..30443ecc1 100644 --- a/generated/google/apis/healthcare_v1.rb +++ b/generated/google/apis/healthcare_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/healthcare module HealthcareV1 VERSION = 'V1' - REVISION = '20200819' + REVISION = '20200901' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/healthcare_v1/classes.rb b/generated/google/apis/healthcare_v1/classes.rb index 66eb9f258..5986db8c5 100644 --- a/generated/google/apis/healthcare_v1/classes.rb +++ b/generated/google/apis/healthcare_v1/classes.rb @@ -1581,6 +1581,31 @@ module Google end end + # The response message for Locations.ListLocations. + class ListLocationsResponse + include Google::Apis::Core::Hashable + + # A list of locations that matches the specified filter in the request. + # Corresponds to the JSON property `locations` + # @return [Array] + attr_accessor :locations + + # The standard List next-page token. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @locations = args[:locations] if args.key?(:locations) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + # Lists the messages in the specified HL7v2 store. class ListMessagesResponse include Google::Apis::Core::Hashable @@ -1633,6 +1658,53 @@ module Google end end + # A resource that represents Google Cloud Platform location. + class Location + include Google::Apis::Core::Hashable + + # The friendly name for this location, typically a nearby city name. For example, + # "Tokyo". + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Cross-service attributes for the location. For example `"cloud.googleapis.com/ + # region": "us-east1"` + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # The canonical id for this location. For example: `"us-east1"`. + # Corresponds to the JSON property `locationId` + # @return [String] + attr_accessor :location_id + + # Service-specific metadata. For example the available capacity at the given + # location. + # Corresponds to the JSON property `metadata` + # @return [Hash] + attr_accessor :metadata + + # Resource name for the location, which may vary between implementations. For + # example: `"projects/example-project/locations/us-east1"` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + @labels = args[:labels] if args.key?(:labels) + @location_id = args[:location_id] if args.key?(:location_id) + @metadata = args[:metadata] if args.key?(:metadata) + @name = args[:name] if args.key?(:name) + end + end + # A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7. # org/implement/standards/index.cfm?ref=common) for details on the standard. class Message diff --git a/generated/google/apis/healthcare_v1/representations.rb b/generated/google/apis/healthcare_v1/representations.rb index 920766374..04433df43 100644 --- a/generated/google/apis/healthcare_v1/representations.rb +++ b/generated/google/apis/healthcare_v1/representations.rb @@ -322,6 +322,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ListLocationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ListMessagesResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -334,6 +340,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Location + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Message class Representation < Google::Apis::Core::JsonRepresentation; end @@ -899,6 +911,15 @@ module Google end end + class ListLocationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :locations, as: 'locations', class: Google::Apis::HealthcareV1::Location, decorator: Google::Apis::HealthcareV1::Location::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + class ListMessagesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -917,6 +938,17 @@ module Google end end + class Location + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + hash :labels, as: 'labels' + property :location_id, as: 'locationId' + hash :metadata, as: 'metadata' + property :name, as: 'name' + end + end + class Message # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/healthcare_v1/service.rb b/generated/google/apis/healthcare_v1/service.rb index 177a8d89b..715d6e26a 100644 --- a/generated/google/apis/healthcare_v1/service.rb +++ b/generated/google/apis/healthcare_v1/service.rb @@ -47,6 +47,75 @@ module Google @batch_path = 'batch' end + # Gets information about a location. + # @param [String] name + # Resource name for the location. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Location] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Location] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1::Location::Representation + command.response_class = Google::Apis::HealthcareV1::Location + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists information about the supported locations for this service. + # @param [String] name + # The resource that owns the locations collection, if applicable. + # @param [String] filter + # The standard list filter. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] page_token + # The standard list page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::ListLocationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::ListLocationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}/locations', options) + command.response_representation = Google::Apis::HealthcareV1::ListLocationsResponse::Representation + command.response_class = Google::Apis::HealthcareV1::ListLocationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a new health dataset. Results are returned through the Operation # interface which returns either an `Operation.response` which contains a # Dataset or `Operation.error`. The metadata field type is OperationMetadata. A @@ -724,7 +793,12 @@ module Google # SearchForInstances returns a list of matching instances. See [Search # Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18. - # html#sect_10.6). + # html#sect_10.6). For details on the implementation of SearchForInstances, see [ + # Search transaction](https://cloud.google.com/healthcare/docs/dicom# + # search_transaction) in the Cloud Healthcare API conformance statement. For + # samples that show how to call SearchForInstances, see [Searching for studies, + # series, instances, and frames](https://cloud.google.com/healthcare/docs/how- + # tos/dicomweb#searching_for_studies_series_instances_and_frames). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -763,6 +837,12 @@ module Google # SearchForSeries returns a list of matching series. See [Search Transaction] ( # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). + # For details on the implementation of SearchForSeries, see [Search transaction] + # (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the + # Cloud Healthcare API conformance statement. For samples that show how to call + # SearchForSeries, see [Searching for studies, series, instances, and frames]( + # https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # searching_for_studies_series_instances_and_frames). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -800,6 +880,12 @@ module Google # SearchForStudies returns a list of matching studies. See [Search Transaction] ( # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). + # For details on the implementation of SearchForStudies, see [Search + # transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) + # in the Cloud Healthcare API conformance statement. For samples that show how + # to call SearchForStudies, see [Searching for studies, series, instances, and + # frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # searching_for_studies_series_instances_and_frames). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -872,7 +958,12 @@ module Google # StoreInstances stores DICOM instances associated with study instance unique # identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/ - # dicom/current/output/html/part18.html#sect_10.5). + # dicom/current/output/html/part18.html#sect_10.5). For details on the + # implementation of StoreInstances, see [Store transaction](https://cloud.google. + # com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API + # conformance statement. For samples that show how to call StoreInstances, see [ + # Storing DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # storing_dicom_data). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -954,7 +1045,10 @@ module Google # method returns an Operation which will be marked successful when the deletion # is complete. Warning: Inserting instances into a study while a delete # operation is running for that study could result in the new instances not - # appearing in search results until the deletion operation finishes. + # appearing in search results until the deletion operation finishes. For samples + # that show how to call DeleteStudy, see [Deleting a study, series, or instance]( + # https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # deleting_a_study_series_or_instance). # @param [String] parent # @param [String] dicom_web_path # The path of the DeleteStudy request. For example, `studies/`study_uid``. @@ -989,6 +1083,11 @@ module Google # RetrieveStudyMetadata returns instance associated with the given study # presented as metadata with the bulk data removed. See [RetrieveTransaction] ( # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + # For details on the implementation of RetrieveStudyMetadata, see [Metadata + # resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) + # in the Cloud Healthcare API conformance statement. For samples that show how + # to call RetrieveStudyMetadata, see [Retrieving metadata](https://cloud.google. + # com/healthcare/docs/how-tos/dicomweb#retrieving_metadata). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1026,7 +1125,12 @@ module Google # RetrieveStudy returns all instances within the given study. See [ # RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/ - # part18.html#sect_10.4). + # part18.html#sect_10.4). For details on the implementation of RetrieveStudy, + # see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/ + # dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance + # statement. For samples that show how to call RetrieveStudy, see [Retrieving + # DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # retrieving_dicom_data). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1064,7 +1168,12 @@ module Google # SearchForInstances returns a list of matching instances. See [Search # Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18. - # html#sect_10.6). + # html#sect_10.6). For details on the implementation of SearchForInstances, see [ + # Search transaction](https://cloud.google.com/healthcare/docs/dicom# + # search_transaction) in the Cloud Healthcare API conformance statement. For + # samples that show how to call SearchForInstances, see [Searching for studies, + # series, instances, and frames](https://cloud.google.com/healthcare/docs/how- + # tos/dicomweb#searching_for_studies_series_instances_and_frames). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1103,6 +1212,12 @@ module Google # SearchForSeries returns a list of matching series. See [Search Transaction] ( # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). + # For details on the implementation of SearchForSeries, see [Search transaction] + # (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the + # Cloud Healthcare API conformance statement. For samples that show how to call + # SearchForSeries, see [Searching for studies, series, instances, and frames]( + # https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # searching_for_studies_series_instances_and_frames). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1140,7 +1255,12 @@ module Google # StoreInstances stores DICOM instances associated with study instance unique # identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/ - # dicom/current/output/html/part18.html#sect_10.5). + # dicom/current/output/html/part18.html#sect_10.5). For details on the + # implementation of StoreInstances, see [Store transaction](https://cloud.google. + # com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API + # conformance statement. For samples that show how to call StoreInstances, see [ + # Storing DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # storing_dicom_data). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1185,7 +1305,9 @@ module Google # when the deletion is complete. Warning: Inserting instances into a series # while a delete operation is running for that series could result in the new # instances not appearing in search results until the deletion operation - # finishes. + # finishes. For samples that show how to call DeleteSeries, see [Deleting a + # study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/ + # dicomweb#deleting_a_study_series_or_instance). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1224,7 +1346,12 @@ module Google # RetrieveSeriesMetadata returns instance associated with the given study and # series, presented as metadata with the bulk data removed. See [ # RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/ - # part18.html#sect_10.4). + # part18.html#sect_10.4). For details on the implementation of + # RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/ + # healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API + # conformance statement. For samples that show how to call + # RetrieveSeriesMetadata, see [Retrieving metadata](https://cloud.google.com/ + # healthcare/docs/how-tos/dicomweb#retrieving_metadata). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1262,7 +1389,12 @@ module Google # RetrieveSeries returns all instances within the given study and series. See [ # RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/ - # part18.html#sect_10.4). + # part18.html#sect_10.4). For details on the implementation of RetrieveSeries, + # see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/ + # dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance + # statement. For samples that show how to call RetrieveSeries, see [Retrieving + # DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # retrieving_dicom_data). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1300,7 +1432,12 @@ module Google # SearchForInstances returns a list of matching instances. See [Search # Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18. - # html#sect_10.6). + # html#sect_10.6). For details on the implementation of SearchForInstances, see [ + # Search transaction](https://cloud.google.com/healthcare/docs/dicom# + # search_transaction) in the Cloud Healthcare API conformance statement. For + # samples that show how to call SearchForInstances, see [Searching for studies, + # series, instances, and frames](https://cloud.google.com/healthcare/docs/how- + # tos/dicomweb#searching_for_studies_series_instances_and_frames). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1341,7 +1478,9 @@ module Google # and SOP Instance UID. Delete requests are equivalent to the GET requests # specified in the Retrieve transaction. Study and series search results can # take a few seconds to be updated after an instance is deleted using - # DeleteInstance. + # DeleteInstance. For samples that show how to call DeleteInstance, see [ + # Deleting a study, series, or instance](https://cloud.google.com/healthcare/ + # docs/how-tos/dicomweb#deleting_a_study_series_or_instance). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1379,7 +1518,13 @@ module Google # RetrieveInstance returns instance associated with the given study, series, and # SOP Instance UID. See [RetrieveTransaction] (http://dicom.nema.org/medical/ - # dicom/current/output/html/part18.html#sect_10.4). + # dicom/current/output/html/part18.html#sect_10.4). For details on the + # implementation of RetrieveInstance, see [DICOM study/series/instances](https:// + # cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM + # instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in + # the Cloud Healthcare API conformance statement. For samples that show how to + # call RetrieveInstance, see [Retrieving an instance](https://cloud.google.com/ + # healthcare/docs/how-tos/dicomweb#retrieving_an_instance). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1418,7 +1563,12 @@ module Google # RetrieveInstanceMetadata returns instance associated with the given study, # series, and SOP Instance UID presented as metadata with the bulk data removed. # See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/ - # html/part18.html#sect_10.4). + # html/part18.html#sect_10.4). For details on the implementation of + # RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/ + # healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API + # conformance statement. For samples that show how to call + # RetrieveInstanceMetadata, see [Retrieving metadata](https://cloud.google.com/ + # healthcare/docs/how-tos/dicomweb#retrieving_metadata). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1457,7 +1607,13 @@ module Google # RetrieveRenderedInstance returns instance associated with the given study, # series, and SOP Instance UID in an acceptable Rendered Media Type. See [ # RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/ - # part18.html#sect_10.4). + # part18.html#sect_10.4). For details on the implementation of + # RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/ + # healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API + # conformance statement. For samples that show how to call + # RetrieveRenderedInstance, see [Retrieving consumer image formats](https:// + # cloud.google.com/healthcare/docs/how-tos/dicomweb# + # retrieving_consumer_image_formats). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1495,7 +1651,12 @@ module Google # RetrieveFrames returns instances associated with the given study, series, SOP # Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema. - # org/medical/dicom/current/output/html/part18.html#sect_10.4`. + # org/medical/dicom/current/output/html/part18.html#sect_10.4`. For details on + # the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google. + # com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API + # conformance statement. For samples that show how to call RetrieveFrames, see [ + # Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how-tos/ + # dicomweb#retrieving_dicom_data). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1534,7 +1695,12 @@ module Google # RetrieveRenderedFrames returns instances associated with the given study, # series, SOP Instance UID and frame numbers in an acceptable Rendered Media # Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/ - # output/html/part18.html#sect_10.4). + # output/html/part18.html#sect_10.4). For details on the implementation of + # RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/ + # healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API + # conformance statement. For samples that show how to call + # RetrieveRenderedFrames, see [Retrieving consumer image formats](https://cloud. + # google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` diff --git a/generated/google/apis/healthcare_v1beta1.rb b/generated/google/apis/healthcare_v1beta1.rb index 0719e02ab..d04994b7c 100644 --- a/generated/google/apis/healthcare_v1beta1.rb +++ b/generated/google/apis/healthcare_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/healthcare module HealthcareV1beta1 VERSION = 'V1beta1' - REVISION = '20200819' + REVISION = '20200901' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/healthcare_v1beta1/service.rb b/generated/google/apis/healthcare_v1beta1/service.rb index e5780aeab..c57aa397d 100644 --- a/generated/google/apis/healthcare_v1beta1/service.rb +++ b/generated/google/apis/healthcare_v1beta1/service.rb @@ -1053,6 +1053,121 @@ module Google execute_or_queue_command(command, &block) end + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. + # @param [Fixnum] options_requested_policy_version + # Optional. The policy format version to be returned. Valid values are 0, 1, and + # 3. Requests specifying an invalid value will be rejected. Requests for + # policies with any conditional bindings must specify version 3. Policies + # without any conditional bindings may specify any valid value or leave the + # field unset. To learn which resources support conditions in their IAM policies, + # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/ + # resource-policies). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1beta1::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1beta1::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_consent_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::HealthcareV1beta1::Policy::Representation + command.response_class = Google::Apis::HealthcareV1beta1::Policy + command.params['resource'] = resource unless resource.nil? + command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy on the specified resource. Replaces any + # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` + # PERMISSION_DENIED` errors. + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1beta1::SetIamPolicyRequest] set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1beta1::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1beta1::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_consent_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::HealthcareV1beta1::SetIamPolicyRequest::Representation + command.request_object = set_iam_policy_request_object + command.response_representation = Google::Apis::HealthcareV1beta1::Policy::Representation + command.response_class = Google::Apis::HealthcareV1beta1::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # 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. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1beta1::TestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1beta1::TestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_consent_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::HealthcareV1beta1::TestIamPermissionsRequest::Representation + command.request_object = test_iam_permissions_request_object + command.response_representation = Google::Apis::HealthcareV1beta1::TestIamPermissionsResponse::Representation + command.response_class = Google::Apis::HealthcareV1beta1::TestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a new DICOM store within the parent dataset. # @param [String] parent # The name of the dataset this DICOM store belongs to. @@ -1391,7 +1506,13 @@ module Google # SearchForInstances returns a list of matching instances. See [ # RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ - # part18.html#sect_10.4). + # part18.html#sect_10.4). For details on the implementation of + # SearchForInstances, see [Search transaction](https://cloud.google.com/ + # healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API + # conformance statement. For samples that show how to call SearchForInstances, + # see [Searching for studies, series, instances, and frames](https://cloud. + # google.com/healthcare/docs/how-tos/dicomweb# + # searching_for_studies_series_instances_and_frames). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1430,6 +1551,12 @@ module Google # SearchForSeries returns a list of matching series. See [RetrieveTransaction]( # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + # For details on the implementation of SearchForSeries, see [Search transaction] + # (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the + # Cloud Healthcare API conformance statement. For samples that show how to call + # SearchForSeries, see [Searching for studies, series, instances, and frames]( + # https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # searching_for_studies_series_instances_and_frames). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1467,6 +1594,12 @@ module Google # SearchForStudies returns a list of matching studies. See [RetrieveTransaction]( # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + # For details on the implementation of SearchForStudies, see [Search + # transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) + # in the Cloud Healthcare API conformance statement. For samples that show how + # to call SearchForStudies, see [Searching for studies, series, instances, and + # frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # searching_for_studies_series_instances_and_frames). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1539,7 +1672,12 @@ module Google # StoreInstances stores DICOM instances associated with study instance unique # identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/ - # dicom/current/output/html/part18.html#sect_10.5). + # dicom/current/output/html/part18.html#sect_10.5). For details on the + # implementation of StoreInstances, see [Store transaction](https://cloud.google. + # com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API + # conformance statement. For samples that show how to call StoreInstances, see [ + # Storing DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # storing_dicom_data). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1617,7 +1755,10 @@ module Google end # DeleteStudy deletes all instances within the given study. Delete requests are - # equivalent to the GET requests specified in the Retrieve transaction. + # equivalent to the GET requests specified in the Retrieve transaction. For + # samples that show how to call DeleteStudy, see [Deleting a study, series, or + # instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # deleting_a_study_series_or_instance). # @param [String] parent # @param [String] dicom_web_path # The path of the DeleteStudy request. For example, `studies/`study_uid``. @@ -1652,6 +1793,11 @@ module Google # RetrieveStudyMetadata returns instance associated with the given study # presented as metadata with the bulk data removed. See [RetrieveTransaction]( # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + # For details on the implementation of RetrieveStudyMetadata, see [Metadata + # resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) + # in the Cloud Healthcare API conformance statement. For samples that show how + # to call RetrieveStudyMetadata, see [Retrieving metadata](https://cloud.google. + # com/healthcare/docs/how-tos/dicomweb#retrieving_metadata). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1689,7 +1835,12 @@ module Google # RetrieveStudy returns all instances within the given study. See [ # RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ - # part18.html#sect_10.4). + # part18.html#sect_10.4). For details on the implementation of RetrieveStudy, + # see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/ + # dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance + # statement. For samples that show how to call RetrieveStudy, see [Retrieving + # DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # retrieving_dicom_data). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1727,7 +1878,13 @@ module Google # SearchForInstances returns a list of matching instances. See [ # RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ - # part18.html#sect_10.4). + # part18.html#sect_10.4). For details on the implementation of + # SearchForInstances, see [Search transaction](https://cloud.google.com/ + # healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API + # conformance statement. For samples that show how to call SearchForInstances, + # see [Searching for studies, series, instances, and frames](https://cloud. + # google.com/healthcare/docs/how-tos/dicomweb# + # searching_for_studies_series_instances_and_frames). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1766,6 +1923,12 @@ module Google # SearchForSeries returns a list of matching series. See [RetrieveTransaction]( # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + # For details on the implementation of SearchForSeries, see [Search transaction] + # (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the + # Cloud Healthcare API conformance statement. For samples that show how to call + # SearchForSeries, see [Searching for studies, series, instances, and frames]( + # https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # searching_for_studies_series_instances_and_frames). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1803,7 +1966,12 @@ module Google # StoreInstances stores DICOM instances associated with study instance unique # identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/ - # dicom/current/output/html/part18.html#sect_10.5). + # dicom/current/output/html/part18.html#sect_10.5). For details on the + # implementation of StoreInstances, see [Store transaction](https://cloud.google. + # com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API + # conformance statement. For samples that show how to call StoreInstances, see [ + # Storing DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # storing_dicom_data). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1844,7 +2012,9 @@ module Google # DeleteSeries deletes all instances within the given study and series. Delete # requests are equivalent to the GET requests specified in the Retrieve - # transaction. + # transaction. For samples that show how to call DeleteSeries, see [Deleting a + # study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/ + # dicomweb#deleting_a_study_series_or_instance). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1883,7 +2053,12 @@ module Google # RetrieveSeriesMetadata returns instance associated with the given study and # series, presented as metadata with the bulk data removed. See [ # RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ - # part18.html#sect_10.4). + # part18.html#sect_10.4). For details on the implementation of + # RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/ + # healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API + # conformance statement. For samples that show how to call + # RetrieveSeriesMetadata, see [Retrieving metadata](https://cloud.google.com/ + # healthcare/docs/how-tos/dicomweb#retrieving_metadata). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1921,7 +2096,12 @@ module Google # RetrieveSeries returns all instances within the given study and series. See [ # RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ - # part18.html#sect_10.4). + # part18.html#sect_10.4). For details on the implementation of RetrieveSeries, + # see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/ + # dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance + # statement. For samples that show how to call RetrieveSeries, see [Retrieving + # DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # retrieving_dicom_data). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -1959,7 +2139,13 @@ module Google # SearchForInstances returns a list of matching instances. See [ # RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ - # part18.html#sect_10.4). + # part18.html#sect_10.4). For details on the implementation of + # SearchForInstances, see [Search transaction](https://cloud.google.com/ + # healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API + # conformance statement. For samples that show how to call SearchForInstances, + # see [Searching for studies, series, instances, and frames](https://cloud. + # google.com/healthcare/docs/how-tos/dicomweb# + # searching_for_studies_series_instances_and_frames). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -2000,7 +2186,9 @@ module Google # and SOP Instance UID. Delete requests are equivalent to the GET requests # specified in the Retrieve transaction. Study and series search results can # take a few seconds to be updated after an instance is deleted using - # DeleteInstance. + # DeleteInstance. For samples that show how to call DeleteInstance, see [ + # Deleting a study, series, or instance](https://cloud.google.com/healthcare/ + # docs/how-tos/dicomweb#deleting_a_study_series_or_instance). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -2038,7 +2226,13 @@ module Google # RetrieveInstance returns instance associated with the given study, series, and # SOP Instance UID. See [RetrieveTransaction](http://dicom.nema.org/medical/ - # dicom/current/output/html/part18.html#sect_10.4). + # dicom/current/output/html/part18.html#sect_10.4). For details on the + # implementation of RetrieveInstance, see [DICOM study/series/instances](https:// + # cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM + # instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in + # the Cloud Healthcare API conformance statement. For samples that show how to + # call RetrieveInstance, see [Retrieving an instance](https://cloud.google.com/ + # healthcare/docs/how-tos/dicomweb#retrieving_an_instance). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -2077,7 +2271,12 @@ module Google # RetrieveInstanceMetadata returns instance associated with the given study, # series, and SOP Instance UID presented as metadata with the bulk data removed. # See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/ - # html/part18.html#sect_10.4). + # html/part18.html#sect_10.4). For details on the implementation of + # RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/ + # healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API + # conformance statement. For samples that show how to call + # RetrieveInstanceMetadata, see [Retrieving metadata](https://cloud.google.com/ + # healthcare/docs/how-tos/dicomweb#retrieving_metadata). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -2116,7 +2315,13 @@ module Google # RetrieveRenderedInstance returns instance associated with the given study, # series, and SOP Instance UID in an acceptable Rendered Media Type. See [ # RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ - # part18.html#sect_10.4). + # part18.html#sect_10.4). For details on the implementation of + # RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/ + # healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API + # conformance statement. For samples that show how to call + # RetrieveRenderedInstance, see [Retrieving consumer image formats](https:// + # cloud.google.com/healthcare/docs/how-tos/dicomweb# + # retrieving_consumer_image_formats). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -2154,7 +2359,12 @@ module Google # RetrieveFrames returns instances associated with the given study, series, SOP # Instance UID and frame numbers. See [RetrieveTransaction](http://dicom.nema. - # org/medical/dicom/current/output/html/part18.html#sect_10.4). + # org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on + # the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google. + # com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API + # conformance statement. For samples that show how to call RetrieveFrames, see [ + # Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how-tos/ + # dicomweb#retrieving_dicom_data). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` @@ -2193,7 +2403,12 @@ module Google # RetrieveRenderedFrames returns instances associated with the given study, # series, SOP Instance UID and frame numbers in an acceptable Rendered Media # Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/ - # output/html/part18.html#sect_10.4). + # output/html/part18.html#sect_10.4). For details on the implementation of + # RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/ + # healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API + # conformance statement. For samples that show how to call + # RetrieveRenderedFrames, see [Retrieving consumer image formats](https://cloud. + # google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats). # @param [String] parent # The name of the DICOM store that is being accessed. For example, `projects/` # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/` diff --git a/generated/google/apis/homegraph_v1.rb b/generated/google/apis/homegraph_v1.rb index 2ca2357b8..7e68bc813 100644 --- a/generated/google/apis/homegraph_v1.rb +++ b/generated/google/apis/homegraph_v1.rb @@ -25,7 +25,10 @@ module Google # @see https://developers.google.com/actions/smarthome/create-app#request-sync module HomegraphV1 VERSION = 'V1' - REVISION = '20200810' + REVISION = '20200827' + + # New Service: https://www.googleapis.com/auth/homegraph + AUTH_HOMEGRAPH = 'https://www.googleapis.com/auth/homegraph' end end end diff --git a/generated/google/apis/iam_v1.rb b/generated/google/apis/iam_v1.rb index d5b0b017b..947421890 100644 --- a/generated/google/apis/iam_v1.rb +++ b/generated/google/apis/iam_v1.rb @@ -30,7 +30,7 @@ module Google # @see https://cloud.google.com/iam/ module IamV1 VERSION = 'V1' - REVISION = '20200824' + REVISION = '20200827' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/iam_v1/classes.rb b/generated/google/apis/iam_v1/classes.rb index 287e73b9c..9edf8c1fd 100644 --- a/generated/google/apis/iam_v1/classes.rb +++ b/generated/google/apis/iam_v1/classes.rb @@ -159,6 +159,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: @@ -220,6 +226,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) diff --git a/generated/google/apis/iam_v1/representations.rb b/generated/google/apis/iam_v1/representations.rb index e870eb06a..fd29c3efd 100644 --- a/generated/google/apis/iam_v1/representations.rb +++ b/generated/google/apis/iam_v1/representations.rb @@ -335,6 +335,7 @@ module Google class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::IamV1::Expr, decorator: Google::Apis::IamV1::Expr::Representation collection :members, as: 'members' diff --git a/generated/google/apis/iap_v1.rb b/generated/google/apis/iap_v1.rb index af0a35d1e..079be8de0 100644 --- a/generated/google/apis/iap_v1.rb +++ b/generated/google/apis/iap_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/iap module IapV1 VERSION = 'V1' - REVISION = '20200807' + REVISION = '20200828' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/iap_v1/classes.rb b/generated/google/apis/iap_v1/classes.rb index 0f496206e..6394257ea 100644 --- a/generated/google/apis/iap_v1/classes.rb +++ b/generated/google/apis/iap_v1/classes.rb @@ -129,6 +129,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: @@ -190,6 +196,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) diff --git a/generated/google/apis/iap_v1/representations.rb b/generated/google/apis/iap_v1/representations.rb index ffe5650a5..67aa9757c 100644 --- a/generated/google/apis/iap_v1/representations.rb +++ b/generated/google/apis/iap_v1/representations.rb @@ -207,6 +207,7 @@ module Google class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::IapV1::Expr, decorator: Google::Apis::IapV1::Expr::Representation collection :members, as: 'members' diff --git a/generated/google/apis/iap_v1beta1.rb b/generated/google/apis/iap_v1beta1.rb index b486aa0cf..21a4db272 100644 --- a/generated/google/apis/iap_v1beta1.rb +++ b/generated/google/apis/iap_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/iap module IapV1beta1 VERSION = 'V1beta1' - REVISION = '20200807' + REVISION = '20200828' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/iap_v1beta1/classes.rb b/generated/google/apis/iap_v1beta1/classes.rb index dfb6a256c..c60cb7a4a 100644 --- a/generated/google/apis/iap_v1beta1/classes.rb +++ b/generated/google/apis/iap_v1beta1/classes.rb @@ -26,6 +26,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: @@ -87,6 +93,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) diff --git a/generated/google/apis/iap_v1beta1/representations.rb b/generated/google/apis/iap_v1beta1/representations.rb index 3bc4ea0c1..ce22dd7de 100644 --- a/generated/google/apis/iap_v1beta1/representations.rb +++ b/generated/google/apis/iap_v1beta1/representations.rb @@ -73,6 +73,7 @@ module Google class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::IapV1beta1::Expr, decorator: Google::Apis::IapV1beta1::Expr::Representation collection :members, as: 'members' diff --git a/generated/google/apis/jobs_v2.rb b/generated/google/apis/jobs_v2.rb index faee3881c..c3adfe493 100644 --- a/generated/google/apis/jobs_v2.rb +++ b/generated/google/apis/jobs_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/talent-solution/job-search/docs/ module JobsV2 VERSION = 'V2' - REVISION = '20200409' + REVISION = '20200828' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/jobs_v2/classes.rb b/generated/google/apis/jobs_v2/classes.rb index 227ba12a3..446b0568d 100644 --- a/generated/google/apis/jobs_v2/classes.rb +++ b/generated/google/apis/jobs_v2/classes.rb @@ -22,17 +22,14 @@ module Google module Apis module JobsV2 - # Input only. - # Batch delete jobs request. + # Input only. Batch delete jobs request. class BatchDeleteJobsRequest include Google::Apis::Core::Hashable - # Required. The filter string specifies the jobs to be deleted. - # Supported operator: =, AND - # The fields eligible for filtering are: - # * `companyName` (Required) - # * `requisitionId` (Required) - # Sample Query: companyName = "companies/123" AND requisitionId = "req-1" + # Required. The filter string specifies the jobs to be deleted. Supported + # operator: =, AND The fields eligible for filtering are: * `companyName` ( + # Required) * `requisitionId` (Required) Sample Query: companyName = "companies/ + # 123" AND requisitionId = "req-1" # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter @@ -97,22 +94,19 @@ module Google end end - # Output only. - # Commute details related to this job. + # Output only. Commute details related to this job. class CommuteInfo include Google::Apis::Core::Hashable - # Output only. - # A resource that represents a location with full geographic + # Output only. A resource that represents a location with full geographic # information. # Corresponds to the JSON property `jobLocation` # @return [Google::Apis::JobsV2::JobLocation] attr_accessor :job_location # The number of seconds required to travel to the job location from the query - # location. A duration of 0 seconds indicates that the job is not - # reachable within the requested duration, but was returned as part of an - # expanded query. + # location. A duration of 0 seconds indicates that the job is not reachable + # within the requested duration, but was returned as part of an expanded query. # Corresponds to the JSON property `travelDuration` # @return [String] attr_accessor :travel_duration @@ -128,16 +122,15 @@ module Google end end - # Input only. - # Parameters needed for commute search. + # Input only. Parameters needed for commute search. class CommutePreference include Google::Apis::Core::Hashable # Optional. If `true`, jobs without street level addresses may also be returned. - # For city level addresses, the city center is used. For state and coarser - # level addresses, text matching is used. - # If this field is set to `false` or is not specified, only jobs that include - # street level addresses will be returned by commute search. + # For city level addresses, the city center is used. For state and coarser level + # addresses, text matching is used. If this field is set to `false` or is not + # specified, only jobs that include street level addresses will be returned by + # commute search. # Corresponds to the JSON property `allowNonStreetLevelAddress` # @return [Boolean] attr_accessor :allow_non_street_level_address @@ -163,16 +156,14 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `startLocation` # @return [Google::Apis::JobsV2::LatLng] attr_accessor :start_location # Required. The maximum travel time in seconds. The maximum allowed value is ` - # 3600s` - # (one hour). Format is `123s`. + # 3600s` (one hour). Format is `123s`. # Corresponds to the JSON property `travelTime` # @return [String] attr_accessor :travel_time @@ -199,15 +190,13 @@ module Google include Google::Apis::Core::Hashable # Optional. The URL to employer's career site or careers page on the employer's - # web - # site. + # web site. # Corresponds to the JSON property `careerPageLink` # @return [String] attr_accessor :career_page_link # Optional. Identifiers external to the application that help to further - # identify - # the employer. + # identify the employer. # Corresponds to the JSON property `companyInfoSources` # @return [Array] attr_accessor :company_info_sources @@ -217,120 +206,108 @@ module Google # @return [String] attr_accessor :company_size - # Deprecated. Do not use this field. - # Optional. - # This field is no longer used. Any value set to it is ignored. + # Deprecated. Do not use this field. Optional. This field is no longer used. Any + # value set to it is ignored. # Corresponds to the JSON property `disableLocationOptimization` # @return [Boolean] attr_accessor :disable_location_optimization alias_method :disable_location_optimization?, :disable_location_optimization - # Required. The name of the employer to be displayed with the job, - # for example, "Google, LLC.". + # Required. The name of the employer to be displayed with the job, for example, " + # Google, LLC.". # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Optional. The unique company identifier provided by the client to identify an - # employer for billing purposes. Recommended practice is to use - # the distributor_company_id. - # Defaults to same value as distributor_company_id when a value - # is not provided. + # employer for billing purposes. Recommended practice is to use the + # distributor_company_id. Defaults to same value as distributor_company_id when + # a value is not provided. # Corresponds to the JSON property `distributorBillingCompanyId` # @return [String] attr_accessor :distributor_billing_company_id - # Required. A client's company identifier, used to uniquely identify the - # company. If an employer has a subsidiary or sub-brand, such as "Alphabet" - # and "Google", which the client wishes to use as the company displayed on - # the job. Best practice is to create a distinct company identifier for each - # distinct brand displayed. - # The maximum number of allowed characters is 255. + # Required. A client's company identifier, used to uniquely identify the company. + # If an employer has a subsidiary or sub-brand, such as "Alphabet" and "Google", + # which the client wishes to use as the company displayed on the job. Best + # practice is to create a distinct company identifier for each distinct brand + # displayed. The maximum number of allowed characters is 255. # Corresponds to the JSON property `distributorCompanyId` # @return [String] attr_accessor :distributor_company_id - # Optional. Equal Employment Opportunity legal disclaimer text to be - # associated with all jobs, and typically to be displayed in all - # roles. - # The maximum number of allowed characters is 500. + # Optional. Equal Employment Opportunity legal disclaimer text to be associated + # with all jobs, and typically to be displayed in all roles. The maximum number + # of allowed characters is 500. # Corresponds to the JSON property `eeoText` # @return [String] attr_accessor :eeo_text # Optional. Set to true if it is the hiring agency that post jobs for other - # employers. - # Defaults to false if not provided. + # employers. Defaults to false if not provided. # Corresponds to the JSON property `hiringAgency` # @return [Boolean] attr_accessor :hiring_agency alias_method :hiring_agency?, :hiring_agency # Optional. The street address of the company's main headquarters, which may be - # different from the job location. The service attempts - # to geolocate the provided address, and populates a more specific - # location wherever possible in structured_company_hq_location. + # different from the job location. The service attempts to geolocate the + # provided address, and populates a more specific location wherever possible in + # structured_company_hq_location. # Corresponds to the JSON property `hqLocation` # @return [String] attr_accessor :hq_location - # Optional. A URL that hosts the employer's company logo. If provided, - # the logo image should be squared at 80x80 pixels. - # The url must be a Google Photos or Google Album url. - # Only images in these Google sub-domains are accepted. + # Optional. A URL that hosts the employer's company logo. If provided, the logo + # image should be squared at 80x80 pixels. The url must be a Google Photos or + # Google Album url. Only images in these Google sub-domains are accepted. # Corresponds to the JSON property `imageUrl` # @return [String] attr_accessor :image_url # Optional. A list of keys of filterable Job.custom_attributes, whose - # corresponding `string_values` are used in keyword search. Jobs with - # `string_values` under these specified field keys are returned if any - # of the values matches the search keyword. Custom field values with - # parenthesis, brackets and special symbols might not be properly searchable, - # and those keyword queries need to be surrounded by quotes. + # corresponding `string_values` are used in keyword search. Jobs with ` + # string_values` under these specified field keys are returned if any of the + # values matches the search keyword. Custom field values with parenthesis, + # brackets and special symbols might not be properly searchable, and those + # keyword queries need to be surrounded by quotes. # Corresponds to the JSON property `keywordSearchableCustomAttributes` # @return [Array] attr_accessor :keyword_searchable_custom_attributes - # Deprecated. Use keyword_searchable_custom_attributes instead. - # Optional. - # A list of filterable custom fields that should be used in keyword - # search. The jobs of this company are returned if any of these custom - # fields matches the search keyword. Custom field values with parenthesis, - # brackets and special symbols might not be properly searchable, and those - # keyword queries need to be surrounded by quotes. + # Deprecated. Use keyword_searchable_custom_attributes instead. Optional. A list + # of filterable custom fields that should be used in keyword search. The jobs of + # this company are returned if any of these custom fields matches the search + # keyword. Custom field values with parenthesis, brackets and special symbols + # might not be properly searchable, and those keyword queries need to be + # surrounded by quotes. # Corresponds to the JSON property `keywordSearchableCustomFields` # @return [Array] attr_accessor :keyword_searchable_custom_fields - # Required during company update. - # The resource name for a company. This is generated by the service when a - # company is created, for example, - # "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + # Required during company update. The resource name for a company. This is + # generated by the service when a company is created, for example, "companies/ + # 0000aaaa-1111-bbbb-2222-cccc3333dddd". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Output only. - # A resource that represents a location with full geographic + # Output only. A resource that represents a location with full geographic # information. # Corresponds to the JSON property `structuredCompanyHqLocation` # @return [Google::Apis::JobsV2::JobLocation] attr_accessor :structured_company_hq_location # Output only. Indicates whether a company is flagged to be suspended from - # public - # availability by the service when job content appears suspicious, + # public availability by the service when job content appears suspicious, # abusive, or spammy. # Corresponds to the JSON property `suspended` # @return [Boolean] attr_accessor :suspended alias_method :suspended?, :suspended - # Deprecated. Use display_name instead. - # Required. - # The name of the employer to be displayed with the job, - # for example, "Google, LLC.". + # Deprecated. Use display_name instead. Required. The name of the employer to be + # displayed with the job, for example, "Google, LLC.". # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -368,9 +345,9 @@ module Google end end - # A resource that represents an external Google identifier for a company, - # for example, a Google+ business page or a Google Maps business page. - # For unsupported types, use `unknown_type_id`. + # A resource that represents an external Google identifier for a company, for + # example, a Google+ business page or a Google Maps business page. For + # unsupported types, use `unknown_type_id`. class CompanyInfoSource include Google::Apis::Core::Hashable @@ -385,8 +362,7 @@ module Google attr_accessor :gplus_id # Optional. The numeric identifier for the employer's headquarters on Google - # Maps, - # namely, the Google Maps CID (cell id). + # Maps, namely, the Google Maps CID (cell id). # Corresponds to the JSON property `mapsCid` # @return [String] attr_accessor :maps_cid @@ -409,13 +385,11 @@ module Google end end - # A compensation entry that represents one component of compensation, such - # as base pay, bonus, or other compensation type. - # Annualization: One compensation entry can be annualized if - # - it contains valid amount or range. - # - and its expected_units_per_year is set or can be derived. - # Its annualized range is determined as (amount or range) times - # expected_units_per_year. + # A compensation entry that represents one component of compensation, such as + # base pay, bonus, or other compensation type. Annualization: One compensation + # entry can be annualized if - it contains valid amount or range. - and its + # expected_units_per_year is set or can be derived. Its annualized range is + # determined as (amount or range) times expected_units_per_year. class CompensationEntry include Google::Apis::Core::Hashable @@ -424,21 +398,16 @@ module Google # @return [Google::Apis::JobsV2::Money] attr_accessor :amount - # Optional. Compensation description. For example, could - # indicate equity terms or provide additional context to an estimated - # bonus. + # Optional. Compensation description. For example, could indicate equity terms + # or provide additional context to an estimated bonus. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Optional. Expected number of units paid each year. If not specified, when - # Job.employment_types is FULLTIME, a default value is inferred - # based on unit. Default values: - # - HOURLY: 2080 - # - DAILY: 260 - # - WEEKLY: 52 - # - MONTHLY: 12 - # - ANNUAL: 1 + # Optional. Expected number of units paid each year. If not specified, when Job. + # employment_types is FULLTIME, a default value is inferred based on unit. + # Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - + # ANNUAL: 1 # Corresponds to the JSON property `expectedUnitsPerYear` # @return [Float] attr_accessor :expected_units_per_year @@ -453,8 +422,8 @@ module Google # @return [String] attr_accessor :type - # Optional. Frequency of the specified amount. - # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. + # Optional. Frequency of the specified amount. Default is CompensationUnit. + # COMPENSATION_UNIT_UNSPECIFIED. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit @@ -474,8 +443,7 @@ module Google end end - # Input only. - # Filter on job compensation type and amount. + # Input only. Filter on job compensation type and amount. class CompensationFilter include Google::Apis::Core::Hashable @@ -495,8 +463,8 @@ module Google # @return [String] attr_accessor :type - # Required. Specify desired `base compensation entry's` - # CompensationInfo.CompensationUnit. + # Required. Specify desired `base compensation entry's` CompensationInfo. + # CompensationUnit. # Corresponds to the JSON property `units` # @return [Array] attr_accessor :units @@ -514,21 +482,19 @@ module Google end end - # Input only. - # Compensation based histogram request. + # Input only. Compensation based histogram request. class CompensationHistogramRequest include Google::Apis::Core::Hashable - # Input only. - # Use this field to specify bucketing option for the histogram search response. + # Input only. Use this field to specify bucketing option for the histogram + # search response. # Corresponds to the JSON property `bucketingOption` # @return [Google::Apis::JobsV2::NumericBucketingOption] attr_accessor :bucketing_option # Required. Type of the request, representing which field the histogramming - # should be - # performed over. A single request can only specify one histogram of each - # `CompensationHistogramRequestType`. + # should be performed over. A single request can only specify one histogram of + # each `CompensationHistogramRequestType`. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -544,19 +510,16 @@ module Google end end - # Output only. - # Compensation based histogram result. + # Output only. Compensation based histogram result. class CompensationHistogramResult include Google::Apis::Core::Hashable - # Output only. - # Custom numeric bucketing result. + # Output only. Custom numeric bucketing result. # Corresponds to the JSON property `result` # @return [Google::Apis::JobsV2::NumericBucketingResult] attr_accessor :result - # Type of the request, corresponding to - # CompensationHistogramRequest.type. + # Type of the request, corresponding to CompensationHistogramRequest.type. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -591,10 +554,9 @@ module Google # @return [Google::Apis::JobsV2::CompensationRange] attr_accessor :annualized_total_compensation_range - # Optional. Job compensation information. - # At most one entry can be of type - # CompensationInfo.CompensationType.BASE, which is - # referred as ** base compensation entry ** for the job. + # Optional. Job compensation information. At most one entry can be of type + # CompensationInfo.CompensationType.BASE, which is referred as ** base + # compensation entry ** for the job. # Corresponds to the JSON property `entries` # @return [Array] attr_accessor :entries @@ -609,9 +571,7 @@ module Google # @return [Google::Apis::JobsV2::Money] attr_accessor :min - # Deprecated. Use entries instead. - # Optional. - # Type of job compensation. + # Deprecated. Use entries instead. Optional. Type of job compensation. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -657,8 +617,7 @@ module Google end end - # Output only. - # Response of auto-complete query. + # Output only. Response of auto-complete query. class CompleteQueryResponse include Google::Apis::Core::Hashable @@ -667,8 +626,7 @@ module Google # @return [Array] attr_accessor :completion_results - # Output only. - # Additional information returned to client, such as debugging + # Output only. Additional information returned to client, such as debugging # information. # Corresponds to the JSON property `metadata` # @return [Google::Apis::JobsV2::ResponseMetadata] @@ -685,8 +643,7 @@ module Google end end - # Output only. - # Resource that represents completion results. + # Output only. Resource that represents completion results. class CompletionResult include Google::Apis::Core::Hashable @@ -717,30 +674,26 @@ module Google end end - # Input only. - # Create job request. + # Input only. Create job request. class CreateJobRequest include Google::Apis::Core::Hashable # Deprecated. Please use processing_options. This flag is ignored if - # processing_options is set. - # Optional. - # If set to `true`, the service does not attempt to resolve a - # more precise address for the job. + # processing_options is set. Optional. If set to `true`, the service does not + # attempt to resolve a more precise address for the job. # Corresponds to the JSON property `disableStreetAddressResolution` # @return [Boolean] attr_accessor :disable_street_address_resolution alias_method :disable_street_address_resolution?, :disable_street_address_resolution # A Job resource represents a job posting (also referred to as a "job listing" - # or "job requisition"). A job belongs to a Company, which is the hiring - # entity responsible for the job. + # or "job requisition"). A job belongs to a Company, which is the hiring entity + # responsible for the job. # Corresponds to the JSON property `job` # @return [Google::Apis::JobsV2::Job] attr_accessor :job - # Input only. - # Options for job processing. + # Input only. Options for job processing. # Corresponds to the JSON property `processingOptions` # @return [Google::Apis::JobsV2::JobProcessingOptions] attr_accessor :processing_options @@ -762,18 +715,16 @@ module Google include Google::Apis::Core::Hashable # Optional. If the `filterable` flag is true, custom field values are searchable. - # If false, values are not searchable. - # Default is false. + # If false, values are not searchable. Default is false. # Corresponds to the JSON property `filterable` # @return [Boolean] attr_accessor :filterable alias_method :filterable?, :filterable - # Optional but at least one of string_values or long_value must - # be specified. - # This field is used to perform number range search. - # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For - # `long_value`, a value between Long.MIN and Long.MAX is allowed. + # Optional but at least one of string_values or long_value must be specified. + # This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, ` + # LT`) over filterable `long_value`. For `long_value`, a value between Long.MIN + # and Long.MAX is allowed. # Corresponds to the JSON property `longValue` # @return [Fixnum] attr_accessor :long_value @@ -796,22 +747,21 @@ module Google end # Custom attributes histogram request. An error will be thrown if neither - # string_value_histogram or long_value_histogram_bucketing_option has - # been defined. + # string_value_histogram or long_value_histogram_bucketing_option has been + # defined. class CustomAttributeHistogramRequest include Google::Apis::Core::Hashable # Required. Specifies the custom field key to perform a histogram on. If - # specified - # without `long_value_histogram_bucketing_option`, histogram on string values - # of the given `key` is triggered, otherwise histogram is performed on long - # values. + # specified without `long_value_histogram_bucketing_option`, histogram on string + # values of the given `key` is triggered, otherwise histogram is performed on + # long values. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key - # Input only. - # Use this field to specify bucketing option for the histogram search response. + # Input only. Use this field to specify bucketing option for the histogram + # search response. # Corresponds to the JSON property `longValueHistogramBucketingOption` # @return [Google::Apis::JobsV2::NumericBucketingOption] attr_accessor :long_value_histogram_bucketing_option @@ -835,8 +785,7 @@ module Google end end - # Output only. - # Custom attribute histogram result. + # Output only. Custom attribute histogram result. class CustomAttributeHistogramResult include Google::Apis::Core::Hashable @@ -845,14 +794,13 @@ module Google # @return [String] attr_accessor :key - # Output only. - # Custom numeric bucketing result. + # Output only. Custom numeric bucketing result. # Corresponds to the JSON property `longValueHistogramResult` # @return [Google::Apis::JobsV2::NumericBucketingResult] attr_accessor :long_value_histogram_result - # Stores a map from the values of string custom field associated - # with `key` to the number of jobs with that value in this histogram result. + # Stores a map from the values of string custom field associated with `key` to + # the number of jobs with that value in this histogram result. # Corresponds to the JSON property `stringValueHistogramResult` # @return [Hash] attr_accessor :string_value_histogram_result @@ -888,8 +836,7 @@ module Google end end - # Input only. - # Custom field filter of the search. + # Input only. Custom field filter of the search. class CustomFieldFilter include Google::Apis::Core::Hashable @@ -898,8 +845,7 @@ module Google # @return [Array] attr_accessor :queries - # Optional. The type of filter. - # Defaults to FilterType.OR. + # Optional. The type of filter. Defaults to FilterType.OR. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -917,30 +863,29 @@ module Google # Represents a whole or partial calendar date, e.g. a birthday. The time of day # and time zone are either specified elsewhere or are not significant. The date - # is relative to the Proleptic Gregorian Calendar. This can represent: - # * A full date, with non-zero year, month and day values - # * A month and day value, with a zero year, e.g. an anniversary - # * A year on its own, with zero month and day values - # * A year and month value, with a zero day, e.g. a credit card expiration date - # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + # is relative to the Proleptic Gregorian Calendar. This can represent: * A full + # date, with non-zero year, month and day values * A month and day value, with a + # zero year, e.g. an anniversary * A year on its own, with zero month and day + # values * A year and month value, with a zero day, e.g. a credit card + # expiration date Related types are google.type.TimeOfDay and `google.protobuf. + # Timestamp`. class Date include Google::Apis::Core::Hashable - # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 - # if specifying a year by itself or a year and month where the day is not + # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if + # specifying a year by itself or a year and month where the day is not # significant. # Corresponds to the JSON property `day` # @return [Fixnum] attr_accessor :day - # Month of year. Must be from 1 to 12, or 0 if specifying a year without a - # month and day. + # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month + # and day. # Corresponds to the JSON property `month` # @return [Fixnum] attr_accessor :month - # Year of date. Must be from 1 to 9999, or 0 if specifying a date without - # a year. + # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. # Corresponds to the JSON property `year` # @return [Fixnum] attr_accessor :year @@ -957,25 +902,22 @@ module Google end end - # Deprecated. Use BatchDeleteJobsRequest instead. - # Input only. - # Delete job by filter request. - # The job typically becomes unsearchable within 10 seconds, but it may take - # up to 5 minutes. + # Deprecated. Use BatchDeleteJobsRequest instead. Input only. Delete job by + # filter request. The job typically becomes unsearchable within 10 seconds, but + # it may take up to 5 minutes. class DeleteJobsByFilterRequest include Google::Apis::Core::Hashable # Optional. If set to true, this call waits for all processing steps to complete - # before the job is cleaned up. Otherwise, the call returns while some - # steps are still taking place asynchronously, hence faster. + # before the job is cleaned up. Otherwise, the call returns while some steps are + # still taking place asynchronously, hence faster. # Corresponds to the JSON property `disableFastProcess` # @return [Boolean] attr_accessor :disable_fast_process alias_method :disable_fast_process?, :disable_fast_process - # Deprecated. Use BatchDeleteJobsRequest instead. - # Input only. - # Filter for jobs to be deleted. + # Deprecated. Use BatchDeleteJobsRequest instead. Input only. Filter for jobs to + # be deleted. # Corresponds to the JSON property `filter` # @return [Google::Apis::JobsV2::Filter] attr_accessor :filter @@ -991,8 +933,7 @@ module Google end end - # Input only. - # Device information collected from the job seeker, candidate, or + # Input only. Device information collected from the job seeker, candidate, or # other entity conducting the job search. Providing this information improves # the quality of the search results across devices. class DeviceInfo @@ -1004,8 +945,7 @@ module Google attr_accessor :device_type # Optional. A device-specific ID. The ID must be a unique identifier that - # distinguishes - # the device from other devices. + # distinguishes the device from other devices. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -1021,13 +961,11 @@ module Google end end - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. class Empty include Google::Apis::Core::Hashable @@ -1040,27 +978,25 @@ module Google end end - # Deprecated. Always use CompensationFilter. - # Input only. - # Filter on job compensation type and amount. + # Deprecated. Always use CompensationFilter. Input only. Filter on job + # compensation type and amount. class ExtendedCompensationFilter include Google::Apis::Core::Hashable - # Deprecated. See CompensationInfo. - # Compensation range. + # Deprecated. See CompensationInfo. Compensation range. # Corresponds to the JSON property `compensationRange` # @return [Google::Apis::JobsV2::ExtendedCompensationInfoCompensationRange] attr_accessor :compensation_range - # Required. Specify desired `base compensation entry's` - # ExtendedCompensationInfo.CompensationUnit. + # Required. Specify desired `base compensation entry's` ExtendedCompensationInfo. + # CompensationUnit. # Corresponds to the JSON property `compensationUnits` # @return [Array] attr_accessor :compensation_units - # Optional. Specify currency in 3-letter - # [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. If - # unspecified, jobs are returned regardless of currency. + # Optional. Specify currency in 3-letter [ISO 4217](https://www.iso.org/iso-4217- + # currency-codes.html) format. If unspecified, jobs are returned regardless of + # currency. # Corresponds to the JSON property `currency` # @return [String] attr_accessor :currency @@ -1090,54 +1026,45 @@ module Google end end - # Deprecated. Use CompensationInfo. - # Describes job compensation. + # Deprecated. Use CompensationInfo. Describes job compensation. class ExtendedCompensationInfo include Google::Apis::Core::Hashable - # Deprecated. See CompensationInfo. - # Compensation range. + # Deprecated. See CompensationInfo. Compensation range. # Corresponds to the JSON property `annualizedBaseCompensationRange` # @return [Google::Apis::JobsV2::ExtendedCompensationInfoCompensationRange] attr_accessor :annualized_base_compensation_range # Output only. Indicates annualized base compensation range cannot be derived, - # due to - # the job's base compensation entry cannot be annualized. - # See CompensationEntry for explanation on annualization and base - # compensation entry. + # due to the job's base compensation entry cannot be annualized. See + # CompensationEntry for explanation on annualization and base compensation entry. # Corresponds to the JSON property `annualizedBaseCompensationUnspecified` # @return [Boolean] attr_accessor :annualized_base_compensation_unspecified alias_method :annualized_base_compensation_unspecified?, :annualized_base_compensation_unspecified - # Deprecated. See CompensationInfo. - # Compensation range. + # Deprecated. See CompensationInfo. Compensation range. # Corresponds to the JSON property `annualizedTotalCompensationRange` # @return [Google::Apis::JobsV2::ExtendedCompensationInfoCompensationRange] attr_accessor :annualized_total_compensation_range # Output only. Indicates annualized total compensation range cannot be derived, - # due to - # the job's all CompensationEntry cannot be annualized. - # See CompensationEntry for explanation on annualization and base - # compensation entry. + # due to the job's all CompensationEntry cannot be annualized. See + # CompensationEntry for explanation on annualization and base compensation entry. # Corresponds to the JSON property `annualizedTotalCompensationUnspecified` # @return [Boolean] attr_accessor :annualized_total_compensation_unspecified alias_method :annualized_total_compensation_unspecified?, :annualized_total_compensation_unspecified # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes. - # html) - # currency code. + # html) currency code. # Corresponds to the JSON property `currency` # @return [String] attr_accessor :currency - # Optional. Job compensation information. - # At most one entry can be of type - # ExtendedCompensationInfo.CompensationType.BASE, which is - # referred as ** base compensation entry ** for the job. + # Optional. Job compensation information. At most one entry can be of type + # ExtendedCompensationInfo.CompensationType.BASE, which is referred as ** base + # compensation entry ** for the job. # Corresponds to the JSON property `entries` # @return [Array] attr_accessor :entries @@ -1157,19 +1084,16 @@ module Google end end - # Deprecated. See CompensationInfo. - # A compensation entry that represents one component of compensation, such - # as base pay, bonus, or other compensation type. - # Annualization: One compensation entry can be annualized if - # - it contains valid amount or range. - # - and its expected_units_per_year is set or can be derived. - # Its annualized range is determined as (amount or range) times + # Deprecated. See CompensationInfo. A compensation entry that represents one + # component of compensation, such as base pay, bonus, or other compensation type. + # Annualization: One compensation entry can be annualized if - it contains + # valid amount or range. - and its expected_units_per_year is set or can be + # derived. Its annualized range is determined as (amount or range) times # expected_units_per_year. class ExtendedCompensationInfoCompensationEntry include Google::Apis::Core::Hashable - # Deprecated. See CompensationInfo. - # Decimal number. + # Deprecated. See CompensationInfo. Decimal number. # Corresponds to the JSON property `amount` # @return [Google::Apis::JobsV2::ExtendedCompensationInfoDecimal] attr_accessor :amount @@ -1179,14 +1103,12 @@ module Google # @return [String] attr_accessor :description - # Deprecated. See CompensationInfo. - # Decimal number. + # Deprecated. See CompensationInfo. Decimal number. # Corresponds to the JSON property `expectedUnitsPerYear` # @return [Google::Apis::JobsV2::ExtendedCompensationInfoDecimal] attr_accessor :expected_units_per_year - # Deprecated. See CompensationInfo. - # Compensation range. + # Deprecated. See CompensationInfo. Compensation range. # Corresponds to the JSON property `range` # @return [Google::Apis::JobsV2::ExtendedCompensationInfoCompensationRange] attr_accessor :range @@ -1196,8 +1118,8 @@ module Google # @return [String] attr_accessor :type - # Optional. Frequency of the specified amount. - # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. + # Optional. Frequency of the specified amount. Default is CompensationUnit. + # COMPENSATION_UNIT_UNSPECIFIED. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit @@ -1224,19 +1146,16 @@ module Google end end - # Deprecated. See CompensationInfo. - # Compensation range. + # Deprecated. See CompensationInfo. Compensation range. class ExtendedCompensationInfoCompensationRange include Google::Apis::Core::Hashable - # Deprecated. See CompensationInfo. - # Decimal number. + # Deprecated. See CompensationInfo. Decimal number. # Corresponds to the JSON property `max` # @return [Google::Apis::JobsV2::ExtendedCompensationInfoDecimal] attr_accessor :max - # Deprecated. See CompensationInfo. - # Decimal number. + # Deprecated. See CompensationInfo. Decimal number. # Corresponds to the JSON property `min` # @return [Google::Apis::JobsV2::ExtendedCompensationInfoDecimal] attr_accessor :min @@ -1252,17 +1171,15 @@ module Google end end - # Deprecated. See CompensationInfo. - # Decimal number. + # Deprecated. See CompensationInfo. Decimal number. class ExtendedCompensationInfoDecimal include Google::Apis::Core::Hashable - # Micro (10^-6) units. - # The value must be between -999,999 and +999,999 inclusive. - # If `units` is positive, `micros` must be positive or zero. - # If `units` is zero, `micros` can be positive, zero, or negative. - # If `units` is negative, `micros` must be negative or zero. - # For example -1.75 is represented as `units`=-1 and `micros`=-750,000. + # Micro (10^-6) units. The value must be between -999,999 and +999,999 inclusive. + # If `units` is positive, `micros` must be positive or zero. If `units` is zero, + # `micros` can be positive, zero, or negative. If `units` is negative, `micros` + # must be negative or zero. For example -1.75 is represented as `units`=-1 and ` + # micros`=-750,000. # Corresponds to the JSON property `micros` # @return [Fixnum] attr_accessor :micros @@ -1283,18 +1200,15 @@ module Google end end - # Deprecated. Use BatchDeleteJobsRequest instead. - # Input only. - # Filter for jobs to be deleted. + # Deprecated. Use BatchDeleteJobsRequest instead. Input only. Filter for jobs to + # be deleted. class Filter include Google::Apis::Core::Hashable # Required. The requisition ID (or posting ID) assigned by the client to - # identify a - # job. This is intended for client identification and tracking of - # listings. - # name takes precedence over this field - # The maximum number of allowed characters is 225. + # identify a job. This is intended for client identification and tracking of + # listings. name takes precedence over this field The maximum number of allowed + # characters is 225. # Corresponds to the JSON property `requisitionId` # @return [String] attr_accessor :requisition_id @@ -1309,49 +1223,43 @@ module Google end end - # Deprecated. Use SearchJobsRequest.histogram_facets instead to make - # a single call with both search and histogram. - # Input only. - # A request for the `GetHistogram` method. + # Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single + # call with both search and histogram. Input only. A request for the ` + # GetHistogram` method. class GetHistogramRequest include Google::Apis::Core::Hashable # Optional. Controls whether to broaden the search to avoid too few results for - # a - # given query in instances where a search has sparse results. Results from a - # broadened query is a superset of the results from the original query. - # Defaults to false. + # a given query in instances where a search has sparse results. Results from a + # broadened query is a superset of the results from the original query. Defaults + # to false. # Corresponds to the JSON property `allowBroadening` # @return [Boolean] attr_accessor :allow_broadening alias_method :allow_broadening?, :allow_broadening - # Input only. - # Deprecated. Use JobQuery instead. - # The filters required to perform a search query or histogram. + # Input only. Deprecated. Use JobQuery instead. The filters required to perform + # a search query or histogram. # Corresponds to the JSON property `filters` # @return [Google::Apis::JobsV2::JobFilters] attr_accessor :filters - # Input only. - # The query required to perform a search query or histogram. + # Input only. The query required to perform a search query or histogram. # Corresponds to the JSON property `query` # @return [Google::Apis::JobsV2::JobQuery] attr_accessor :query - # Input only. - # Meta information related to the job searcher or entity - # conducting the job search. This information is used to improve the - # performance of the service. + # Input only. Meta information related to the job searcher or entity conducting + # the job search. This information is used to improve the performance of the + # service. # Corresponds to the JSON property `requestMetadata` # @return [Google::Apis::JobsV2::RequestMetadata] attr_accessor :request_metadata # Required. A list of facets that specify the histogram data to be calculated - # against and returned. - # Histogram response times can be slow, and counts - # can be approximations. This call may be temporarily or permanently removed - # prior to the production release of Cloud Talent Solution. + # against and returned. Histogram response times can be slow, and counts can be + # approximations. This call may be temporarily or permanently removed prior to + # the production release of Cloud Talent Solution. # Corresponds to the JSON property `searchTypes` # @return [Array] attr_accessor :search_types @@ -1370,15 +1278,13 @@ module Google end end - # Deprecated. Use SearchJobsRequest.histogram_facets instead to make - # a single call with both search and histogram. - # Output only. - # The response of the GetHistogram method. + # Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single + # call with both search and histogram. Output only. The response of the + # GetHistogram method. class GetHistogramResponse include Google::Apis::Core::Hashable - # Output only. - # Additional information returned to client, such as debugging + # Output only. Additional information returned to client, such as debugging # information. # Corresponds to the JSON property `metadata` # @return [Google::Apis::JobsV2::ResponseMetadata] @@ -1400,26 +1306,24 @@ module Google end end - # Input only. - # Histogram facets to be specified in SearchJobsRequest. + # Input only. Histogram facets to be specified in SearchJobsRequest. class HistogramFacets include Google::Apis::Core::Hashable - # Optional. Specifies compensation field-based histogram requests. - # Duplicate values of CompensationHistogramRequest.type are not allowed. + # Optional. Specifies compensation field-based histogram requests. Duplicate + # values of CompensationHistogramRequest.type are not allowed. # Corresponds to the JSON property `compensationHistogramFacets` # @return [Array] attr_accessor :compensation_histogram_facets - # Optional. Specifies the custom attributes histogram requests. - # Duplicate values of CustomAttributeHistogramRequest.key are not - # allowed. + # Optional. Specifies the custom attributes histogram requests. Duplicate values + # of CustomAttributeHistogramRequest.key are not allowed. # Corresponds to the JSON property `customAttributeHistogramFacets` # @return [Array] attr_accessor :custom_attribute_histogram_facets - # Optional. Specifies the simple type of histogram facets, for example, - # `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. This field is equivalent to + # Optional. Specifies the simple type of histogram facets, for example, ` + # COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. This field is equivalent to # GetHistogramRequest. # Corresponds to the JSON property `simpleHistogramFacets` # @return [Array] @@ -1437,11 +1341,9 @@ module Google end end - # Output only. - # Result of a histogram call. The response contains the histogram map for the - # search type specified by HistogramResult.field. - # The response is a map of each filter value to the corresponding count of - # jobs for that filter. + # Output only. Result of a histogram call. The response contains the histogram + # map for the search type specified by HistogramResult.field. The response is a + # map of each filter value to the corresponding count of jobs for that filter. class HistogramResult include Google::Apis::Core::Hashable @@ -1450,9 +1352,8 @@ module Google # @return [String] attr_accessor :search_type - # A map from the values of field to the number of jobs with that value - # in this search result. - # Key: search type (filter names, such as the companyName). + # A map from the values of field to the number of jobs with that value in this + # search result. Key: search type (filter names, such as the companyName). # Values: the count of jobs that match the filter for this search. # Corresponds to the JSON property `values` # @return [Hash] @@ -1469,8 +1370,7 @@ module Google end end - # Output only. - # Histogram results that matches HistogramFacets specified in + # Output only. Histogram results that matches HistogramFacets specified in # SearchJobsRequest. class HistogramResults include Google::Apis::Core::Hashable @@ -1481,14 +1381,14 @@ module Google # @return [Array] attr_accessor :compensation_histogram_results - # Specifies histogram results for custom attributes that - # matches HistogramFacets.custom_attribute_histogram_facets. + # Specifies histogram results for custom attributes that matches HistogramFacets. + # custom_attribute_histogram_facets. # Corresponds to the JSON property `customAttributeHistogramResults` # @return [Array] attr_accessor :custom_attribute_histogram_results - # Specifies histogram results that matches - # HistogramFacets.simple_histogram_facets. + # Specifies histogram results that matches HistogramFacets. + # simple_histogram_facets. # Corresponds to the JSON property `simpleHistogramResults` # @return [Array] attr_accessor :simple_histogram_results @@ -1506,39 +1406,33 @@ module Google end # A Job resource represents a job posting (also referred to as a "job listing" - # or "job requisition"). A job belongs to a Company, which is the hiring - # entity responsible for the job. + # or "job requisition"). A job belongs to a Company, which is the hiring entity + # responsible for the job. class Job include Google::Apis::Core::Hashable - # Optional but at least one of application_urls, - # application_email_list or application_instruction must be - # specified. - # Use this field to specify email address(es) to which resumes or - # applications can be sent. - # The maximum number of allowed characters is 255. + # Optional but at least one of application_urls, application_email_list or + # application_instruction must be specified. Use this field to specify email + # address(es) to which resumes or applications can be sent. The maximum number + # of allowed characters is 255. # Corresponds to the JSON property `applicationEmailList` # @return [Array] attr_accessor :application_email_list - # Optional but at least one of application_urls, - # application_email_list or application_instruction must be - # specified. - # Use this field to provide instructions, such as "Mail your application - # to ...", that a candidate can follow to apply for the job. - # This field accepts and sanitizes HTML input, and also accepts - # bold, italic, ordered list, and unordered list markup tags. - # The maximum number of allowed characters is 3,000. + # Optional but at least one of application_urls, application_email_list or + # application_instruction must be specified. Use this field to provide + # instructions, such as "Mail your application to ...", that a candidate can + # follow to apply for the job. This field accepts and sanitizes HTML input, and + # also accepts bold, italic, ordered list, and unordered list markup tags. The + # maximum number of allowed characters is 3,000. # Corresponds to the JSON property `applicationInstruction` # @return [String] attr_accessor :application_instruction - # Optional but at least one of application_urls, - # application_email_list or application_instruction must be - # specified. - # Use this URL field to direct an applicant to a website, for example to - # link to an online application form. - # The maximum number of allowed characters is 2,000. + # Optional but at least one of application_urls, application_email_list or + # application_instruction must be specified. Use this URL field to direct an + # applicant to a website, for example to link to an online application form. The + # maximum number of allowed characters is 2,000. # Corresponds to the JSON property `applicationUrls` # @return [Array] attr_accessor :application_urls @@ -1553,18 +1447,16 @@ module Google # @return [String] attr_accessor :company_display_name - # Optional but one of company_name or distributor_company_id must be - # provided. - # The resource name of the company listing the job, such as - # /companies/foo. This field takes precedence over the - # distributor-assigned company identifier, distributor_company_id. + # Optional but one of company_name or distributor_company_id must be provided. + # The resource name of the company listing the job, such as /companies/foo. This + # field takes precedence over the distributor-assigned company identifier, + # distributor_company_id. # Corresponds to the JSON property `companyName` # @return [String] attr_accessor :company_name - # Deprecated. Use company_display_name instead. - # Output only. - # The name of the company listing the job. + # Deprecated. Use company_display_name instead. Output only. The name of the + # company listing the job. # Corresponds to the JSON property `companyTitle` # @return [String] attr_accessor :company_title @@ -1580,152 +1472,130 @@ module Google attr_accessor :create_time # Optional. A map of fields to hold both filterable and non-filterable custom - # job - # attributes that are not covered by the provided structured fields. - # This field is a more general combination of the deprecated id-based - # filterable_custom_fields and string-based - # non_filterable_custom_fields. - # The keys of the map are strings up to 64 bytes and must match the - # pattern: a-zA-Z*. - # At most 100 filterable and at most 100 unfilterable keys are supported. - # For filterable `string_values`, across all keys at most 200 values are - # allowed, with each string no more than 255 characters. For unfilterable - # `string_values`, the maximum total size of `string_values` across all keys - # is 50KB. + # job attributes that are not covered by the provided structured fields. This + # field is a more general combination of the deprecated id-based + # filterable_custom_fields and string-based non_filterable_custom_fields. The + # keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. + # At most 100 filterable and at most 100 unfilterable keys are supported. For + # filterable `string_values`, across all keys at most 200 values are allowed, + # with each string no more than 255 characters. For unfilterable `string_values`, + # the maximum total size of `string_values` across all keys is 50KB. # Corresponds to the JSON property `customAttributes` # @return [Hash] attr_accessor :custom_attributes # Optional. The department or functional area within the company with the open - # position. - # The maximum number of allowed characters is 255. + # position. The maximum number of allowed characters is 255. # Corresponds to the JSON property `department` # @return [String] attr_accessor :department # Required. The description of the job, which typically includes a multi- - # paragraph - # description of the company and related information. Separate fields are - # provided on the job object for responsibilities, - # qualifications, and other job characteristics. Use of - # these separate job fields is recommended. - # This field accepts and sanitizes HTML input, and also accepts - # bold, italic, ordered list, and unordered list markup tags. - # The maximum number of allowed characters is 100,000. + # paragraph description of the company and related information. Separate fields + # are provided on the job object for responsibilities, qualifications, and other + # job characteristics. Use of these separate job fields is recommended. This + # field accepts and sanitizes HTML input, and also accepts bold, italic, ordered + # list, and unordered list markup tags. The maximum number of allowed characters + # is 100,000. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Optional but one of company_name or distributor_company_id must be - # provided. - # A unique company identifier used by job distributors to identify an - # employer's company entity. company_name takes precedence over - # this field, and is the recommended field to use to identify companies. - # The maximum number of allowed characters is 255. + # Optional but one of company_name or distributor_company_id must be provided. A + # unique company identifier used by job distributors to identify an employer's + # company entity. company_name takes precedence over this field, and is the + # recommended field to use to identify companies. The maximum number of allowed + # characters is 255. # Corresponds to the JSON property `distributorCompanyId` # @return [String] attr_accessor :distributor_company_id - # Optional. The desired education level for the job, such as - # "Bachelors", "Masters", "Doctorate". + # Optional. The desired education level for the job, such as "Bachelors", " + # Masters", "Doctorate". # Corresponds to the JSON property `educationLevels` # @return [Array] attr_accessor :education_levels - # Optional. The employment type(s) of a job, for example, - # full time or - # part time. + # Optional. The employment type(s) of a job, for example, full time or part time. # Corresponds to the JSON property `employmentTypes` # @return [Array] attr_accessor :employment_types # Represents a whole or partial calendar date, e.g. a birthday. The time of day # and time zone are either specified elsewhere or are not significant. The date - # is relative to the Proleptic Gregorian Calendar. This can represent: - # * A full date, with non-zero year, month and day values - # * A month and day value, with a zero year, e.g. an anniversary - # * A year on its own, with zero month and day values - # * A year and month value, with a zero day, e.g. a credit card expiration date - # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + # is relative to the Proleptic Gregorian Calendar. This can represent: * A full + # date, with non-zero year, month and day values * A month and day value, with a + # zero year, e.g. an anniversary * A year on its own, with zero month and day + # values * A year and month value, with a zero day, e.g. a credit card + # expiration date Related types are google.type.TimeOfDay and `google.protobuf. + # Timestamp`. # Corresponds to the JSON property `endDate` # @return [Google::Apis::JobsV2::Date] attr_accessor :end_date - # Optional but strongly recommended for the best service - # experience. - # The expiration timestamp of the job. After this timestamp, the - # job is marked as expired, and it no longer appears in search results. The - # expired job can't be deleted or listed by the DeleteJob and - # ListJobs APIs, but it can be retrieved with the GetJob API or - # updated with the UpdateJob API. An expired job can be updated and - # opened again by using a future expiration timestamp. Updating an expired - # job fails if there is another existing open job with same - # requisition_id, company_name and language_code. - # The expired jobs are retained in our system for 90 days. However, the - # overall expired job count cannot exceed 3 times the maximum of open jobs - # count over the past week, otherwise jobs with earlier expire time are - # cleaned first. Expired jobs are no longer accessible after they are cleaned - # out. - # The format of this field is RFC 3339 date strings. Example: - # 2000-01-01T00:00:00.999999999Z - # See - # [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). - # A valid date range is between 1970-01-01T00:00:00.0Z and - # 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire - # time not provided. - # If this value is not provided at the time of job creation or is invalid, - # the job posting expires after 30 days from the job's creation time. For - # example, if the job was created on 2017/01/01 13:00AM UTC with an - # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. - # If this value is not provided but expiry_date is, expiry_date is - # used. - # If this value is not provided on job update, it depends on the field masks - # set by UpdateJobRequest.update_job_fields. If the field masks include - # expiry_time, or the masks are empty meaning that every field is - # updated, the job posting expires after 30 days from the job's last - # update time. Otherwise the expiration date isn't updated. + # Optional but strongly recommended for the best service experience. The + # expiration timestamp of the job. After this timestamp, the job is marked as + # expired, and it no longer appears in search results. The expired job can't be + # deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved + # with the GetJob API or updated with the UpdateJob API. An expired job can be + # updated and opened again by using a future expiration timestamp. Updating an + # expired job fails if there is another existing open job with same + # requisition_id, company_name and language_code. The expired jobs are retained + # in our system for 90 days. However, the overall expired job count cannot + # exceed 3 times the maximum of open jobs count over the past week, otherwise + # jobs with earlier expire time are cleaned first. Expired jobs are no longer + # accessible after they are cleaned out. The format of this field is RFC 3339 + # date strings. Example: 2000-01-01T00:00:00.999999999Z See [https://www.ietf. + # org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). A valid date range + # is between 1970-01-01T00:00:00.0Z and 2100-12-31T23:59:59.999Z. Invalid dates + # are ignored and treated as expire time not provided. If this value is not + # provided at the time of job creation or is invalid, the job posting expires + # after 30 days from the job's creation time. For example, if the job was + # created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job + # expires after 2017/01/31 13:00AM UTC. If this value is not provided but + # expiry_date is, expiry_date is used. If this value is not provided on job + # update, it depends on the field masks set by UpdateJobRequest. + # update_job_fields. If the field masks include expiry_time, or the masks are + # empty meaning that every field is updated, the job posting expires after 30 + # days from the job's last update time. Otherwise the expiration date isn't + # updated. # Corresponds to the JSON property `expireTime` # @return [String] attr_accessor :expire_time # Represents a whole or partial calendar date, e.g. a birthday. The time of day # and time zone are either specified elsewhere or are not significant. The date - # is relative to the Proleptic Gregorian Calendar. This can represent: - # * A full date, with non-zero year, month and day values - # * A month and day value, with a zero year, e.g. an anniversary - # * A year on its own, with zero month and day values - # * A year and month value, with a zero day, e.g. a credit card expiration date - # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + # is relative to the Proleptic Gregorian Calendar. This can represent: * A full + # date, with non-zero year, month and day values * A month and day value, with a + # zero year, e.g. an anniversary * A year on its own, with zero month and day + # values * A year and month value, with a zero day, e.g. a credit card + # expiration date Related types are google.type.TimeOfDay and `google.protobuf. + # Timestamp`. # Corresponds to the JSON property `expiryDate` # @return [Google::Apis::JobsV2::Date] attr_accessor :expiry_date - # Deprecated. Use CompensationInfo. - # Describes job compensation. + # Deprecated. Use CompensationInfo. Describes job compensation. # Corresponds to the JSON property `extendedCompensationInfo` # @return [Google::Apis::JobsV2::ExtendedCompensationInfo] attr_accessor :extended_compensation_info - # Deprecated. Use custom_attributes instead. - # Optional. - # A map of fields to hold filterable custom job attributes not captured by - # the standard fields such as job_title, company_name, or - # level. These custom fields store arbitrary - # string values, and can be used for purposes not covered by - # the structured fields. For the best search experience, use of the - # structured rather than custom fields is recommended. - # Data stored in these custom fields fields are indexed and - # searched against by keyword searches (see - # SearchJobsRequest.custom_field_filters][]). - # The map key must be a number between 1-20. If an invalid key is - # provided on job create or update, an error is returned. + # Deprecated. Use custom_attributes instead. Optional. A map of fields to hold + # filterable custom job attributes not captured by the standard fields such as + # job_title, company_name, or level. These custom fields store arbitrary string + # values, and can be used for purposes not covered by the structured fields. For + # the best search experience, use of the structured rather than custom fields is + # recommended. Data stored in these custom fields fields are indexed and + # searched against by keyword searches (see SearchJobsRequest. + # custom_field_filters][]). The map key must be a number between 1-20. If an + # invalid key is provided on job create or update, an error is returned. # Corresponds to the JSON property `filterableCustomFields` # @return [Hash] attr_accessor :filterable_custom_fields # Optional. A description of bonus, commission, and other compensation - # incentives associated with the job not including salary or pay. - # The maximum number of allowed characters is 10,000. + # incentives associated with the job not including salary or pay. The maximum + # number of allowed characters is 10,000. # Corresponds to the JSON property `incentives` # @return [String] attr_accessor :incentives @@ -1735,21 +1605,19 @@ module Google # @return [Array] attr_accessor :job_locations - # Required. The title of the job, such as "Software Engineer" - # The maximum number of allowed characters is 500. + # Required. The title of the job, such as "Software Engineer" The maximum number + # of allowed characters is 500. # Corresponds to the JSON property `jobTitle` # @return [String] attr_accessor :job_title - # Optional. The language of the posting. This field is distinct from - # any requirements for fluency that are associated with the job. - # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". - # For more information, see - # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47)`: - # class="external" target="_blank" `. - # If this field is unspecified and Job.description is present, detected - # language code based on Job.description is assigned, otherwise - # defaults to 'en_US'. + # Optional. The language of the posting. This field is distinct from any + # requirements for fluency that are associated with the job. Language codes must + # be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [ + # Tags for Identifying Languages](https://tools.ietf.org/html/bcp47)`: class=" + # external" target="_blank" `. If this field is unspecified and Job.description + # is present, detected language code based on Job.description is assigned, + # otherwise defaults to 'en_US'. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -1759,59 +1627,55 @@ module Google # @return [String] attr_accessor :level - # Optional but strongly recommended for the best service experience. - # Location(s) where the emploeyer is looking to hire for this job posting. - # Specifying the full street address(es) of the hiring location enables - # better API results, especially job searches by commute time. - # At most 50 locations are allowed for best search performance. If a job has - # more locations, it is suggested to split it into multiple jobs with unique - # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as - # multiple jobs with the same requisition_id, company_name and - # language_code are not allowed. If the original requisition_id must - # be preserved, a custom field should be used for storage. It is also - # suggested to group the locations that close to each other in the same job - # for better search experience. - # The maximum number of allowed characters is 500. + # Optional but strongly recommended for the best service experience. Location(s) + # where the emploeyer is looking to hire for this job posting. Specifying the + # full street address(es) of the hiring location enables better API results, + # especially job searches by commute time. At most 50 locations are allowed for + # best search performance. If a job has more locations, it is suggested to split + # it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1' + # , 'ReqA-2', etc.) as multiple jobs with the same requisition_id, company_name + # and language_code are not allowed. If the original requisition_id must be + # preserved, a custom field should be used for storage. It is also suggested to + # group the locations that close to each other in the same job for better search + # experience. The maximum number of allowed characters is 500. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations - # Required during job update. - # Resource name assigned to a job by the API, for example, "/jobs/foo". Use - # of this field in job queries and API calls is preferred over the use of - # requisition_id since this value is unique. + # Required during job update. Resource name assigned to a job by the API, for + # example, "/jobs/foo". Use of this field in job queries and API calls is + # preferred over the use of requisition_id since this value is unique. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Optional. A promotion value of the job, as determined by the client. - # The value determines the sort order of the jobs returned when searching for - # jobs using the featured jobs search call, with higher promotional values - # being returned first and ties being resolved by relevance sort. Only the - # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. - # Default value is 0, and negative values are treated as 0. + # Optional. A promotion value of the job, as determined by the client. The value + # determines the sort order of the jobs returned when searching for jobs using + # the featured jobs search call, with higher promotional values being returned + # first and ties being resolved by relevance sort. Only the jobs with a + # promotionValue >0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, + # and negative values are treated as 0. # Corresponds to the JSON property `promotionValue` # @return [Fixnum] attr_accessor :promotion_value # Represents a whole or partial calendar date, e.g. a birthday. The time of day # and time zone are either specified elsewhere or are not significant. The date - # is relative to the Proleptic Gregorian Calendar. This can represent: - # * A full date, with non-zero year, month and day values - # * A month and day value, with a zero year, e.g. an anniversary - # * A year on its own, with zero month and day values - # * A year and month value, with a zero day, e.g. a credit card expiration date - # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + # is relative to the Proleptic Gregorian Calendar. This can represent: * A full + # date, with non-zero year, month and day values * A month and day value, with a + # zero year, e.g. an anniversary * A year on its own, with zero month and day + # values * A year and month value, with a zero day, e.g. a credit card + # expiration date Related types are google.type.TimeOfDay and `google.protobuf. + # Timestamp`. # Corresponds to the JSON property `publishDate` # @return [Google::Apis::JobsV2::Date] attr_accessor :publish_date - # Optional. A description of the qualifications required to perform the - # job. The use of this field is recommended - # as an alternative to using the more general description field. - # This field accepts and sanitizes HTML input, and also accepts - # bold, italic, ordered list, and unordered list markup tags. - # The maximum number of allowed characters is 10,000. + # Optional. A description of the qualifications required to perform the job. The + # use of this field is recommended as an alternative to using the more general + # description field. This field accepts and sanitizes HTML input, and also + # accepts bold, italic, ordered list, and unordered list markup tags. The + # maximum number of allowed characters is 10,000. # Corresponds to the JSON property `qualifications` # @return [String] attr_accessor :qualifications @@ -1822,56 +1686,49 @@ module Google attr_accessor :reference_url # Optional. The job Region (for example, state, country) throughout which the - # job - # is available. If this field is set, a - # LocationFilter in a search query within the job region - # finds this job if an exact location match is not specified. - # If this field is set, setting job locations - # to the same location level as this field is strongly recommended. + # job is available. If this field is set, a LocationFilter in a search query + # within the job region finds this job if an exact location match is not + # specified. If this field is set, setting job locations to the same location + # level as this field is strongly recommended. # Corresponds to the JSON property `region` # @return [String] attr_accessor :region # Required. The requisition ID, also referred to as the posting ID, assigned by - # the - # client to identify a job. This field is intended to be used by clients - # for client identification and tracking of listings. A job is not allowed - # to be created if there is another job with the same requisition_id, - # company_name and language_code. - # The maximum number of allowed characters is 255. + # the client to identify a job. This field is intended to be used by clients for + # client identification and tracking of listings. A job is not allowed to be + # created if there is another job with the same requisition_id, company_name and + # language_code. The maximum number of allowed characters is 255. # Corresponds to the JSON property `requisitionId` # @return [String] attr_accessor :requisition_id # Optional. A description of job responsibilities. The use of this field is - # recommended as an alternative to using the more general description - # field. - # This field accepts and sanitizes HTML input, and also accepts - # bold, italic, ordered list, and unordered list markup tags. - # The maximum number of allowed characters is 10,000. + # recommended as an alternative to using the more general description field. + # This field accepts and sanitizes HTML input, and also accepts bold, italic, + # ordered list, and unordered list markup tags. The maximum number of allowed + # characters is 10,000. # Corresponds to the JSON property `responsibilities` # @return [String] attr_accessor :responsibilities # Represents a whole or partial calendar date, e.g. a birthday. The time of day # and time zone are either specified elsewhere or are not significant. The date - # is relative to the Proleptic Gregorian Calendar. This can represent: - # * A full date, with non-zero year, month and day values - # * A month and day value, with a zero year, e.g. an anniversary - # * A year on its own, with zero month and day values - # * A year and month value, with a zero day, e.g. a credit card expiration date - # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + # is relative to the Proleptic Gregorian Calendar. This can represent: * A full + # date, with non-zero year, month and day values * A month and day value, with a + # zero year, e.g. an anniversary * A year on its own, with zero month and day + # values * A year and month value, with a zero day, e.g. a credit card + # expiration date Related types are google.type.TimeOfDay and `google.protobuf. + # Timestamp`. # Corresponds to the JSON property `startDate` # @return [Google::Apis::JobsV2::Date] attr_accessor :start_date - # Deprecated. Use custom_attributes instead. - # Optional. - # A map of fields to hold non-filterable custom job attributes, similar to - # filterable_custom_fields. These fields are distinct in that the data - # in these fields are not indexed. Therefore, the client cannot search - # against them, nor can the client use them to list jobs. - # The key of the map can be any valid string. + # Deprecated. Use custom_attributes instead. Optional. A map of fields to hold + # non-filterable custom job attributes, similar to filterable_custom_fields. + # These fields are distinct in that the data in these fields are not indexed. + # Therefore, the client cannot search against them, nor can the client use them + # to list jobs. The key of the map can be any valid string. # Corresponds to the JSON property `unindexedCustomFields` # @return [Hash] attr_accessor :unindexed_custom_fields @@ -1881,9 +1738,8 @@ module Google # @return [String] attr_accessor :update_time - # Optional. The visibility of the job. - # Defaults to JobVisibility.PRIVATE if not specified. - # Currently only JobVisibility.PRIVATE is supported. + # Optional. The visibility of the job. Defaults to JobVisibility.PRIVATE if not + # specified. Currently only JobVisibility.PRIVATE is supported. # Corresponds to the JSON property `visibility` # @return [String] attr_accessor :visibility @@ -1935,157 +1791,132 @@ module Google end end - # Input only. - # Deprecated. Use JobQuery instead. - # The filters required to perform a search query or histogram. + # Input only. Deprecated. Use JobQuery instead. The filters required to perform + # a search query or histogram. class JobFilters include Google::Apis::Core::Hashable # Optional. The category filter specifies the categories of jobs to search - # against. - # See Category for more information. - # If a value is not specified, jobs from any category are searched against. - # If multiple values are specified, jobs from any of the specified - # categories are searched against. + # against. See Category for more information. If a value is not specified, jobs + # from any category are searched against. If multiple values are specified, jobs + # from any of the specified categories are searched against. # Corresponds to the JSON property `categories` # @return [Array] attr_accessor :categories - # Input only. - # Parameters needed for commute search. + # Input only. Parameters needed for commute search. # Corresponds to the JSON property `commuteFilter` # @return [Google::Apis::JobsV2::CommutePreference] attr_accessor :commute_filter # Optional. The company names filter specifies the company entities to search - # against. - # If a value is not specified, jobs are searched for against all companies. - # If multiple values are specified, jobs are searched against the - # specified companies. - # At most 20 company filters are allowed. + # against. If a value is not specified, jobs are searched for against all + # companies. If multiple values are specified, jobs are searched against the + # specified companies. At most 20 company filters are allowed. # Corresponds to the JSON property `companyNames` # @return [Array] attr_accessor :company_names - # Optional. This filter specifies the exact company titles - # of jobs to search against. - # If a value is not specified, jobs within the search results can be - # associated with any company. - # If multiple values are specified, jobs within the search results may be - # associated with any of the specified companies. - # At most 20 company title filters are allowed. + # Optional. This filter specifies the exact company titles of jobs to search + # against. If a value is not specified, jobs within the search results can be + # associated with any company. If multiple values are specified, jobs within the + # search results may be associated with any of the specified companies. At most + # 20 company title filters are allowed. # Corresponds to the JSON property `companyTitles` # @return [Array] attr_accessor :company_titles - # Input only. - # Filter on job compensation type and amount. + # Input only. Filter on job compensation type and amount. # Corresponds to the JSON property `compensationFilter` # @return [Google::Apis::JobsV2::CompensationFilter] attr_accessor :compensation_filter - # Optional. This filter specifies a structured syntax to match against the - # Job.custom_attributes that are marked as `filterable`. - # The syntax for this expression is a subset of Google SQL syntax. - # Supported operators are: =, !=, <, <=, >, >= where the left of the operator - # is a custom field key and the right of the operator is a number or string - # (surrounded by quotes) value. - # Supported functions are LOWER() to - # perform case insensitive match and EMPTY() 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"), and there can - # be a maximum of 100 comparisons/functions in the expression. The expression - # must be < 3000 bytes in length. - # Sample Query: - # (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100 + # Optional. This filter specifies a structured syntax to match against the Job. + # custom_attributes that are marked as `filterable`. The syntax for this + # expression is a subset of Google SQL syntax. Supported operators are: =, !=, <, + # <=, >, >= where the left of the operator is a custom field key and the right + # of the operator is a number or string (surrounded by quotes) value. Supported + # functions are LOWER() to perform case insensitive match and EMPTY() 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"), and + # there can be a maximum of 100 comparisons/functions in the expression. The + # expression must be < 3000 bytes in length. Sample Query: (key1 = "TEST" OR + # LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100 # Corresponds to the JSON property `customAttributeFilter` # @return [String] attr_accessor :custom_attribute_filter - # Deprecated. Use custom_attribute_filter instead. - # Optional. - # This filter specifies searching against - # custom field values. See Job.filterable_custom_fields for information. - # The key value specifies a number between 1-20 (the service - # supports 20 custom fields) corresponding to the desired custom field map - # value. If an invalid key is provided or specified together with - # custom_attribute_filter, an error is thrown. + # Deprecated. Use custom_attribute_filter instead. Optional. This filter + # specifies searching against custom field values. See Job. + # filterable_custom_fields for information. The key value specifies a number + # between 1-20 (the service supports 20 custom fields) corresponding to the + # desired custom field map value. If an invalid key is provided or specified + # together with custom_attribute_filter, an error is thrown. # Corresponds to the JSON property `customFieldFilters` # @return [Hash] attr_accessor :custom_field_filters - # Optional. This flag controls the spell-check feature. If false, the - # service attempts to correct a misspelled query, - # for example, "enginee" is corrected to "engineer". - # Defaults to false: a spell check is performed. + # Optional. This flag controls the spell-check feature. If false, the service + # attempts to correct a misspelled query, for example, "enginee" is corrected to + # "engineer". Defaults to false: a spell check is performed. # Corresponds to the JSON property `disableSpellCheck` # @return [Boolean] attr_accessor :disable_spell_check alias_method :disable_spell_check?, :disable_spell_check # Optional. The employment type filter specifies the employment type of jobs to - # search against, such as EmploymentType.FULL_TIME. - # If a value is not specified, jobs in the search results include any - # employment type. - # If multiple values are specified, jobs in the search results include any - # of the specified employment types. + # search against, such as EmploymentType.FULL_TIME. If a value is not specified, + # jobs in the search results include any employment type. If multiple values are + # specified, jobs in the search results include any of the specified employment + # types. # Corresponds to the JSON property `employmentTypes` # @return [Array] attr_accessor :employment_types - # Deprecated. Always use CompensationFilter. - # Input only. - # Filter on job compensation type and amount. + # Deprecated. Always use CompensationFilter. Input only. Filter on job + # compensation type and amount. # Corresponds to the JSON property `extendedCompensationFilter` # @return [Google::Apis::JobsV2::ExtendedCompensationFilter] attr_accessor :extended_compensation_filter - # Optional. This filter specifies the locale of jobs to search against, - # for example, "en-US". - # If a value is not specified, the search results may contain jobs in any - # locale. - # Language codes should be in BCP-47 format, for example, "en-US" or - # "sr-Latn". For more information, see [Tags for Identifying - # Languages](https://tools.ietf.org/html/bcp47). - # At most 10 language code filters are allowed. + # Optional. This filter specifies the locale of jobs to search against, for + # example, "en-US". If a value is not specified, the search results may contain + # jobs in any locale. Language codes should be in BCP-47 format, for example, " + # en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages] + # (https://tools.ietf.org/html/bcp47). At most 10 language code filters are + # allowed. # Corresponds to the JSON property `languageCodes` # @return [Array] attr_accessor :language_codes # Optional. The location filter specifies geo-regions containing the jobs to - # search against. See LocationFilter for more information. - # If a location value is not specified, jobs are retrieved - # from all locations. - # If multiple values are specified, jobs are retrieved from any of the - # specified locations. If different values are specified for the - # LocationFilter.distance_in_miles parameter, the maximum provided - # distance is used for all locations. - # At most 5 location filters are allowed. + # search against. See LocationFilter for more information. If a location value + # is not specified, jobs are retrieved from all locations. If multiple values + # are specified, jobs are retrieved from any of the specified locations. If + # different values are specified for the LocationFilter.distance_in_miles + # parameter, the maximum provided distance is used for all locations. At most 5 + # location filters are allowed. # Corresponds to the JSON property `locationFilters` # @return [Array] attr_accessor :location_filters # Optional. Jobs published within a range specified by this filter are searched - # against, for example, DateRange.PAST_MONTH. If a value is not - # specified, all open jobs are searched against regardless of the - # date they were published. + # against, for example, DateRange.PAST_MONTH. If a value is not specified, all + # open jobs are searched against regardless of the date they were published. # Corresponds to the JSON property `publishDateRange` # @return [String] attr_accessor :publish_date_range # Optional. The query filter contains the keywords that match against the job - # title, description, and location fields. - # The maximum query size is 255 bytes/characters. + # title, description, and location fields. The maximum query size is 255 bytes/ + # characters. # Corresponds to the JSON property `query` # @return [String] attr_accessor :query - # Deprecated. Do not use this field. - # This flag controls whether the job search should be restricted to jobs - # owned by the current user. - # Defaults to false where all jobs accessible to the - # user are searched against. + # Deprecated. Do not use this field. This flag controls whether the job search + # should be restricted to jobs owned by the current user. Defaults to false + # where all jobs accessible to the user are searched against. # Corresponds to the JSON property `tenantJobOnly` # @return [Boolean] attr_accessor :tenant_job_only @@ -2115,17 +1946,15 @@ module Google end end - # Output only. - # A resource that represents a location with full geographic + # Output only. A resource that represents a location with full geographic # information. class JobLocation include Google::Apis::Core::Hashable # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::JobsV2::LatLng] attr_accessor :lat_lng @@ -2140,27 +1969,22 @@ module Google # Represents a postal address, e.g. for postal delivery or payments addresses. # Given a postal address, a postal service can deliver items to a premise, P.O. - # Box or similar. - # It is not intended to model geographical locations (roads, towns, - # mountains). - # In typical usage an address would be created via user input or from importing - # existing data, depending on the type of process. - # Advice on address input / editing: - # - Use an i18n-ready address widget such as - # https://github.com/google/libaddressinput) - # - Users should not be presented with UI elements for input or editing of - # fields outside countries where that field is used. - # For more guidance on how to use this schema, please see: - # https://support.google.com/business/answer/6397478 + # Box or similar. It is not intended to model geographical locations (roads, + # towns, mountains). In typical usage an address would be created via user input + # or from importing existing data, depending on the type of process. Advice on + # address input / editing: - Use an i18n-ready address widget such as https:// + # github.com/google/libaddressinput) - Users should not be presented with UI + # elements for input or editing of fields outside countries where that field is + # used. For more guidance on how to use this schema, please see: https://support. + # google.com/business/answer/6397478 # Corresponds to the JSON property `postalAddress` # @return [Google::Apis::JobsV2::PostalAddress] attr_accessor :postal_address - # Radius in meters of the job location. This value is derived from the - # location bounding box in which a circle with the specified radius - # centered from LatLng coves the area associated with the job location. - # For example, currently, "Mountain View, CA, USA" has a radius of - # 7885.79 meters. + # Radius in meters of the job location. This value is derived from the location + # bounding box in which a circle with the specified radius centered from LatLng + # coves the area associated with the job location. For example, currently, " + # Mountain View, CA, USA" has a radius of 7885.79 meters. # Corresponds to the JSON property `radiusMeters` # @return [Float] attr_accessor :radius_meters @@ -2178,26 +2002,21 @@ module Google end end - # Input only. - # Options for job processing. + # Input only. Options for job processing. class JobProcessingOptions include Google::Apis::Core::Hashable - # Optional. If set to `true`, the service does not attempt to resolve a - # more precise address for the job. + # Optional. If set to `true`, the service does not attempt to resolve a more + # precise address for the job. # Corresponds to the JSON property `disableStreetAddressResolution` # @return [Boolean] attr_accessor :disable_street_address_resolution alias_method :disable_street_address_resolution?, :disable_street_address_resolution - # Optional. Option for job HTML content sanitization. Applied fields are: - # * description - # * applicationInstruction - # * incentives - # * qualifications - # * responsibilities - # HTML tags in these fields may be stripped if sanitiazation is not disabled. - # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. + # Optional. Option for job HTML content sanitization. Applied fields are: * + # description * applicationInstruction * incentives * qualifications * + # responsibilities HTML tags in these fields may be stripped if sanitiazation is + # not disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. # Corresponds to the JSON property `htmlSanitization` # @return [String] attr_accessor :html_sanitization @@ -2213,129 +2032,107 @@ module Google end end - # Input only. - # The query required to perform a search query or histogram. + # Input only. The query required to perform a search query or histogram. class JobQuery include Google::Apis::Core::Hashable # Optional. The category filter specifies the categories of jobs to search - # against. - # See Category for more information. - # If a value is not specified, jobs from any category are searched against. - # If multiple values are specified, jobs from any of the specified - # categories are searched against. + # against. See Category for more information. If a value is not specified, jobs + # from any category are searched against. If multiple values are specified, jobs + # from any of the specified categories are searched against. # Corresponds to the JSON property `categories` # @return [Array] attr_accessor :categories - # Input only. - # Parameters needed for commute search. + # Input only. Parameters needed for commute search. # Corresponds to the JSON property `commuteFilter` # @return [Google::Apis::JobsV2::CommutePreference] attr_accessor :commute_filter - # Optional. This filter specifies the exact company display - # name of the jobs to search against. - # If a value isn't specified, jobs within the search results are - # associated with any company. - # If multiple values are specified, jobs within the search results may be - # associated with any of the specified companies. - # At most 20 company display name filters are allowed. + # Optional. This filter specifies the exact company display name of the jobs to + # search against. If a value isn't specified, jobs within the search results are + # associated with any company. If multiple values are specified, jobs within the + # search results may be associated with any of the specified companies. At most + # 20 company display name filters are allowed. # Corresponds to the JSON property `companyDisplayNames` # @return [Array] attr_accessor :company_display_names - # Optional. This filter specifies the company entities to search against. - # If a value isn't specified, jobs are searched for against all - # companies. - # If multiple values are specified, jobs are searched against the - # companies specified. - # At most 20 company filters are allowed. + # Optional. This filter specifies the company entities to search against. If a + # value isn't specified, jobs are searched for against all companies. If + # multiple values are specified, jobs are searched against the companies + # specified. At most 20 company filters are allowed. # Corresponds to the JSON property `companyNames` # @return [Array] attr_accessor :company_names - # Input only. - # Filter on job compensation type and amount. + # Input only. Filter on job compensation type and amount. # Corresponds to the JSON property `compensationFilter` # @return [Google::Apis::JobsV2::CompensationFilter] attr_accessor :compensation_filter - # Optional. This filter specifies a structured syntax to match against the - # Job.custom_attributes marked as `filterable`. - # The syntax for this expression is a subset of Google SQL syntax. - # Supported operators are: =, !=, <, <=, >, >= where the left of the operator - # is a custom field key and the right of the operator is a number or string - # (surrounded by quotes) value. - # Supported functions are LOWER() to - # perform case insensitive match and EMPTY() 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 50 - # comparisons/functions are allowed in the expression. The expression - # must be < 2000 characters in length. - # Sample Query: - # (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100 + # Optional. This filter specifies a structured syntax to match against the Job. + # custom_attributes marked as `filterable`. The syntax for this expression is a + # subset of Google SQL syntax. Supported operators are: =, !=, <, <=, >, >= + # where the left of the operator is a custom field key and the right of the + # operator is a number or string (surrounded by quotes) value. Supported + # functions are LOWER() to perform case insensitive match and EMPTY() 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 50 comparisons/functions are allowed in the expression. The + # expression must be < 2000 characters in length. Sample Query: (key1 = "TEST" + # OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100 # Corresponds to the JSON property `customAttributeFilter` # @return [String] attr_accessor :custom_attribute_filter - # Optional. This flag controls the spell-check feature. If false, the - # service attempts to correct a misspelled query, - # for example, "enginee" is corrected to "engineer". - # Defaults to false: a spell check is performed. + # Optional. This flag controls the spell-check feature. If false, the service + # attempts to correct a misspelled query, for example, "enginee" is corrected to + # "engineer". Defaults to false: a spell check is performed. # Corresponds to the JSON property `disableSpellCheck` # @return [Boolean] attr_accessor :disable_spell_check alias_method :disable_spell_check?, :disable_spell_check # Optional. The employment type filter specifies the employment type of jobs to - # search against, such as EmploymentType.FULL_TIME. - # If a value is not specified, jobs in the search results include any - # employment type. - # If multiple values are specified, jobs in the search results include - # any of the specified employment types. + # search against, such as EmploymentType.FULL_TIME. If a value is not specified, + # jobs in the search results include any employment type. If multiple values are + # specified, jobs in the search results include any of the specified employment + # types. # Corresponds to the JSON property `employmentTypes` # @return [Array] attr_accessor :employment_types - # Optional. This filter specifies the locale of jobs to search against, - # for example, "en-US". - # If a value isn't specified, the search results can contain jobs in any - # locale. - # Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". - # For more information, see - # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). - # At most 10 language code filters are allowed. + # Optional. This filter specifies the locale of jobs to search against, for + # example, "en-US". If a value isn't specified, the search results can contain + # jobs in any locale. Language codes should be in BCP-47 format, such as "en-US" + # or "sr-Latn". For more information, see [Tags for Identifying Languages](https: + # //tools.ietf.org/html/bcp47). At most 10 language code filters are allowed. # Corresponds to the JSON property `languageCodes` # @return [Array] attr_accessor :language_codes # Optional. The location filter specifies geo-regions containing the jobs to - # search against. See LocationFilter for more information. - # If a location value isn't specified, jobs fitting the other search - # criteria are retrieved regardless of where they're located. - # If multiple values are specified, jobs are retrieved from any of the - # specified locations. If different values are specified for the - # LocationFilter.distance_in_miles parameter, the maximum provided - # distance is used for all locations. - # At most 5 location filters are allowed. + # search against. See LocationFilter for more information. If a location value + # isn't specified, jobs fitting the other search criteria are retrieved + # regardless of where they're located. If multiple values are specified, jobs + # are retrieved from any of the specified locations. If different values are + # specified for the LocationFilter.distance_in_miles parameter, the maximum + # provided distance is used for all locations. At most 5 location filters are + # allowed. # Corresponds to the JSON property `locationFilters` # @return [Array] attr_accessor :location_filters # Optional. Jobs published within a range specified by this filter are searched - # against, for example, DateRange.PAST_MONTH. If a value isn't - # specified, all open jobs are searched against regardless of their - # published date. + # against, for example, DateRange.PAST_MONTH. If a value isn't specified, all + # open jobs are searched against regardless of their published date. # Corresponds to the JSON property `publishDateRange` # @return [String] attr_accessor :publish_date_range # Optional. The query string that matches against the job title, description, - # and - # location fields. - # The maximum query size is 255 bytes. + # and location fields. The maximum query size is 255 bytes. # Corresponds to the JSON property `query` # @return [String] attr_accessor :query @@ -2363,9 +2160,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. class LatLng include Google::Apis::Core::Hashable @@ -2390,8 +2186,7 @@ module Google end end - # Output only. - # The List companies response object. + # Output only. The List companies response object. class ListCompaniesResponse include Google::Apis::Core::Hashable @@ -2400,8 +2195,7 @@ module Google # @return [Array] attr_accessor :companies - # Output only. - # Additional information returned to client, such as debugging + # Output only. Additional information returned to client, such as debugging # information. # Corresponds to the JSON property `metadata` # @return [Google::Apis::JobsV2::ResponseMetadata] @@ -2424,21 +2218,18 @@ module Google end end - # Deprecated. Use ListJobsResponse instead. - # Output only. - # The List jobs response object. + # Deprecated. Use ListJobsResponse instead. Output only. The List jobs response + # object. class ListCompanyJobsResponse include Google::Apis::Core::Hashable - # The Jobs for a given company. - # The maximum number of items returned is based on the limit field - # provided in the request. + # The Jobs for a given company. The maximum number of items returned is based on + # the limit field provided in the request. # Corresponds to the JSON property `jobs` # @return [Array] attr_accessor :jobs - # Output only. - # Additional information returned to client, such as debugging + # Output only. Additional information returned to client, such as debugging # information. # Corresponds to the JSON property `metadata` # @return [Google::Apis::JobsV2::ResponseMetadata] @@ -2449,9 +2240,9 @@ module Google # @return [String] attr_accessor :next_page_token - # The total number of open jobs. The result will be - # empty if ListCompanyJobsRequest.include_jobs_count is not enabled - # or if no open jobs are available. + # The total number of open jobs. The result will be empty if + # ListCompanyJobsRequest.include_jobs_count is not enabled or if no open jobs + # are available. # Corresponds to the JSON property `totalSize` # @return [Fixnum] attr_accessor :total_size @@ -2469,20 +2260,17 @@ module Google end end - # Output only. - # List jobs response. + # Output only. List jobs response. class ListJobsResponse include Google::Apis::Core::Hashable - # The Jobs for a given company. - # The maximum number of items returned is based on the limit field - # provided in the request. + # The Jobs for a given company. The maximum number of items returned is based on + # the limit field provided in the request. # Corresponds to the JSON property `jobs` # @return [Array] attr_accessor :jobs - # Output only. - # Additional information returned to client, such as debugging + # Output only. Additional information returned to client, such as debugging # information. # Corresponds to the JSON property `metadata` # @return [Google::Apis::JobsV2::ResponseMetadata] @@ -2505,32 +2293,27 @@ module Google end end - # Input only. - # Geographic region of the search. + # Input only. Geographic region of the search. class LocationFilter include Google::Apis::Core::Hashable # Optional. The distance_in_miles is applied when the location being searched - # for is - # identified as a city or smaller. When the location being searched for is a - # state or larger, this field is ignored. + # for is identified as a city or smaller. When the location being searched for + # is a state or larger, this field is ignored. # Corresponds to the JSON property `distanceInMiles` # @return [Float] attr_accessor :distance_in_miles - # Optional. Allows the client to return jobs without a - # set location, specifically, telecommuting jobs (telecomuting is considered - # by the service as a special location. - # Job.allow_telecommute indicates if a job permits telecommuting. - # If this field is true, telecommuting jobs are searched, and - # name and lat_lng are - # ignored. - # This filter can be used by itself to search exclusively for telecommuting - # jobs, or it can be combined with another location - # filter to search for a combination of job locations, - # such as "Mountain View" or "telecommuting" jobs. However, when used in - # combination with other location filters, telecommuting jobs can be - # treated as less relevant than other jobs in the search response. + # Optional. Allows the client to return jobs without a set location, + # specifically, telecommuting jobs (telecomuting is considered by the service as + # a special location. Job.allow_telecommute indicates if a job permits + # telecommuting. If this field is true, telecommuting jobs are searched, and + # name and lat_lng are ignored. This filter can be used by itself to search + # exclusively for telecommuting jobs, or it can be combined with another + # location filter to search for a combination of job locations, such as " + # Mountain View" or "telecommuting" jobs. However, when used in combination with + # other location filters, telecommuting jobs can be treated as less relevant + # than other jobs in the search response. # Corresponds to the JSON property `isTelecommute` # @return [Boolean] attr_accessor :is_telecommute @@ -2538,9 +2321,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::JobsV2::LatLng] attr_accessor :lat_lng @@ -2551,14 +2333,12 @@ module Google attr_accessor :name # Optional. CLDR region code of the country/region of the address. This will be - # used - # to address ambiguity of the user-input location, e.g. "Liverpool" - # against "Liverpool, NY, US" or "Liverpool, UK". - # Set this field if all the jobs to search against are from a same region, - # or jobs are world-wide but the job seeker is from a specific region. - # See http://cldr.unicode.org/ and - # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - # for details. Example: "CH" for Switzerland. + # used to address ambiguity of the user-input location, e.g. "Liverpool" against + # "Liverpool, NY, US" or "Liverpool, UK". Set this field if all the jobs to + # search against are from a same region, or jobs are world-wide but the job + # seeker is from a specific region. See http://cldr.unicode.org/ and http://www. + # unicode.org/cldr/charts/30/supplemental/territory_information.html for details. + # Example: "CH" for Switzerland. # Corresponds to the JSON property `regionCode` # @return [String] attr_accessor :region_code @@ -2577,20 +2357,18 @@ module Google end end - # Output only. - # Job entry with metadata inside SearchJobsResponse. + # Output only. Job entry with metadata inside SearchJobsResponse. class MatchingJob include Google::Apis::Core::Hashable - # Output only. - # Commute details related to this job. + # Output only. Commute details related to this job. # Corresponds to the JSON property `commuteInfo` # @return [Google::Apis::JobsV2::CommuteInfo] attr_accessor :commute_info # A Job resource represents a job posting (also referred to as a "job listing" - # or "job requisition"). A job belongs to a Company, which is the hiring - # entity responsible for the job. + # or "job requisition"). A job belongs to a Company, which is the hiring entity + # responsible for the job. # Corresponds to the JSON property `job` # @return [Google::Apis::JobsV2::Job] attr_accessor :job @@ -2601,17 +2379,17 @@ module Google # @return [String] attr_accessor :job_summary - # Contains snippets of text from the Job.job_title field most - # closely matching a search query's keywords, if available. The matching - # query keywords are enclosed in HTML bold tags. + # Contains snippets of text from the Job.job_title field most closely matching a + # search query's keywords, if available. The matching query keywords are + # enclosed in HTML bold tags. # Corresponds to the JSON property `jobTitleSnippet` # @return [String] attr_accessor :job_title_snippet - # Contains snippets of text from the Job.description and similar - # fields that most closely match a search query's keywords, if available. - # All HTML tags in the original fields are stripped when returned in this - # field, and matching query keywords are enclosed in HTML bold tags. + # Contains snippets of text from the Job.description and similar fields that + # most closely match a search query's keywords, if available. All HTML tags in + # the original fields are stripped when returned in this field, and matching + # query keywords are enclosed in HTML bold tags. # Corresponds to the JSON property `searchTextSnippet` # @return [String] attr_accessor :search_text_snippet @@ -2630,20 +2408,18 @@ module Google end end - # Message representing input to a Mendel server for debug forcing. - # See go/mendel-debug-forcing for more details. - # Next ID: 2 + # Message representing input to a Mendel server for debug forcing. See go/mendel- + # debug-forcing for more details. Next ID: 2 class MendelDebugInput include Google::Apis::Core::Hashable - # When a request spans multiple servers, a MendelDebugInput may travel with - # the request and take effect in all the servers. This field is a map of - # namespaces to NamespacedMendelDebugInput protos. In a single server, up to - # two NamespacedMendelDebugInput protos are applied: - # 1. NamespacedMendelDebugInput with the global namespace (key == ""). - # 2. NamespacedMendelDebugInput with the server's namespace. - # When both NamespacedMendelDebugInput protos are present, they are merged. - # See go/mendel-debug-forcing for more details. + # When a request spans multiple servers, a MendelDebugInput may travel with the + # request and take effect in all the servers. This field is a map of namespaces + # to NamespacedMendelDebugInput protos. In a single server, up to two + # NamespacedMendelDebugInput protos are applied: 1. NamespacedMendelDebugInput + # with the global namespace (key == ""). 2. NamespacedMendelDebugInput with the + # server's namespace. When both NamespacedMendelDebugInput protos are present, + # they are merged. See go/mendel-debug-forcing for more details. # Corresponds to the JSON property `namespacedDebugInput` # @return [Hash] attr_accessor :namespaced_debug_input @@ -2667,18 +2443,17 @@ module Google # @return [String] attr_accessor :currency_code - # Number of nano (10^-9) units of the amount. - # The value must be between -999,999,999 and +999,999,999 inclusive. - # If `units` is positive, `nanos` must be positive or zero. - # If `units` is zero, `nanos` can be positive, zero, or negative. - # If `units` is negative, `nanos` must be negative or zero. - # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + # Number of nano (10^-9) units of the amount. The value must be between -999,999, + # 999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be + # positive or zero. If `units` is zero, `nanos` can be positive, zero, or + # negative. If `units` is negative, `nanos` must be negative or zero. For + # example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. # Corresponds to the JSON property `nanos` # @return [Fixnum] attr_accessor :nanos - # The whole units of the amount. - # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + # The whole units of the amount. For example if `currencyCode` is `"USD"`, then + # 1 unit is one US dollar. # Corresponds to the JSON property `units` # @return [Fixnum] attr_accessor :units @@ -2699,89 +2474,85 @@ module Google class NamespacedDebugInput include Google::Apis::Core::Hashable - # Set of experiment names to be absolutely forced. - # These experiments will be forced without evaluating the conditions. + # Set of experiment names to be absolutely forced. These experiments will be + # forced without evaluating the conditions. # Corresponds to the JSON property `absolutelyForcedExpNames` # @return [Array] attr_accessor :absolutely_forced_exp_names - # Set of experiment tags to be absolutely forced. - # The experiments with these tags will be forced without evaluating the - # conditions. + # Set of experiment tags to be absolutely forced. The experiments with these + # tags will be forced without evaluating the conditions. # Corresponds to the JSON property `absolutelyForcedExpTags` # @return [Array] attr_accessor :absolutely_forced_exp_tags - # Set of experiment ids to be absolutely forced. - # These ids will be forced without evaluating the conditions. + # Set of experiment ids to be absolutely forced. These ids will be forced + # without evaluating the conditions. # Corresponds to the JSON property `absolutelyForcedExps` # @return [Array] attr_accessor :absolutely_forced_exps - # Set of experiment names to be conditionally forced. - # These experiments will be forced only if their conditions and their - # parent domain's conditions are true. + # Set of experiment names to be conditionally forced. These experiments will be + # forced only if their conditions and their parent domain's conditions are true. # Corresponds to the JSON property `conditionallyForcedExpNames` # @return [Array] attr_accessor :conditionally_forced_exp_names - # Set of experiment tags to be conditionally forced. - # The experiments with these tags will be forced only if their conditions - # and their parent domain's conditions are true. + # Set of experiment tags to be conditionally forced. The experiments with these + # tags will be forced only if their conditions and their parent domain's + # conditions are true. # Corresponds to the JSON property `conditionallyForcedExpTags` # @return [Array] attr_accessor :conditionally_forced_exp_tags - # Set of experiment ids to be conditionally forced. - # These ids will be forced only if their conditions and their parent - # domain's conditions are true. + # Set of experiment ids to be conditionally forced. These ids will be forced + # only if their conditions and their parent domain's conditions are true. # Corresponds to the JSON property `conditionallyForcedExps` # @return [Array] attr_accessor :conditionally_forced_exps - # If true, disable automatic enrollment selection (at all diversion - # points). Automatic enrollment selection means experiment selection - # process based on the experiment's automatic enrollment condition. This - # does not disable selection of forced experiments. + # If true, disable automatic enrollment selection (at all diversion points). + # Automatic enrollment selection means experiment selection process based on the + # experiment's automatic enrollment condition. This does not disable selection + # of forced experiments. # Corresponds to the JSON property `disableAutomaticEnrollmentSelection` # @return [Boolean] attr_accessor :disable_automatic_enrollment_selection alias_method :disable_automatic_enrollment_selection?, :disable_automatic_enrollment_selection - # Set of experiment names to be disabled. - # If an experiment is disabled, it is never selected nor forced. - # If an aggregate experiment is disabled, its partitions are disabled - # together. If an experiment with an enrollment is disabled, the enrollment - # is disabled together. If a name corresponds to a domain, the domain - # itself and all descendant experiments and domains are disabled together. + # Set of experiment names to be disabled. If an experiment is disabled, it is + # never selected nor forced. If an aggregate experiment is disabled, its + # partitions are disabled together. If an experiment with an enrollment is + # disabled, the enrollment is disabled together. If a name corresponds to a + # domain, the domain itself and all descendant experiments and domains are + # disabled together. # Corresponds to the JSON property `disableExpNames` # @return [Array] attr_accessor :disable_exp_names - # Set of experiment tags to be disabled. All experiments that are tagged - # with one or more of these tags are disabled. - # If an experiment is disabled, it is never selected nor forced. - # If an aggregate experiment is disabled, its partitions are disabled - # together. If an experiment with an enrollment is disabled, the enrollment - # is disabled together. + # Set of experiment tags to be disabled. All experiments that are tagged with + # one or more of these tags are disabled. If an experiment is disabled, it is + # never selected nor forced. If an aggregate experiment is disabled, its + # partitions are disabled together. If an experiment with an enrollment is + # disabled, the enrollment is disabled together. # Corresponds to the JSON property `disableExpTags` # @return [Array] attr_accessor :disable_exp_tags - # Set of experiment ids to be disabled. - # If an experiment is disabled, it is never selected nor forced. - # If an aggregate experiment is disabled, its partitions are disabled - # together. If an experiment with an enrollment is disabled, the enrollment - # is disabled together. If an ID corresponds to a domain, the domain itself - # and all descendant experiments and domains are disabled together. + # Set of experiment ids to be disabled. If an experiment is disabled, it is + # never selected nor forced. If an aggregate experiment is disabled, its + # partitions are disabled together. If an experiment with an enrollment is + # disabled, the enrollment is disabled together. If an ID corresponds to a + # domain, the domain itself and all descendant experiments and domains are + # disabled together. # Corresponds to the JSON property `disableExps` # @return [Array] attr_accessor :disable_exps - # If true, disable manual enrollment selection (at all diversion points). - # Manual enrollment selection means experiment selection process based on - # the request's manual enrollment states (a.k.a. opt-in experiments). - # This does not disable selection of forced experiments. + # If true, disable manual enrollment selection (at all diversion points). Manual + # enrollment selection means experiment selection process based on the request's + # manual enrollment states (a.k.a. opt-in experiments). This does not disable + # selection of forced experiments. # Corresponds to the JSON property `disableManualEnrollmentSelection` # @return [Boolean] attr_accessor :disable_manual_enrollment_selection @@ -2789,24 +2560,23 @@ module Google # If true, disable organic experiment selection (at all diversion points). # Organic selection means experiment selection process based on traffic - # allocation and diversion condition evaluation. - # This does not disable selection of forced experiments. - # This is useful in cases when it is not known whether experiment selection - # behavior is responsible for a error or breakage. Disabling organic - # selection may help to isolate the cause of a given problem. + # allocation and diversion condition evaluation. This does not disable selection + # of forced experiments. This is useful in cases when it is not known whether + # experiment selection behavior is responsible for a error or breakage. + # Disabling organic selection may help to isolate the cause of a given problem. # Corresponds to the JSON property `disableOrganicSelection` # @return [Boolean] attr_accessor :disable_organic_selection alias_method :disable_organic_selection?, :disable_organic_selection - # Flags to force in a particular experiment state. - # Map from flag name to flag value. + # Flags to force in a particular experiment state. Map from flag name to flag + # value. # Corresponds to the JSON property `forcedFlags` # @return [Hash] attr_accessor :forced_flags - # Rollouts to force in a particular experiment state. - # Map from rollout name to rollout value. + # Rollouts to force in a particular experiment state. Map from rollout name to + # rollout value. # Corresponds to the JSON property `forcedRollouts` # @return [Hash] attr_accessor :forced_rollouts @@ -2834,21 +2604,21 @@ module Google end end - # Input only. - # Use this field to specify bucketing option for the histogram search response. + # Input only. Use this field to specify bucketing option for the histogram + # search response. class NumericBucketingOption include Google::Apis::Core::Hashable # Required. Two adjacent values form a histogram bucket. Values should be in # ascending order. For example, if [5, 10, 15] are provided, four buckets are - # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 - # [buckets_bound is supported. + # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 [buckets_bound is + # supported. # Corresponds to the JSON property `bucketBounds` # @return [Array] attr_accessor :bucket_bounds - # Optional. If set to true, the histogram result includes minimum/maximum - # value of the numeric field. + # Optional. If set to true, the histogram result includes minimum/maximum value + # of the numeric field. # Corresponds to the JSON property `requiresMinMax` # @return [Boolean] attr_accessor :requires_min_max @@ -2865,25 +2635,24 @@ module Google end end - # Output only. - # Custom numeric bucketing result. + # Output only. Custom numeric bucketing result. class NumericBucketingResult include Google::Apis::Core::Hashable - # Count within each bucket. Its size is the length of - # NumericBucketingOption.bucket_bounds plus 1. + # Count within each bucket. Its size is the length of NumericBucketingOption. + # bucket_bounds plus 1. # Corresponds to the JSON property `counts` # @return [Array] attr_accessor :counts - # Stores the maximum value of the numeric field. Will be populated only if - # [NumericBucketingOption.requires_min_max] is set to true. + # Stores the maximum value of the numeric field. Will be populated only if [ + # NumericBucketingOption.requires_min_max] is set to true. # Corresponds to the JSON property `maxValue` # @return [Float] attr_accessor :max_value - # Stores the minimum value of the numeric field. Will be populated only if - # [NumericBucketingOption.requires_min_max] is set to true. + # Stores the minimum value of the numeric field. Will be populated only if [ + # NumericBucketingOption.requires_min_max] is set to true. # Corresponds to the JSON property `minValue` # @return [Float] attr_accessor :min_value @@ -2902,73 +2671,63 @@ module Google # Represents a postal address, e.g. for postal delivery or payments addresses. # Given a postal address, a postal service can deliver items to a premise, P.O. - # Box or similar. - # It is not intended to model geographical locations (roads, towns, - # mountains). - # In typical usage an address would be created via user input or from importing - # existing data, depending on the type of process. - # Advice on address input / editing: - # - Use an i18n-ready address widget such as - # https://github.com/google/libaddressinput) - # - Users should not be presented with UI elements for input or editing of - # fields outside countries where that field is used. - # For more guidance on how to use this schema, please see: - # https://support.google.com/business/answer/6397478 + # Box or similar. It is not intended to model geographical locations (roads, + # towns, mountains). In typical usage an address would be created via user input + # or from importing existing data, depending on the type of process. Advice on + # address input / editing: - Use an i18n-ready address widget such as https:// + # github.com/google/libaddressinput) - Users should not be presented with UI + # elements for input or editing of fields outside countries where that field is + # used. For more guidance on how to use this schema, please see: https://support. + # google.com/business/answer/6397478 class PostalAddress include Google::Apis::Core::Hashable - # Unstructured address lines describing the lower levels of an address. - # Because values in address_lines do not have type information and may - # sometimes contain multiple values in a single field (e.g. - # "Austin, TX"), it is important that the line order is clear. The order of - # address lines should be "envelope order" for the country/region of the - # address. In places where this can vary (e.g. Japan), address_language is - # used to make it explicit (e.g. "ja" for large-to-small ordering and - # "ja-Latn" or "en" for small-to-large). This way, the most specific line of - # an address can be selected based on the language. - # The minimum permitted structural representation of an address consists - # of a region_code with all remaining information placed in the - # address_lines. It would be possible to format such an address very - # approximately without geocoding, but no semantic reasoning could be - # made about any of the address components until it was at least - # partially resolved. - # Creating an address only containing a region_code and address_lines, and - # then geocoding is the recommended way to handle completely unstructured - # addresses (as opposed to guessing which parts of the address should be - # localities or administrative areas). + # Unstructured address lines describing the lower levels of an address. Because + # values in address_lines do not have type information and may sometimes contain + # multiple values in a single field (e.g. "Austin, TX"), it is important that + # the line order is clear. The order of address lines should be "envelope order" + # for the country/region of the address. In places where this can vary (e.g. + # Japan), address_language is used to make it explicit (e.g. "ja" for large-to- + # small ordering and "ja-Latn" or "en" for small-to-large). This way, the most + # specific line of an address can be selected based on the language. The minimum + # permitted structural representation of an address consists of a region_code + # with all remaining information placed in the address_lines. It would be + # possible to format such an address very approximately without geocoding, but + # no semantic reasoning could be made about any of the address components until + # it was at least partially resolved. Creating an address only containing a + # region_code and address_lines, and then geocoding is the recommended way to + # handle completely unstructured addresses (as opposed to guessing which parts + # of the address should be localities or administrative areas). # Corresponds to the JSON property `addressLines` # @return [Array] attr_accessor :address_lines # Optional. Highest administrative subdivision which is used for postal - # addresses of a country or region. - # For example, this can be a state, a province, an oblast, or a prefecture. - # Specifically, for Spain this is the province and not the autonomous - # community (e.g. "Barcelona" and not "Catalonia"). - # Many countries don't use an administrative area in postal addresses. E.g. - # in Switzerland this should be left unpopulated. + # addresses of a country or region. For example, this can be a state, a province, + # an oblast, or a prefecture. Specifically, for Spain this is the province and + # not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many + # countries don't use an administrative area in postal addresses. E.g. in + # Switzerland this should be left unpopulated. # Corresponds to the JSON property `administrativeArea` # @return [String] attr_accessor :administrative_area - # Optional. BCP-47 language code of the contents of this address (if - # known). This is often the UI language of the input form or is expected - # to match one of the languages used in the address' country/region, or their - # transliterated equivalents. - # This can affect formatting in certain countries, but is not critical - # to the correctness of the data and will never affect any validation or - # other non-formatting related operations. - # If this value is not known, it should be omitted (rather than specifying a - # possibly incorrect default). + # Optional. BCP-47 language code of the contents of this address (if known). + # This is often the UI language of the input form or is expected to match one of + # the languages used in the address' country/region, or their transliterated + # equivalents. This can affect formatting in certain countries, but is not + # critical to the correctness of the data and will never affect any validation + # or other non-formatting related operations. If this value is not known, it + # should be omitted (rather than specifying a possibly incorrect default). # Examples: "zh-Hant", "ja", "ja-Latn", "en". # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code - # Optional. Generally refers to the city/town portion of the address. - # Examples: US city, IT comune, UK post town. - # In regions of the world where localities are not well defined or do not fit - # into this structure well, leave locality empty and use address_lines. + # Optional. Generally refers to the city/town portion of the address. Examples: + # US city, IT comune, UK post town. In regions of the world where localities are + # not well defined or do not fit into this structure well, leave locality empty + # and use address_lines. # Corresponds to the JSON property `locality` # @return [String] attr_accessor :locality @@ -2978,48 +2737,47 @@ module Google # @return [String] attr_accessor :organization - # Optional. Postal code of the address. Not all countries use or require - # postal codes to be present, but where they are used, they may trigger - # additional validation with other parts of the address (e.g. state/zip - # validation in the U.S.A.). + # Optional. Postal code of the address. Not all countries use or require postal + # codes to be present, but where they are used, they may trigger additional + # validation with other parts of the address (e.g. state/zip validation in the U. + # S.A.). # Corresponds to the JSON property `postalCode` # @return [String] attr_accessor :postal_code - # Optional. The recipient at the address. - # This field may, under certain circumstances, contain multiline information. - # For example, it might contain "care of" information. + # Optional. The recipient at the address. This field may, under certain + # circumstances, contain multiline information. For example, it might contain " + # care of" information. # Corresponds to the JSON property `recipients` # @return [Array] attr_accessor :recipients - # Required. CLDR region code of the country/region of the address. This - # is never inferred and it is up to the user to ensure the value is - # correct. See http://cldr.unicode.org/ and - # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - # for details. Example: "CH" for Switzerland. + # Required. CLDR region code of the country/region of the address. This is never + # inferred and it is up to the user to ensure the value is correct. See http:// + # cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/ + # territory_information.html for details. Example: "CH" for Switzerland. # Corresponds to the JSON property `regionCode` # @return [String] attr_accessor :region_code # The schema revision of the `PostalAddress`. This must be set to 0, which is - # the latest revision. - # All new revisions **must** be backward compatible with old revisions. + # the latest revision. All new revisions **must** be backward compatible with + # old revisions. # Corresponds to the JSON property `revision` # @return [Fixnum] attr_accessor :revision - # Optional. Additional, country-specific, sorting code. This is not used - # in most regions. Where it is used, the value is either a string like - # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number - # alone, representing the "sector code" (Jamaica), "delivery area indicator" - # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). + # Optional. Additional, country-specific, sorting code. This is not used in most + # regions. Where it is used, the value is either a string like "CEDEX", + # optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, + # representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) + # or "post office indicator" (e.g. Côte d'Ivoire). # Corresponds to the JSON property `sortingCode` # @return [String] attr_accessor :sorting_code - # Optional. Sublocality of the address. - # For example, this can be neighborhoods, boroughs, districts. + # Optional. Sublocality of the address. For example, this can be neighborhoods, + # boroughs, districts. # Corresponds to the JSON property `sublocality` # @return [String] attr_accessor :sublocality @@ -3044,15 +2802,13 @@ module Google end end - # Input only. - # Meta information related to the job searcher or entity - # conducting the job search. This information is used to improve the - # performance of the service. + # Input only. Meta information related to the job searcher or entity conducting + # the job search. This information is used to improve the performance of the + # service. class RequestMetadata include Google::Apis::Core::Hashable - # Input only. - # Device information collected from the job seeker, candidate, or + # Input only. Device information collected from the job seeker, candidate, or # other entity conducting the job search. Providing this information improves # the quality of the search results across devices. # Corresponds to the JSON property `deviceInfo` @@ -3060,40 +2816,34 @@ module Google attr_accessor :device_info # Required. The client-defined scope or source of the service call, which - # typically - # is the domain on - # which the service has been implemented and is currently being run. - # For example, if the service is being run by client Foo, Inc., on - # job board www.foo.com and career site www.bar.com, then this field is - # set to "foo.com" for use on the job board, and "bar.com" for use on the - # career site. - # If this field is not available for some reason, send "UNKNOWN". Note that - # any improvements to the service model for a particular tenant site rely on - # this field being set correctly to some domain. + # typically is the domain on which the service has been implemented and is + # currently being run. For example, if the service is being run by client *Foo, + # Inc.*, on job board www.foo.com and career site www.bar.com, then this field + # is set to "foo.com" for use on the job board, and "bar.com" for use on the + # career site. If this field is not available for some reason, send "UNKNOWN". + # Note that any improvements to the service model for a particular tenant site + # rely on this field being set correctly to some domain. # Corresponds to the JSON property `domain` # @return [String] attr_accessor :domain # Required. A unique session identification string. A session is defined as the # duration of an end user's interaction with the service over a period. - # Obfuscate this field for privacy concerns before - # providing it to the API. - # If this field is not available for some reason, please send "UNKNOWN". Note - # that any improvements to the service model for a particular tenant site, - # rely on this field being set correctly to some unique session_id. + # Obfuscate this field for privacy concerns before providing it to the API. If + # this field is not available for some reason, please send "UNKNOWN". Note that + # any improvements to the service model for a particular tenant site, rely on + # this field being set correctly to some unique session_id. # Corresponds to the JSON property `sessionId` # @return [String] attr_accessor :session_id # Required. A unique user identification string, as determined by the client. - # The - # client is responsible for ensuring client-level uniqueness of this value - # in order to have the strongest positive impact on search quality. - # Obfuscate this field for privacy concerns before - # providing it to the service. - # If this field is not available for some reason, please send "UNKNOWN". Note - # that any improvements to the service model for a particular tenant site, - # rely on this field being set correctly to some unique user_id. + # The client is responsible for ensuring client-level uniqueness of this value + # in order to have the strongest positive impact on search quality. Obfuscate + # this field for privacy concerns before providing it to the service. If this + # field is not available for some reason, please send "UNKNOWN". Note that any + # improvements to the service model for a particular tenant site, rely on this + # field being set correctly to some unique user_id. # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id @@ -3111,16 +2861,14 @@ module Google end end - # Output only. - # Additional information returned to client, such as debugging + # Output only. Additional information returned to client, such as debugging # information. class ResponseMetadata include Google::Apis::Core::Hashable - # Identifiers for the versions of the search algorithm used during - # this API invocation if multiple algorithms are used. - # The default value is empty. - # For search response only. + # Identifiers for the versions of the search algorithm used during this API + # invocation if multiple algorithms are used. The default value is empty. For + # search response only. # Corresponds to the JSON property `experimentIdList` # @return [Array] attr_accessor :experiment_id_list @@ -3130,8 +2878,7 @@ module Google # @return [String] attr_accessor :mode - # A unique id associated with this call. - # This id is logged for tracking purposes. + # A unique id associated with this call. This id is logged for tracking purposes. # Corresponds to the JSON property `requestId` # @return [String] attr_accessor :request_id @@ -3148,60 +2895,51 @@ module Google end end - # Input only. - # The Request body of the `SearchJobs` call. + # Input only. The Request body of the `SearchJobs` call. class SearchJobsRequest include Google::Apis::Core::Hashable # Optional. Controls whether to disable relevance thresholding. Relevance - # thresholding removes jobs that have low relevance in search results, - # for example, removing "Assistant to the CEO" positions from the search - # results of a search for "CEO". - # Disabling relevance thresholding improves the accuracy of subsequent - # search requests. - # Defaults to false. + # thresholding removes jobs that have low relevance in search results, for + # example, removing "Assistant to the CEO" positions from the search results of + # a search for "CEO". Disabling relevance thresholding improves the accuracy of + # subsequent search requests. Defaults to false. # Corresponds to the JSON property `disableRelevanceThresholding` # @return [Boolean] attr_accessor :disable_relevance_thresholding alias_method :disable_relevance_thresholding?, :disable_relevance_thresholding # Optional. Controls whether to broaden the search when it produces sparse - # results. - # Broadened queries append results to the end of the matching results - # list. - # Defaults to false. + # results. Broadened queries append results to the end of the matching results + # list. Defaults to false. # Corresponds to the JSON property `enableBroadening` # @return [Boolean] attr_accessor :enable_broadening alias_method :enable_broadening?, :enable_broadening # Optional. Controls if the search job request requires the return of a precise - # count of the first 300 results. Setting this to `true` ensures - # consistency in the number of results per page. Best practice is to set this - # value to true if a client allows users to jump directly to a - # non-sequential search results page. - # Enabling this flag may adversely impact performance. - # Defaults to false. + # count of the first 300 results. Setting this to `true` ensures consistency in + # the number of results per page. Best practice is to set this value to true if + # a client allows users to jump directly to a non-sequential search results page. + # Enabling this flag may adversely impact performance. Defaults to false. # Corresponds to the JSON property `enablePreciseResultSize` # @return [Boolean] attr_accessor :enable_precise_result_size alias_method :enable_precise_result_size?, :enable_precise_result_size - # Input only. - # Deprecated. Use JobQuery instead. - # The filters required to perform a search query or histogram. + # Input only. Deprecated. Use JobQuery instead. The filters required to perform + # a search query or histogram. # Corresponds to the JSON property `filters` # @return [Google::Apis::JobsV2::JobFilters] attr_accessor :filters - # Input only. - # Histogram facets to be specified in SearchJobsRequest. + # Input only. Histogram facets to be specified in SearchJobsRequest. # Corresponds to the JSON property `histogramFacets` # @return [Google::Apis::JobsV2::HistogramFacets] attr_accessor :histogram_facets - # Optional. The number of job attributes returned for jobs in the - # search response. Defaults to JobView.SMALL if no value is specified. + # Optional. The number of job attributes returned for jobs in the search + # response. Defaults to JobView.SMALL if no value is specified. # Corresponds to the JSON property `jobView` # @return [String] attr_accessor :job_view @@ -3212,21 +2950,17 @@ module Google attr_accessor :mode # Optional. An integer that specifies the current offset (that is, starting - # result - # location, amongst the jobs deemed by the API as relevant) in search - # results. This field is only considered if page_token is unset. - # For example, 0 means to return results starting from the first matching - # job, and 10 means to return from the 11th job. This can be used for - # pagination, (for example, pageSize = 10 and offset = 10 means to return - # from the second page). + # result location, amongst the jobs deemed by the API as relevant) in search + # results. This field is only considered if page_token is unset. For example, 0 + # means to return results starting from the first matching job, and 10 means to + # return from the 11th job. This can be used for pagination, (for example, + # pageSize = 10 and offset = 10 means to return from the second page). # Corresponds to the JSON property `offset` # @return [Fixnum] attr_accessor :offset - # Deprecated. Use sort_by instead. - # Optional. - # The criteria determining how search results are sorted. - # Defaults to SortBy.RELEVANCE_DESC if no value is specified. + # Deprecated. Use sort_by instead. Optional. The criteria determining how search + # results are sorted. Defaults to SortBy.RELEVANCE_DESC if no value is specified. # Corresponds to the JSON property `orderBy` # @return [String] attr_accessor :order_by @@ -3238,29 +2972,27 @@ module Google # @return [Fixnum] attr_accessor :page_size - # Optional. The token specifying the current offset within - # search results. See SearchJobsResponse.next_page_token for - # an explanation of how to obtain the next set of query results. + # Optional. The token specifying the current offset within search results. See + # SearchJobsResponse.next_page_token for an explanation of how to obtain the + # next set of query results. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token - # Input only. - # The query required to perform a search query or histogram. + # Input only. The query required to perform a search query or histogram. # Corresponds to the JSON property `query` # @return [Google::Apis::JobsV2::JobQuery] attr_accessor :query - # Input only. - # Meta information related to the job searcher or entity - # conducting the job search. This information is used to improve the - # performance of the service. + # Input only. Meta information related to the job searcher or entity conducting + # the job search. This information is used to improve the performance of the + # service. # Corresponds to the JSON property `requestMetadata` # @return [Google::Apis::JobsV2::RequestMetadata] attr_accessor :request_metadata - # Optional. The criteria determining how search results are sorted. - # Defaults to SortBy.RELEVANCE_DESC if no value is specified. + # Optional. The criteria determining how search results are sorted. Defaults to + # SortBy.RELEVANCE_DESC if no value is specified. # Corresponds to the JSON property `sortBy` # @return [String] attr_accessor :sort_by @@ -3288,33 +3020,30 @@ module Google end end - # Output only. - # Response for SearchJob method. + # Output only. Response for SearchJob method. class SearchJobsResponse include Google::Apis::Core::Hashable - # Input only. - # Parameters needed for commute search. + # Input only. Parameters needed for commute search. # Corresponds to the JSON property `appliedCommuteFilter` # @return [Google::Apis::JobsV2::CommutePreference] attr_accessor :applied_commute_filter - # The location filters that the service applied to the specified query. If - # any filters are lat-lng based, the JobLocation.location_type is - # JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED. + # The location filters that the service applied to the specified query. If any + # filters are lat-lng based, the JobLocation.location_type is JobLocation. + # LocationType#LOCATION_TYPE_UNSPECIFIED. # Corresponds to the JSON property `appliedJobLocationFilters` # @return [Array] attr_accessor :applied_job_location_filters - # An estimation of the number of jobs that match the specified query. - # This number is not guaranteed to be accurate. For accurate results, + # An estimation of the number of jobs that match the specified query. This + # number is not guaranteed to be accurate. For accurate results, # seenenable_precise_result_size. # Corresponds to the JSON property `estimatedTotalSize` # @return [Fixnum] attr_accessor :estimated_total_size - # Output only. - # Histogram results that matches HistogramFacets specified in + # Output only. Histogram results that matches HistogramFacets specified in # SearchJobsRequest. # Corresponds to the JSON property `histogramResults` # @return [Google::Apis::JobsV2::HistogramResults] @@ -3330,8 +3059,7 @@ module Google # @return [Array] attr_accessor :matching_jobs - # Output only. - # Additional information returned to client, such as debugging + # Output only. Additional information returned to client, such as debugging # information. # Corresponds to the JSON property `metadata` # @return [Google::Apis::JobsV2::ResponseMetadata] @@ -3345,24 +3073,23 @@ module Google # If query broadening is enabled, we may append additional results from the # broadened query. This number indicates how many of the jobs returned in the - # jobs field are from the broadened query. These results are always at the - # end of the jobs list. In particular, a value of 0 means all the jobs in the - # jobs list are from the original (without broadening) query. If this - # field is non-zero, subsequent requests with offset after this result set - # should contain all broadened results. + # jobs field are from the broadened query. These results are always at the end + # of the jobs list. In particular, a value of 0 means all the jobs in the jobs + # list are from the original (without broadening) query. If this field is non- + # zero, subsequent requests with offset after this result set should contain all + # broadened results. # Corresponds to the JSON property `numJobsFromBroadenedQuery` # @return [Fixnum] attr_accessor :num_jobs_from_broadened_query - # Output only. - # Spell check result. + # Output only. Spell check result. # Corresponds to the JSON property `spellResult` # @return [Google::Apis::JobsV2::SpellingCorrection] attr_accessor :spell_result # The precise result count, which is available only if the client set - # enable_precise_result_size to `true` or if the response - # is the last page of results. Otherwise, the value will be `-1`. + # enable_precise_result_size to `true` or if the response is the last page of + # results. Otherwise, the value will be `-1`. # Corresponds to the JSON property `totalSize` # @return [Fixnum] attr_accessor :total_size @@ -3387,8 +3114,7 @@ module Google end end - # Output only. - # Spell check result. + # Output only. Spell check result. class SpellingCorrection include Google::Apis::Core::Hashable @@ -3433,66 +3159,40 @@ module Google end end - # Input only. - # Update job request. + # Input only. Update job request. class UpdateJobRequest include Google::Apis::Core::Hashable # Deprecated. Please use processing_options. This flag is ignored if - # processing_options is set. - # Optional. - # If set to `true`, the service does not attempt resolve a more precise - # address for the job. + # processing_options is set. Optional. If set to `true`, the service does not + # attempt resolve a more precise address for the job. # Corresponds to the JSON property `disableStreetAddressResolution` # @return [Boolean] attr_accessor :disable_street_address_resolution alias_method :disable_street_address_resolution?, :disable_street_address_resolution # A Job resource represents a job posting (also referred to as a "job listing" - # or "job requisition"). A job belongs to a Company, which is the hiring - # entity responsible for the job. + # or "job requisition"). A job belongs to a Company, which is the hiring entity + # responsible for the job. # Corresponds to the JSON property `job` # @return [Google::Apis::JobsV2::Job] attr_accessor :job - # Input only. - # Options for job processing. + # Input only. Options for job processing. # Corresponds to the JSON property `processingOptions` # @return [Google::Apis::JobsV2::JobProcessingOptions] attr_accessor :processing_options # Optional but strongly recommended to be provided for the best service - # experience. - # If update_job_fields is provided, only the specified fields in - # job are updated. Otherwise all the fields are updated. - # A field mask to restrict the fields that are updated. Valid values are: - # * jobTitle - # * employmentTypes - # * description - # * applicationUrls - # * applicationEmailList - # * applicationInstruction - # * responsibilities - # * qualifications - # * educationLevels - # * level - # * department - # * startDate - # * endDate - # * compensationInfo - # * incentives - # * languageCode - # * benefits - # * expireTime - # * customAttributes - # * visibility - # * publishDate - # * promotionValue - # * locations - # * region - # * expiryDate (deprecated) - # * filterableCustomFields (deprecated) - # * unindexedCustomFields (deprecated) + # experience. If update_job_fields is provided, only the specified fields in job + # are updated. Otherwise all the fields are updated. A field mask to restrict + # the fields that are updated. Valid values are: * jobTitle * employmentTypes * + # description * applicationUrls * applicationEmailList * applicationInstruction * + # responsibilities * qualifications * educationLevels * level * department * + # startDate * endDate * compensationInfo * incentives * languageCode * benefits * + # expireTime * customAttributes * visibility * publishDate * promotionValue * + # locations * region * expiryDate (deprecated) * filterableCustomFields ( + # deprecated) * unindexedCustomFields (deprecated) # Corresponds to the JSON property `updateJobFields` # @return [String] attr_accessor :update_job_fields diff --git a/generated/google/apis/jobs_v2/service.rb b/generated/google/apis/jobs_v2/service.rb index 5ba18c630..c658e460d 100644 --- a/generated/google/apis/jobs_v2/service.rb +++ b/generated/google/apis/jobs_v2/service.rb @@ -80,8 +80,8 @@ module Google # Deletes the specified company. # @param [String] name - # Required. The resource name of the company to be deleted, - # such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + # Required. The resource name of the company to be deleted, such as, "companies/ + # 0000aaaa-1111-bbbb-2222-cccc3333dddd". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -111,8 +111,8 @@ module Google # Retrieves the specified company. # @param [String] name - # Required. Resource name of the company to retrieve, - # such as "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + # Required. Resource name of the company to retrieve, such as "companies/ + # 0000aaaa-1111-bbbb-2222-cccc3333dddd". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -142,13 +142,12 @@ module Google # Lists all companies associated with a Cloud Talent Solution account. # @param [Boolean] must_have_open_jobs - # Optional. Set to true if the companies request must have open jobs. - # Defaults to false. - # If true, at most page_size of companies are fetched, among which + # Optional. Set to true if the companies request must have open jobs. Defaults + # to false. If true, at most page_size of companies are fetched, among which # only those with open jobs are returned. # @param [Fixnum] page_size - # Optional. The maximum number of companies to be returned, at most 100. - # Default is 100 if a non-positive number is provided. + # Optional. The maximum number of companies to be returned, at most 100. Default + # is 100 if a non-positive number is provided. # @param [String] page_token # Optional. The starting indicator from which to return results. # @param [String] fields @@ -184,30 +183,19 @@ module Google # company name, delete the company and all jobs associated with it, and only # then re-create them. # @param [String] name - # Required during company update. - # The resource name for a company. This is generated by the service when a - # company is created, for example, - # "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + # Required during company update. The resource name for a company. This is + # generated by the service when a company is created, for example, "companies/ + # 0000aaaa-1111-bbbb-2222-cccc3333dddd". # @param [Google::Apis::JobsV2::Company] company_object # @param [String] update_company_fields # Optional but strongly recommended to be provided for the best service - # experience. - # If update_company_fields is provided, only the specified fields in - # company are updated. Otherwise all the fields are updated. - # A field mask to specify the company fields to update. Valid values are: - # * displayName - # * website - # * imageUrl - # * companySize - # * distributorBillingCompanyId - # * companyInfoSources - # * careerPageLink - # * hiringAgency - # * hqLocation - # * eeoText - # * keywordSearchableCustomAttributes - # * title (deprecated) - # * keywordSearchableCustomFields (deprecated) + # experience. If update_company_fields is provided, only the specified fields in + # company are updated. Otherwise all the fields are updated. A field mask to + # specify the company fields to update. Valid values are: * displayName * + # website * imageUrl * companySize * distributorBillingCompanyId * + # companyInfoSources * careerPageLink * hiringAgency * hqLocation * eeoText * + # keywordSearchableCustomAttributes * title (deprecated) * + # keywordSearchableCustomFields (deprecated) # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -238,33 +226,26 @@ module Google execute_or_queue_command(command, &block) end - # Deprecated. Use ListJobs instead. - # Lists all jobs associated with a company. + # Deprecated. Use ListJobs instead. Lists all jobs associated with a company. # @param [String] company_name # Required. The resource name of the company that owns the jobs to be listed, # such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". # @param [Boolean] ids_only # Optional. If set to `true`, only job ID, job requisition ID and language code - # will be - # returned. - # A typical use is to synchronize job repositories. - # Defaults to false. + # will be returned. A typical use is to synchronize job repositories. Defaults + # to false. # @param [Boolean] include_jobs_count - # Deprecated. Please DO NOT use this field except for small companies. - # Suggest counting jobs page by page instead. - # Optional. - # Set to true if the total number of open jobs is to be returned. - # Defaults to false. + # Deprecated. Please DO NOT use this field except for small companies. Suggest + # counting jobs page by page instead. Optional. Set to true if the total number + # of open jobs is to be returned. Defaults to false. # @param [String] job_requisition_id # Optional. The requisition ID, also known as posting ID, assigned by the - # company - # to the job. - # The maximum number of allowable characters is 225. + # company to the job. The maximum number of allowable characters is 225. # @param [Fixnum] page_size - # Optional. The maximum number of jobs to be returned per page of results. - # If ids_only is set to true, the maximum allowed page size - # is 1000. Otherwise, the maximum allowed page size is 100. - # Default is 100 if empty or a number < 1 is specified. + # Optional. The maximum number of jobs to be returned per page of results. If + # ids_only is set to true, the maximum allowed page size is 1000. Otherwise, the + # maximum allowed page size is 100. Default is 100 if empty or a number < 1 is + # specified. # @param [String] page_token # Optional. The starting point of a query result. # @param [String] fields @@ -329,9 +310,8 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new job. - # Typically, the job becomes searchable within 10 seconds, but it may take - # up to 5 minutes. + # Creates a new job. Typically, the job becomes searchable within 10 seconds, + # but it may take up to 5 minutes. # @param [Google::Apis::JobsV2::CreateJobRequest] create_job_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -361,17 +341,15 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified job. - # Typically, the job becomes unsearchable within 10 seconds, but it may take - # up to 5 minutes. + # Deletes the specified job. Typically, the job becomes unsearchable within 10 + # seconds, but it may take up to 5 minutes. # @param [String] name # Required. The resource name of the job to be deleted, such as "jobs/11111111". # @param [Boolean] disable_fast_process - # Deprecated. This field is not working anymore. - # Optional. - # If set to true, this call waits for all processing steps to complete - # before the job is cleaned up. Otherwise, the call returns while some - # steps are still taking place asynchronously, hence faster. + # Deprecated. This field is not working anymore. Optional. If set to true, this + # call waits for all processing steps to complete before the job is cleaned up. + # Otherwise, the call returns while some steps are still taking place + # asynchronously, hence faster. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -400,10 +378,9 @@ module Google execute_or_queue_command(command, &block) end - # Deprecated. Use BatchDeleteJobs instead. - # Deletes the specified job by filter. You can specify whether to - # synchronously wait for validation, indexing, and general processing to be - # completed before the response is returned. + # Deprecated. Use BatchDeleteJobs instead. Deletes the specified job by filter. + # You can specify whether to synchronously wait for validation, indexing, and + # general processing to be completed before the response is returned. # @param [Google::Apis::JobsV2::DeleteJobsByFilterRequest] delete_jobs_by_filter_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -433,8 +410,8 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the specified job, whose status is OPEN or recently EXPIRED - # within the last 90 days. + # Retrieves the specified job, whose status is OPEN or recently EXPIRED within + # the last 90 days. # @param [String] name # Required. The resource name of the job to retrieve, such as "jobs/11111111". # @param [String] fields @@ -464,17 +441,13 @@ module Google execute_or_queue_command(command, &block) end - # Deprecated. Use SearchJobsRequest.histogram_facets instead to make - # a single call with both search and histogram. - # Retrieves a histogram for the given - # GetHistogramRequest. This call provides a structured - # count of jobs that match against the search query, grouped by specified - # facets. - # This call constrains the visibility of jobs - # present in the database, and only counts jobs the caller has - # permission to search against. - # For example, use this call to generate the - # number of jobs in the U.S. by state. + # Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single + # call with both search and histogram. Retrieves a histogram for the given + # GetHistogramRequest. This call provides a structured count of jobs that match + # against the search query, grouped by specified facets. This call constrains + # the visibility of jobs present in the database, and only counts jobs the + # caller has permission to search against. For example, use this call to + # generate the number of jobs in the U.S. by state. # @param [Google::Apis::JobsV2::GetHistogramRequest] get_histogram_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -506,24 +479,19 @@ module Google # Lists jobs by filter. # @param [String] filter - # Required. The filter string specifies the jobs to be enumerated. - # Supported operator: =, AND - # The fields eligible for filtering are: - # * `companyName` (Required) - # * `requisitionId` (Optional) - # Sample Query: - # * companyName = "companies/123" - # * companyName = "companies/123" AND requisitionId = "req-1" + # Required. The filter string specifies the jobs to be enumerated. Supported + # operator: =, AND The fields eligible for filtering are: * `companyName` ( + # Required) * `requisitionId` (Optional) Sample Query: * companyName = " + # companies/123" * companyName = "companies/123" AND requisitionId = "req-1" # @param [Boolean] ids_only - # Optional. If set to `true`, only Job.name, Job.requisition_id and - # Job.language_code will be returned. - # A typical use case is to synchronize job repositories. - # Defaults to false. + # Optional. If set to `true`, only Job.name, Job.requisition_id and Job. + # language_code will be returned. A typical use case is to synchronize job + # repositories. Defaults to false. # @param [Fixnum] page_size - # Optional. The maximum number of jobs to be returned per page of results. - # If ids_only is set to true, the maximum allowed page size - # is 1000. Otherwise, the maximum allowed page size is 100. - # Default is 100 if empty or a number < 1 is specified. + # Optional. The maximum number of jobs to be returned per page of results. If + # ids_only is set to true, the maximum allowed page size is 1000. Otherwise, the + # maximum allowed page size is 100. Default is 100 if empty or a number < 1 is + # specified. # @param [String] page_token # Optional. The starting point of a query result. # @param [String] fields @@ -556,14 +524,12 @@ module Google execute_or_queue_command(command, &block) end - # Updates specified job. - # Typically, updated contents become visible in search results within 10 - # seconds, but it may take up to 5 minutes. + # Updates specified job. Typically, updated contents become visible in search + # results within 10 seconds, but it may take up to 5 minutes. # @param [String] name - # Required during job update. - # Resource name assigned to a job by the API, for example, "/jobs/foo". Use - # of this field in job queries and API calls is preferred over the use of - # requisition_id since this value is unique. + # Required during job update. Resource name assigned to a job by the API, for + # example, "/jobs/foo". Use of this field in job queries and API calls is + # preferred over the use of requisition_id since this value is unique. # @param [Google::Apis::JobsV2::UpdateJobRequest] update_job_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -594,10 +560,9 @@ module Google execute_or_queue_command(command, &block) end - # Searches for jobs using the provided SearchJobsRequest. - # This call constrains the visibility of jobs - # present in the database, and only returns jobs that the caller has - # permission to search against. + # Searches for jobs using the provided SearchJobsRequest. This call constrains + # the visibility of jobs present in the database, and only returns jobs that the + # caller has permission to search against. # @param [Google::Apis::JobsV2::SearchJobsRequest] search_jobs_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -627,14 +592,13 @@ module Google execute_or_queue_command(command, &block) end - # Searches for jobs using the provided SearchJobsRequest. - # This API call is intended for the use case of targeting passive job - # seekers (for example, job seekers who have signed up to receive email - # alerts about potential job opportunities), and has different algorithmic - # adjustments that are targeted to passive job seekers. - # This call constrains the visibility of jobs - # present in the database, and only returns jobs the caller has - # permission to search against. + # Searches for jobs using the provided SearchJobsRequest. This API call is + # intended for the use case of targeting passive job seekers (for example, job + # seekers who have signed up to receive email alerts about potential job + # opportunities), and has different algorithmic adjustments that are targeted to + # passive job seekers. This call constrains the visibility of jobs present in + # the database, and only returns jobs the caller has permission to search + # against. # @param [Google::Apis::JobsV2::SearchJobsRequest] search_jobs_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -664,26 +628,21 @@ module Google execute_or_queue_command(command, &block) end - # Completes the specified prefix with job keyword suggestions. - # Intended for use by a job search auto-complete search box. + # Completes the specified prefix with job keyword suggestions. Intended for use + # by a job search auto-complete search box. # @param [String] company_name # Optional. If provided, restricts completion to the specified company. # @param [String] language_code - # Required. The language of the query. This is - # the BCP-47 language code, such as "en-US" or "sr-Latn". - # For more information, see - # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). - # For CompletionType.JOB_TITLE type, only open jobs with same - # language_code are returned. - # For CompletionType.COMPANY_NAME type, - # only companies having open jobs with same language_code are + # Required. The language of the query. This is the BCP-47 language code, such as + # "en-US" or "sr-Latn". For more information, see [Tags for Identifying + # Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE + # type, only open jobs with same language_code are returned. For CompletionType. + # COMPANY_NAME type, only companies having open jobs with same language_code are + # returned. For CompletionType.COMBINED type, only open jobs with same + # language_code or companies having open jobs with same language_code are # returned. - # For CompletionType.COMBINED type, only open jobs with same - # language_code or companies having open jobs with same - # language_code are returned. # @param [Fixnum] page_size - # Required. Completion result count. - # The maximum allowed page size is 10. + # Required. Completion result count. The maximum allowed page size is 10. # @param [String] query # Required. The query used to generate suggestions. # @param [String] scope diff --git a/generated/google/apis/jobs_v3.rb b/generated/google/apis/jobs_v3.rb index 38206aa8c..9a6f164d7 100644 --- a/generated/google/apis/jobs_v3.rb +++ b/generated/google/apis/jobs_v3.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/talent-solution/job-search/docs/ module JobsV3 VERSION = 'V3' - REVISION = '20200604' + REVISION = '20200828' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/jobs_v3/classes.rb b/generated/google/apis/jobs_v3/classes.rb index fd1710b7a..4b2578ed9 100644 --- a/generated/google/apis/jobs_v3/classes.rb +++ b/generated/google/apis/jobs_v3/classes.rb @@ -26,34 +26,26 @@ module Google class ApplicationInfo include Google::Apis::Core::Hashable - # Optional but at least one of uris, - # emails or instruction must be - # specified. - # Use this field to specify email address(es) to which resumes or - # applications can be sent. - # The maximum number of allowed characters for each entry is 255. + # Optional but at least one of uris, emails or instruction must be specified. + # Use this field to specify email address(es) to which resumes or applications + # can be sent. The maximum number of allowed characters for each entry is 255. # Corresponds to the JSON property `emails` # @return [Array] attr_accessor :emails - # Optional but at least one of uris, - # emails or instruction must be - # specified. - # Use this field to provide instructions, such as "Mail your application - # to ...", that a candidate can follow to apply for the job. - # This field accepts and sanitizes HTML input, and also accepts - # bold, italic, ordered list, and unordered list markup tags. - # The maximum number of allowed characters is 3,000. + # Optional but at least one of uris, emails or instruction must be specified. + # Use this field to provide instructions, such as "Mail your application to ...", + # that a candidate can follow to apply for the job. This field accepts and + # sanitizes HTML input, and also accepts bold, italic, ordered list, and + # unordered list markup tags. The maximum number of allowed characters is 3,000. # Corresponds to the JSON property `instruction` # @return [String] attr_accessor :instruction - # Optional but at least one of uris, - # emails or instruction must be - # specified. - # Use this URI field to direct an applicant to a website, for example to - # link to an online application form. - # The maximum number of allowed characters for each entry is 2,000. + # Optional but at least one of uris, emails or instruction must be specified. + # Use this URI field to direct an applicant to a website, for example to link to + # an online application form. The maximum number of allowed characters for each + # entry is 2,000. # Corresponds to the JSON property `uris` # @return [Array] attr_accessor :uris @@ -70,18 +62,14 @@ module Google end end - # Input only. - # Batch delete jobs request. + # Input only. Batch delete jobs request. class BatchDeleteJobsRequest include Google::Apis::Core::Hashable - # Required. The filter string specifies the jobs to be deleted. - # Supported operator: =, AND - # The fields eligible for filtering are: - # * `companyName` (Required) - # * `requisitionId` (Required) - # Sample Query: companyName = "projects/api-test-project/companies/123" AND - # requisitionId = "req-1" + # Required. The filter string specifies the jobs to be deleted. Supported + # operator: =, AND The fields eligible for filtering are: * `companyName` ( + # Required) * `requisitionId` (Required) Sample Query: companyName = "projects/ + # api-test-project/companies/123" AND requisitionId = "req-1" # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter @@ -148,9 +136,9 @@ module Google # An event issued when an end user interacts with the application that # implements Cloud Talent Solution. Providing this information improves the - # quality of search and recommendation for the API clients, enabling the - # service to perform optimally. The number of events sent must be consistent - # with other calls, such as job searches, issued to the service by the client. + # quality of search and recommendation for the API clients, enabling the service + # to perform optimally. The number of events sent must be consistent with other + # calls, such as job searches, issued to the service by the client. class ClientEvent include Google::Apis::Core::Hashable @@ -160,19 +148,16 @@ module Google attr_accessor :create_time # Required. A unique identifier, generated by the client application. This ` - # event_id` - # is used to establish the relationship between different events - # (see parent_event_id). + # event_id` is used to establish the relationship between different events (see + # parent_event_id). # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id # Optional. Extra information about this event. Used for storing information - # with no - # matching field in event payload, for example, user application specific - # context or details. - # At most 20 keys are supported. The maximum total size of all keys and - # values is 2 KB. + # with no matching field in event payload, for example, user application + # specific context or details. At most 20 keys are supported. The maximum total + # size of all keys and values is 2 KB. # Corresponds to the JSON property `extraInfo` # @return [Hash] attr_accessor :extra_info @@ -184,13 +169,10 @@ module Google attr_accessor :job_event # Optional. The event_id of an event that resulted in the current event. For - # example, a - # Job view event usually follows a parent - # impression event: A job seeker first does a - # search where a list of jobs appears - # (impression). The job seeker then selects a - # result and views the description of a particular job (Job - # view). + # example, a Job view event usually follows a parent impression event: A job + # seeker first does a search where a list of jobs appears (impression). The job + # seeker then selects a result and views the description of a particular job ( + # Job view). # Corresponds to the JSON property `parentEventId` # @return [String] attr_accessor :parent_event_id @@ -216,21 +198,18 @@ module Google end end - # Input only. - # Parameters needed for commute search. + # Input only. Parameters needed for commute search. class CommuteFilter include Google::Apis::Core::Hashable # Optional. If true, jobs without "precise" addresses (street level addresses or - # GPS - # coordinates) might also be returned. For city and coarser level addresses, - # text matching is used. If this field is set to false or is not specified, - # only jobs that include precise addresses are returned by Commute - # Search. - # Note: If `allow_imprecise_addresses` is set to true, Commute Search is not - # able to calculate accurate commute times to jobs with city level and - # coarser address information. Jobs with imprecise addresses will return a - # `travel_duration` time of 0 regardless of distance from the job seeker. + # GPS coordinates) might also be returned. For city and coarser level addresses, + # text matching is used. If this field is set to false or is not specified, only + # jobs that include precise addresses are returned by Commute Search. Note: If ` + # allow_imprecise_addresses` is set to true, Commute Search is not able to + # calculate accurate commute times to jobs with city level and coarser address + # information. Jobs with imprecise addresses will return a `travel_duration` + # time of 0 regardless of distance from the job seeker. # Corresponds to the JSON property `allowImpreciseAddresses` # @return [Boolean] attr_accessor :allow_imprecise_addresses @@ -241,8 +220,8 @@ module Google # @return [String] attr_accessor :commute_method - # Represents a time of day. The date and time zone are either not significant - # or are specified elsewhere. An API may choose to allow leap seconds. Related + # Represents a time of day. The date and time zone are either not significant or + # are specified elsewhere. An API may choose to allow leap seconds. Related # types are google.type.Date and `google.protobuf.Timestamp`. # Corresponds to the JSON property `departureTime` # @return [Google::Apis::JobsV3::TimeOfDay] @@ -255,16 +234,14 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `startCoordinates` # @return [Google::Apis::JobsV3::LatLng] attr_accessor :start_coordinates # Required. The maximum travel time in seconds. The maximum allowed value is ` - # 3600s` - # (one hour). Format is `123s`. + # 3600s` (one hour). Format is `123s`. # Corresponds to the JSON property `travelDuration` # @return [String] attr_accessor :travel_duration @@ -284,21 +261,19 @@ module Google end end - # Output only. - # Commute details related to this job. + # Output only. Commute details related to this job. class CommuteInfo include Google::Apis::Core::Hashable - # Output only. - # A resource that represents a location with full geographic information. + # Output only. A resource that represents a location with full geographic + # information. # Corresponds to the JSON property `jobLocation` # @return [Google::Apis::JobsV3::Location] attr_accessor :job_location - # The number of seconds required to travel to the job location from the - # query location. A duration of 0 seconds indicates that the job is not - # reachable within the requested duration, but was returned as part of an - # expanded query. + # The number of seconds required to travel to the job location from the query + # location. A duration of 0 seconds indicates that the job is not reachable + # within the requested duration, but was returned as part of an expanded query. # Corresponds to the JSON property `travelDuration` # @return [String] attr_accessor :travel_duration @@ -321,8 +296,7 @@ module Google include Google::Apis::Core::Hashable # Optional. The URI to employer's career site or careers page on the employer's - # web - # site, for example, "https://careers.google.com". + # web site, for example, "https://careers.google.com". # Corresponds to the JSON property `careerSiteUri` # @return [String] attr_accessor :career_site_uri @@ -337,32 +311,29 @@ module Google # @return [String] attr_accessor :display_name - # Optional. Equal Employment Opportunity legal disclaimer text to be - # associated with all jobs, and typically to be displayed in all - # roles. - # The maximum number of allowed characters is 500. + # Optional. Equal Employment Opportunity legal disclaimer text to be associated + # with all jobs, and typically to be displayed in all roles. The maximum number + # of allowed characters is 500. # Corresponds to the JSON property `eeoText` # @return [String] attr_accessor :eeo_text # Required. Client side company identifier, used to uniquely identify the - # company. - # The maximum number of allowed characters is 255. + # company. The maximum number of allowed characters is 255. # Corresponds to the JSON property `externalId` # @return [String] attr_accessor :external_id # Optional. The street address of the company's main headquarters, which may be - # different from the job location. The service attempts - # to geolocate the provided address, and populates a more specific - # location wherever possible in DerivedInfo.headquarters_location. + # different from the job location. The service attempts to geolocate the + # provided address, and populates a more specific location wherever possible in + # DerivedInfo.headquarters_location. # Corresponds to the JSON property `headquartersAddress` # @return [String] attr_accessor :headquarters_address # Optional. Set to true if it is the hiring agency that post jobs for other - # employers. - # Defaults to false if not provided. + # employers. Defaults to false if not provided. # Corresponds to the JSON property `hiringAgency` # @return [Boolean] attr_accessor :hiring_agency @@ -374,20 +345,19 @@ module Google attr_accessor :image_uri # Optional. A list of keys of filterable Job.custom_attributes, whose - # corresponding `string_values` are used in keyword search. Jobs with - # `string_values` under these specified field keys are returned if any - # of the values matches the search keyword. Custom field values with - # parenthesis, brackets and special symbols won't be properly searchable, - # and those keyword queries need to be surrounded by quotes. + # corresponding `string_values` are used in keyword search. Jobs with ` + # string_values` under these specified field keys are returned if any of the + # values matches the search keyword. Custom field values with parenthesis, + # brackets and special symbols won't be properly searchable, and those keyword + # queries need to be surrounded by quotes. # Corresponds to the JSON property `keywordSearchableJobCustomAttributes` # @return [Array] attr_accessor :keyword_searchable_job_custom_attributes - # Required during company update. - # The resource name for a company. This is generated by the service when a - # company is created. - # The format is "projects/`project_id`/companies/`company_id`", for example, - # "projects/api-test-project/companies/foo". + # Required during company update. The resource name for a company. This is + # generated by the service when a company is created. The format is "projects/` + # project_id`/companies/`company_id`", for example, "projects/api-test-project/ + # companies/foo". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -406,8 +376,8 @@ module Google alias_method :suspended?, :suspended # Optional. The URI representing the company's primary web site or home page, - # for example, "https://www.google.com". - # The maximum number of allowed characters is 255. + # for example, "https://www.google.com". The maximum number of allowed + # characters is 255. # Corresponds to the JSON property `websiteUri` # @return [String] attr_accessor :website_uri @@ -438,8 +408,8 @@ module Google class CompanyDerivedInfo include Google::Apis::Core::Hashable - # Output only. - # A resource that represents a location with full geographic information. + # Output only. A resource that represents a location with full geographic + # information. # Corresponds to the JSON property `headquartersLocation` # @return [Google::Apis::JobsV3::Location] attr_accessor :headquarters_location @@ -454,13 +424,11 @@ module Google end end - # A compensation entry that represents one component of compensation, such - # as base pay, bonus, or other compensation type. - # Annualization: One compensation entry can be annualized if - # - it contains valid amount or range. - # - and its expected_units_per_year is set or can be derived. - # Its annualized range is determined as (amount or range) times - # expected_units_per_year. + # A compensation entry that represents one component of compensation, such as + # base pay, bonus, or other compensation type. Annualization: One compensation + # entry can be annualized if - it contains valid amount or range. - and its + # expected_units_per_year is set or can be derived. Its annualized range is + # determined as (amount or range) times expected_units_per_year. class CompensationEntry include Google::Apis::Core::Hashable @@ -469,21 +437,16 @@ module Google # @return [Google::Apis::JobsV3::Money] attr_accessor :amount - # Optional. Compensation description. For example, could - # indicate equity terms or provide additional context to an estimated - # bonus. + # Optional. Compensation description. For example, could indicate equity terms + # or provide additional context to an estimated bonus. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Optional. Expected number of units paid each year. If not specified, when - # Job.employment_types is FULLTIME, a default value is inferred - # based on unit. Default values: - # - HOURLY: 2080 - # - DAILY: 260 - # - WEEKLY: 52 - # - MONTHLY: 12 - # - ANNUAL: 1 + # Optional. Expected number of units paid each year. If not specified, when Job. + # employment_types is FULLTIME, a default value is inferred based on unit. + # Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - + # ANNUAL: 1 # Corresponds to the JSON property `expectedUnitsPerYear` # @return [Float] attr_accessor :expected_units_per_year @@ -493,14 +456,14 @@ module Google # @return [Google::Apis::JobsV3::CompensationRange] attr_accessor :range - # Optional. Compensation type. - # Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED. + # Optional. Compensation type. Default is CompensationUnit. + # COMPENSATION_TYPE_UNSPECIFIED. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # Optional. Frequency of the specified amount. - # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. + # Optional. Frequency of the specified amount. Default is CompensationUnit. + # COMPENSATION_UNIT_UNSPECIFIED. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit @@ -520,8 +483,7 @@ module Google end end - # Input only. - # Filter on job compensation type and amount. + # Input only. Filter on job compensation type and amount. class CompensationFilter include Google::Apis::Core::Hashable @@ -542,8 +504,8 @@ module Google # @return [String] attr_accessor :type - # Required. Specify desired `base compensation entry's` - # CompensationInfo.CompensationUnit. + # Required. Specify desired `base compensation entry's` CompensationInfo. + # CompensationUnit. # Corresponds to the JSON property `units` # @return [Array] attr_accessor :units @@ -561,21 +523,19 @@ module Google end end - # Input only. - # Compensation based histogram request. + # Input only. Compensation based histogram request. class CompensationHistogramRequest include Google::Apis::Core::Hashable - # Input only. - # Use this field to specify bucketing option for the histogram search response. + # Input only. Use this field to specify bucketing option for the histogram + # search response. # Corresponds to the JSON property `bucketingOption` # @return [Google::Apis::JobsV3::NumericBucketingOption] attr_accessor :bucketing_option # Required. Type of the request, representing which field the histogramming - # should be - # performed over. A single request can only specify one histogram of each - # `CompensationHistogramRequestType`. + # should be performed over. A single request can only specify one histogram of + # each `CompensationHistogramRequestType`. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -591,19 +551,16 @@ module Google end end - # Output only. - # Compensation based histogram result. + # Output only. Compensation based histogram result. class CompensationHistogramResult include Google::Apis::Core::Hashable - # Output only. - # Custom numeric bucketing result. + # Output only. Custom numeric bucketing result. # Corresponds to the JSON property `result` # @return [Google::Apis::JobsV3::NumericBucketingResult] attr_accessor :result - # Type of the request, corresponding to - # CompensationHistogramRequest.type. + # Type of the request, corresponding to CompensationHistogramRequest.type. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -633,10 +590,9 @@ module Google # @return [Google::Apis::JobsV3::CompensationRange] attr_accessor :annualized_total_compensation_range - # Optional. Job compensation information. - # At most one entry can be of type - # CompensationInfo.CompensationType.BASE, which is - # referred as ** base compensation entry ** for the job. + # Optional. Job compensation information. At most one entry can be of type + # CompensationInfo.CompensationType.BASE, which is referred as ** base + # compensation entry ** for the job. # Corresponds to the JSON property `entries` # @return [Array] attr_accessor :entries @@ -678,8 +634,7 @@ module Google end end - # Output only. - # Response of auto-complete query. + # Output only. Response of auto-complete query. class CompleteQueryResponse include Google::Apis::Core::Hashable @@ -688,8 +643,8 @@ module Google # @return [Array] attr_accessor :completion_results - # Output only. - # Additional information returned to client, such as debugging information. + # Output only. Additional information returned to client, such as debugging + # information. # Corresponds to the JSON property `metadata` # @return [Google::Apis::JobsV3::ResponseMetadata] attr_accessor :metadata @@ -705,8 +660,7 @@ module Google end end - # Output only. - # Resource that represents completion results. + # Output only. Resource that represents completion results. class CompletionResult include Google::Apis::Core::Hashable @@ -743,9 +697,9 @@ module Google # An event issued when an end user interacts with the application that # implements Cloud Talent Solution. Providing this information improves the - # quality of search and recommendation for the API clients, enabling the - # service to perform optimally. The number of events sent must be consistent - # with other calls, such as job searches, issued to the service by the client. + # quality of search and recommendation for the API clients, enabling the service + # to perform optimally. The number of events sent must be consistent with other + # calls, such as job searches, issued to the service by the client. # Corresponds to the JSON property `clientEvent` # @return [Google::Apis::JobsV3::ClientEvent] attr_accessor :client_event @@ -760,8 +714,7 @@ module Google end end - # Input only. - # The Request of the CreateCompany method. + # Input only. The Request of the CreateCompany method. class CreateCompanyRequest include Google::Apis::Core::Hashable @@ -782,14 +735,13 @@ module Google end end - # Input only. - # Create job request. + # Input only. Create job request. class CreateJobRequest include Google::Apis::Core::Hashable # A Job resource represents a job posting (also referred to as a "job listing" - # or "job requisition"). A job belongs to a Company, which is the hiring - # entity responsible for the job. + # or "job requisition"). A job belongs to a Company, which is the hiring entity + # responsible for the job. # Corresponds to the JSON property `job` # @return [Google::Apis::JobsV3::Job] attr_accessor :job @@ -809,33 +761,27 @@ module Google include Google::Apis::Core::Hashable # Optional. If the `filterable` flag is true, the custom field values may be - # used for - # custom attribute filters JobQuery.custom_attribute_filter. - # If false, these values may not be used for custom attribute filters. - # Default is false. + # used for custom attribute filters JobQuery.custom_attribute_filter. If false, + # these values may not be used for custom attribute filters. Default is false. # Corresponds to the JSON property `filterable` # @return [Boolean] attr_accessor :filterable alias_method :filterable?, :filterable - # Optional but exactly one of string_values or long_values must - # be specified. - # This field is used to perform number range search. - # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. - # Currently at most 1 long_values is supported. + # Optional but exactly one of string_values or long_values must be specified. + # This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, ` + # LT`) over filterable `long_value`. Currently at most 1 long_values is + # supported. # Corresponds to the JSON property `longValues` # @return [Array] attr_accessor :long_values - # Optional but exactly one of string_values or long_values must - # be specified. - # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or - # `CASE_INSENSITIVE_MATCH`) search. - # For filterable `string_value`s, a maximum total number of 200 values - # is allowed, with each `string_value` has a byte size of no more than - # 500B. For unfilterable `string_values`, the maximum total byte size of - # unfilterable `string_values` is 50KB. - # Empty string is not allowed. + # Optional but exactly one of string_values or long_values must be specified. + # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or ` + # CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum + # total number of 200 values is allowed, with each `string_value` has a byte + # size of no more than 500B. For unfilterable `string_values`, the maximum total + # byte size of unfilterable `string_values` is 50KB. Empty string is not allowed. # Corresponds to the JSON property `stringValues` # @return [Array] attr_accessor :string_values @@ -853,28 +799,27 @@ module Google end # Custom attributes histogram request. An error is thrown if neither - # string_value_histogram or long_value_histogram_bucketing_option has - # been defined. + # string_value_histogram or long_value_histogram_bucketing_option has been + # defined. class CustomAttributeHistogramRequest include Google::Apis::Core::Hashable # Required. Specifies the custom field key to perform a histogram on. If - # specified - # without `long_value_histogram_bucketing_option`, histogram on string values - # of the given `key` is triggered, otherwise histogram is performed on long - # values. + # specified without `long_value_histogram_bucketing_option`, histogram on string + # values of the given `key` is triggered, otherwise histogram is performed on + # long values. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key - # Input only. - # Use this field to specify bucketing option for the histogram search response. + # Input only. Use this field to specify bucketing option for the histogram + # search response. # Corresponds to the JSON property `longValueHistogramBucketingOption` # @return [Google::Apis::JobsV3::NumericBucketingOption] attr_accessor :long_value_histogram_bucketing_option - # Optional. If set to true, the response includes the histogram value for - # each key as a string. + # Optional. If set to true, the response includes the histogram value for each + # key as a string. # Corresponds to the JSON property `stringValueHistogram` # @return [Boolean] attr_accessor :string_value_histogram @@ -892,8 +837,7 @@ module Google end end - # Output only. - # Custom attribute histogram result. + # Output only. Custom attribute histogram result. class CustomAttributeHistogramResult include Google::Apis::Core::Hashable @@ -902,14 +846,13 @@ module Google # @return [String] attr_accessor :key - # Output only. - # Custom numeric bucketing result. + # Output only. Custom numeric bucketing result. # Corresponds to the JSON property `longValueHistogramResult` # @return [Google::Apis::JobsV3::NumericBucketingResult] attr_accessor :long_value_histogram_result - # Stores a map from the values of string custom field associated - # with `key` to the number of jobs with that value in this histogram result. + # Stores a map from the values of string custom field associated with `key` to + # the number of jobs with that value in this histogram result. # Corresponds to the JSON property `stringValueHistogramResult` # @return [Hash] attr_accessor :string_value_histogram_result @@ -926,9 +869,9 @@ module Google end end - # Device information collected from the job seeker, candidate, or - # other entity conducting the job search. Providing this information improves - # the quality of the search results across devices. + # Device information collected from the job seeker, candidate, or other entity + # conducting the job search. Providing this information improves the quality of + # the search results across devices. class DeviceInfo include Google::Apis::Core::Hashable @@ -954,13 +897,11 @@ module Google end end - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. class Empty include Google::Apis::Core::Hashable @@ -973,26 +914,24 @@ module Google end end - # Input only. - # Histogram facets to be specified in SearchJobsRequest. + # Input only. Histogram facets to be specified in SearchJobsRequest. class HistogramFacets include Google::Apis::Core::Hashable - # Optional. Specifies compensation field-based histogram requests. - # Duplicate values of CompensationHistogramRequest.type are not allowed. + # Optional. Specifies compensation field-based histogram requests. Duplicate + # values of CompensationHistogramRequest.type are not allowed. # Corresponds to the JSON property `compensationHistogramFacets` # @return [Array] attr_accessor :compensation_histogram_facets - # Optional. Specifies the custom attributes histogram requests. - # Duplicate values of CustomAttributeHistogramRequest.key are not - # allowed. + # Optional. Specifies the custom attributes histogram requests. Duplicate values + # of CustomAttributeHistogramRequest.key are not allowed. # Corresponds to the JSON property `customAttributeHistogramFacets` # @return [Array] attr_accessor :custom_attribute_histogram_facets - # Optional. Specifies the simple type of histogram facets, for example, - # `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. + # Optional. Specifies the simple type of histogram facets, for example, ` + # COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. # Corresponds to the JSON property `simpleHistogramFacets` # @return [Array] attr_accessor :simple_histogram_facets @@ -1009,11 +948,9 @@ module Google end end - # Output only. - # Result of a histogram call. The response contains the histogram map for the - # search type specified by HistogramResult.field. - # The response is a map of each filter value to the corresponding count of - # jobs for that filter. + # Output only. Result of a histogram call. The response contains the histogram + # map for the search type specified by HistogramResult.field. The response is a + # map of each filter value to the corresponding count of jobs for that filter. class HistogramResult include Google::Apis::Core::Hashable @@ -1022,9 +959,8 @@ module Google # @return [String] attr_accessor :search_type - # A map from the values of field to the number of jobs with that value - # in this search result. - # Key: search type (filter names, such as the companyName). + # A map from the values of field to the number of jobs with that value in this + # search result. Key: search type (filter names, such as the companyName). # Values: the count of jobs that match the filter for this search. # Corresponds to the JSON property `values` # @return [Hash] @@ -1041,8 +977,7 @@ module Google end end - # Output only. - # Histogram results that match HistogramFacets specified in + # Output only. Histogram results that match HistogramFacets specified in # SearchJobsRequest. class HistogramResults include Google::Apis::Core::Hashable @@ -1053,14 +988,14 @@ module Google # @return [Array] attr_accessor :compensation_histogram_results - # Specifies histogram results for custom attributes that match - # HistogramFacets.custom_attribute_histogram_facets. + # Specifies histogram results for custom attributes that match HistogramFacets. + # custom_attribute_histogram_facets. # Corresponds to the JSON property `customAttributeHistogramResults` # @return [Array] attr_accessor :custom_attribute_histogram_results - # Specifies histogram results that matches - # HistogramFacets.simple_histogram_facets. + # Specifies histogram results that matches HistogramFacets. + # simple_histogram_facets. # Corresponds to the JSON property `simpleHistogramResults` # @return [Array] attr_accessor :simple_histogram_results @@ -1078,24 +1013,22 @@ module Google end # A Job resource represents a job posting (also referred to as a "job listing" - # or "job requisition"). A job belongs to a Company, which is the hiring - # entity responsible for the job. + # or "job requisition"). A job belongs to a Company, which is the hiring entity + # responsible for the job. class Job include Google::Apis::Core::Hashable - # Optional but strongly recommended for the best service experience. - # Location(s) where the employer is looking to hire for this job posting. - # Specifying the full street address(es) of the hiring location enables - # better API results, especially job searches by commute time. - # At most 50 locations are allowed for best search performance. If a job has - # more locations, it is suggested to split it into multiple jobs with unique - # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as - # multiple jobs with the same company_name, language_code and - # requisition_id are not allowed. If the original requisition_id must - # be preserved, a custom field should be used for storage. It is also - # suggested to group the locations that close to each other in the same job - # for better search experience. - # The maximum number of allowed characters is 500. + # Optional but strongly recommended for the best service experience. Location(s) + # where the employer is looking to hire for this job posting. Specifying the + # full street address(es) of the hiring location enables better API results, + # especially job searches by commute time. At most 50 locations are allowed for + # best search performance. If a job has more locations, it is suggested to split + # it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1' + # , 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code + # and requisition_id are not allowed. If the original requisition_id must be + # preserved, a custom field should be used for storage. It is also suggested to + # group the locations that close to each other in the same job for better search + # experience. The maximum number of allowed characters is 500. # Corresponds to the JSON property `addresses` # @return [Array] attr_accessor :addresses @@ -1110,8 +1043,8 @@ module Google # @return [String] attr_accessor :company_display_name - # Required. The resource name of the company listing the job, such as - # "projects/api-test-project/companies/foo". + # Required. The resource name of the company listing the job, such as "projects/ + # api-test-project/companies/foo". # Corresponds to the JSON property `companyName` # @return [String] attr_accessor :company_name @@ -1122,16 +1055,13 @@ module Google attr_accessor :compensation_info # Optional. A map of fields to hold both filterable and non-filterable custom - # job - # attributes that are not covered by the provided structured fields. - # The keys of the map are strings up to 64 bytes and must match the - # pattern: a-zA-Z*. For example, key0LikeThis or - # KEY_1_LIKE_THIS. - # At most 100 filterable and at most 100 unfilterable keys are supported. - # For filterable `string_values`, across all keys at most 200 values are - # allowed, with each string no more than 255 characters. For unfilterable - # `string_values`, the maximum total size of `string_values` across all keys - # is 50KB. + # job attributes that are not covered by the provided structured fields. The + # keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. + # For example, key0LikeThis or KEY_1_LIKE_THIS. At most 100 filterable and at + # most 100 unfilterable keys are supported. For filterable `string_values`, + # across all keys at most 200 values are allowed, with each string no more than + # 255 characters. For unfilterable `string_values`, the maximum total size of ` + # string_values` across all keys is 50KB. # Corresponds to the JSON property `customAttributes` # @return [Hash] attr_accessor :custom_attributes @@ -1143,41 +1073,35 @@ module Google attr_accessor :degree_types # Optional. The department or functional area within the company with the open - # position. - # The maximum number of allowed characters is 255. + # position. The maximum number of allowed characters is 255. # Corresponds to the JSON property `department` # @return [String] attr_accessor :department - # Output only. - # Derived details about the job posting. + # Output only. Derived details about the job posting. # Corresponds to the JSON property `derivedInfo` # @return [Google::Apis::JobsV3::JobDerivedInfo] attr_accessor :derived_info # Required. The description of the job, which typically includes a multi- - # paragraph - # description of the company and related information. Separate fields are - # provided on the job object for responsibilities, - # qualifications, and other job characteristics. Use of - # these separate job fields is recommended. - # This field accepts and sanitizes HTML input, and also accepts - # bold, italic, ordered list, and unordered list markup tags. - # The maximum number of allowed characters is 100,000. + # paragraph description of the company and related information. Separate fields + # are provided on the job object for responsibilities, qualifications, and other + # job characteristics. Use of these separate job fields is recommended. This + # field accepts and sanitizes HTML input, and also accepts bold, italic, ordered + # list, and unordered list markup tags. The maximum number of allowed characters + # is 100,000. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Optional. The employment type(s) of a job, for example, - # full time or - # part time. + # Optional. The employment type(s) of a job, for example, full time or part time. # Corresponds to the JSON property `employmentTypes` # @return [Array] attr_accessor :employment_types # Optional. A description of bonus, commission, and other compensation - # incentives associated with the job not including salary or pay. - # The maximum number of allowed characters is 10,000. + # incentives associated with the job not including salary or pay. The maximum + # number of allowed characters is 10,000. # Corresponds to the JSON property `incentives` # @return [String] attr_accessor :incentives @@ -1188,8 +1112,7 @@ module Google attr_accessor :job_benefits # Optional. The end timestamp of the job. Typically this field is used for - # contracting - # engagements. Invalid timestamps are ignored. + # contracting engagements. Invalid timestamps are ignored. # Corresponds to the JSON property `jobEndTime` # @return [String] attr_accessor :job_end_time @@ -1200,31 +1123,26 @@ module Google attr_accessor :job_level # Optional. The start timestamp of the job in UTC time zone. Typically this - # field - # is used for contracting engagements. Invalid timestamps are ignored. + # field is used for contracting engagements. Invalid timestamps are ignored. # Corresponds to the JSON property `jobStartTime` # @return [String] attr_accessor :job_start_time - # Optional. The language of the posting. This field is distinct from - # any requirements for fluency that are associated with the job. - # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". - # For more information, see - # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47)`: - # class="external" target="_blank" `. - # If this field is unspecified and Job.description is present, detected - # language code based on Job.description is assigned, otherwise - # defaults to 'en_US'. + # Optional. The language of the posting. This field is distinct from any + # requirements for fluency that are associated with the job. Language codes must + # be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [ + # Tags for Identifying Languages](https://tools.ietf.org/html/bcp47)`: class=" + # external" target="_blank" `. If this field is unspecified and Job.description + # is present, detected language code based on Job.description is assigned, + # otherwise defaults to 'en_US'. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code - # Required during job update. - # The resource name for the job. This is generated by the service when a - # job is created. - # The format is "projects/`project_id`/jobs/`job_id`", - # for example, "projects/api-test-project/jobs/1234". - # Use of this field in job queries and API calls is preferred over the use of + # Required during job update. The resource name for the job. This is generated + # by the service when a job is created. The format is "projects/`project_id`/ + # jobs/`job_id`", for example, "projects/api-test-project/jobs/1234". Use of + # this field in job queries and API calls is preferred over the use of # requisition_id since this value is unique. # Corresponds to the JSON property `name` # @return [String] @@ -1235,52 +1153,45 @@ module Google # @return [String] attr_accessor :posting_create_time - # Optional but strongly recommended for the best service - # experience. - # The expiration timestamp of the job. After this timestamp, the - # job is marked as expired, and it no longer appears in search results. The - # expired job can't be deleted or listed by the DeleteJob and - # ListJobs APIs, but it can be retrieved with the GetJob API or - # updated with the UpdateJob API. An expired job can be updated and - # opened again by using a future expiration timestamp. Updating an expired - # job fails if there is another existing open job with same company_name, - # language_code and requisition_id. - # The expired jobs are retained in our system for 90 days. However, the - # overall expired job count cannot exceed 3 times the maximum of open jobs - # count over the past week, otherwise jobs with earlier expire time are - # cleaned first. Expired jobs are no longer accessible after they are cleaned - # out. - # Invalid timestamps are ignored, and treated as expire time not provided. - # Timestamp before the instant request is made is considered valid, the job - # will be treated as expired immediately. - # If this value is not provided at the time of job creation or is invalid, - # the job posting expires after 30 days from the job's creation time. For - # example, if the job was created on 2017/01/01 13:00AM UTC with an - # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. - # If this value is not provided on job update, it depends on the field masks - # set by UpdateJobRequest.update_mask. If the field masks include - # expiry_time, or the masks are empty meaning that every field is - # updated, the job posting expires after 30 days from the job's last + # Optional but strongly recommended for the best service experience. The + # expiration timestamp of the job. After this timestamp, the job is marked as + # expired, and it no longer appears in search results. The expired job can't be + # deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved + # with the GetJob API or updated with the UpdateJob API. An expired job can be + # updated and opened again by using a future expiration timestamp. Updating an + # expired job fails if there is another existing open job with same company_name, + # language_code and requisition_id. The expired jobs are retained in our system + # for 90 days. However, the overall expired job count cannot exceed 3 times the + # maximum of open jobs count over the past week, otherwise jobs with earlier + # expire time are cleaned first. Expired jobs are no longer accessible after + # they are cleaned out. Invalid timestamps are ignored, and treated as expire + # time not provided. Timestamp before the instant request is made is considered + # valid, the job will be treated as expired immediately. If this value is not + # provided at the time of job creation or is invalid, the job posting expires + # after 30 days from the job's creation time. For example, if the job was + # created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job + # expires after 2017/01/31 13:00AM UTC. If this value is not provided on job + # update, it depends on the field masks set by UpdateJobRequest.update_mask. If + # the field masks include expiry_time, or the masks are empty meaning that every + # field is updated, the job posting expires after 30 days from the job's last # update time. Otherwise the expiration date isn't updated. # Corresponds to the JSON property `postingExpireTime` # @return [String] attr_accessor :posting_expire_time # Optional. The timestamp this job posting was most recently published. The - # default - # value is the time the request arrives at the server. Invalid timestamps are - # ignored. + # default value is the time the request arrives at the server. Invalid + # timestamps are ignored. # Corresponds to the JSON property `postingPublishTime` # @return [String] attr_accessor :posting_publish_time # Optional. The job PostingRegion (for example, state, country) throughout which - # the job is available. If this field is set, a - # LocationFilter in a search query within the job region - # finds this job posting if an exact location match isn't specified. - # If this field is set to PostingRegion.NATION or - # PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses - # to the same location level as this field is strongly recommended. + # the job is available. If this field is set, a LocationFilter in a search query + # within the job region finds this job posting if an exact location match isn't + # specified. If this field is set to PostingRegion.NATION or PostingRegion. + # ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as + # this field is strongly recommended. # Corresponds to the JSON property `postingRegion` # @return [String] attr_accessor :posting_region @@ -1290,61 +1201,55 @@ module Google # @return [String] attr_accessor :posting_update_time - # Input only. - # Options for job processing. + # Input only. Options for job processing. # Corresponds to the JSON property `processingOptions` # @return [Google::Apis::JobsV3::ProcessingOptions] attr_accessor :processing_options - # Optional. A promotion value of the job, as determined by the client. - # The value determines the sort order of the jobs returned when searching for - # jobs using the featured jobs search call, with higher promotional values - # being returned first and ties being resolved by relevance sort. Only the - # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. - # Default value is 0, and negative values are treated as 0. + # Optional. A promotion value of the job, as determined by the client. The value + # determines the sort order of the jobs returned when searching for jobs using + # the featured jobs search call, with higher promotional values being returned + # first and ties being resolved by relevance sort. Only the jobs with a + # promotionValue >0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, + # and negative values are treated as 0. # Corresponds to the JSON property `promotionValue` # @return [Fixnum] attr_accessor :promotion_value - # Optional. A description of the qualifications required to perform the - # job. The use of this field is recommended - # as an alternative to using the more general description field. - # This field accepts and sanitizes HTML input, and also accepts - # bold, italic, ordered list, and unordered list markup tags. - # The maximum number of allowed characters is 10,000. + # Optional. A description of the qualifications required to perform the job. The + # use of this field is recommended as an alternative to using the more general + # description field. This field accepts and sanitizes HTML input, and also + # accepts bold, italic, ordered list, and unordered list markup tags. The + # maximum number of allowed characters is 10,000. # Corresponds to the JSON property `qualifications` # @return [String] attr_accessor :qualifications # Required. The requisition ID, also referred to as the posting ID, assigned by - # the - # client to identify a job. This field is intended to be used by clients - # for client identification and tracking of postings. A job is not allowed - # to be created if there is another job with the same [company_name], - # language_code and requisition_id. - # The maximum number of allowed characters is 255. + # the client to identify a job. This field is intended to be used by clients for + # client identification and tracking of postings. A job is not allowed to be + # created if there is another job with the same [company_name], language_code + # and requisition_id. The maximum number of allowed characters is 255. # Corresponds to the JSON property `requisitionId` # @return [String] attr_accessor :requisition_id # Optional. A description of job responsibilities. The use of this field is - # recommended as an alternative to using the more general description - # field. - # This field accepts and sanitizes HTML input, and also accepts - # bold, italic, ordered list, and unordered list markup tags. - # The maximum number of allowed characters is 10,000. + # recommended as an alternative to using the more general description field. + # This field accepts and sanitizes HTML input, and also accepts bold, italic, + # ordered list, and unordered list markup tags. The maximum number of allowed + # characters is 10,000. # Corresponds to the JSON property `responsibilities` # @return [String] attr_accessor :responsibilities - # Required. The title of the job, such as "Software Engineer" - # The maximum number of allowed characters is 500. + # Required. The title of the job, such as "Software Engineer" The maximum number + # of allowed characters is 500. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title - # Deprecated. The job is only visible to the owner. - # The visibility of the job. + # Deprecated. The job is only visible to the owner. The visibility of the job. # Defaults to Visibility.ACCOUNT_ONLY if not specified. # Corresponds to the JSON property `visibility` # @return [String] @@ -1389,8 +1294,7 @@ module Google end end - # Output only. - # Derived details about the job posting. + # Output only. Derived details about the job posting. class JobDerivedInfo include Google::Apis::Core::Hashable @@ -1399,9 +1303,8 @@ module Google # @return [Array] attr_accessor :job_categories - # Structured locations of the job, resolved from Job.addresses. - # locations are exactly matched to Job.addresses in the same - # order. + # Structured locations of the job, resolved from Job.addresses. locations are + # exactly matched to Job.addresses in the same order. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations @@ -1422,11 +1325,10 @@ module Google class JobEvent include Google::Apis::Core::Hashable - # Required. The job name(s) associated with this event. - # For example, if this is an impression event, - # this field contains the identifiers of all jobs shown to the job seeker. - # If this was a view event, this field contains the - # identifier of the viewed job. + # Required. The job name(s) associated with this event. For example, if this is + # an impression event, this field contains the identifiers of all jobs shown to + # the job seeker. If this was a view event, this field contains the identifier + # of the viewed job. # Corresponds to the JSON property `jobs` # @return [Array] attr_accessor :jobs @@ -1447,117 +1349,97 @@ module Google end end - # Input only. - # The query required to perform a search query. + # Input only. The query required to perform a search query. class JobQuery include Google::Apis::Core::Hashable - # Input only. - # Parameters needed for commute search. + # Input only. Parameters needed for commute search. # Corresponds to the JSON property `commuteFilter` # @return [Google::Apis::JobsV3::CommuteFilter] attr_accessor :commute_filter - # Optional. This filter specifies the exact company display - # name of the jobs to search against. - # If a value isn't specified, jobs within the search results are - # associated with any company. - # If multiple values are specified, jobs within the search results may be - # associated with any of the specified companies. - # At most 20 company display name filters are allowed. + # Optional. This filter specifies the exact company display name of the jobs to + # search against. If a value isn't specified, jobs within the search results are + # associated with any company. If multiple values are specified, jobs within the + # search results may be associated with any of the specified companies. At most + # 20 company display name filters are allowed. # Corresponds to the JSON property `companyDisplayNames` # @return [Array] attr_accessor :company_display_names - # Optional. This filter specifies the company entities to search against. - # If a value isn't specified, jobs are searched for against all - # companies. - # If multiple values are specified, jobs are searched against the - # companies specified. - # The format is "projects/`project_id`/companies/`company_id`", for example, - # "projects/api-test-project/companies/foo". - # At most 20 company filters are allowed. + # Optional. This filter specifies the company entities to search against. If a + # value isn't specified, jobs are searched for against all companies. If + # multiple values are specified, jobs are searched against the companies + # specified. The format is "projects/`project_id`/companies/`company_id`", for + # example, "projects/api-test-project/companies/foo". At most 20 company filters + # are allowed. # Corresponds to the JSON property `companyNames` # @return [Array] attr_accessor :company_names - # Input only. - # Filter on job compensation type and amount. + # Input only. Filter on job compensation type and amount. # Corresponds to the JSON property `compensationFilter` # @return [Google::Apis::JobsV3::CompensationFilter] attr_accessor :compensation_filter - # Optional. This filter specifies a structured syntax to match against the - # Job.custom_attributes marked as `filterable`. - # The syntax for this expression is a subset of SQL syntax. - # Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the - # left of the operator is a custom field key and the right of the operator - # is a number or a quoted string. You must escape backslash (\\) and - # quote (\") characters. - # Supported functions are `LOWER([field_name])` to + # Optional. This filter specifies a structured syntax to match against the Job. + # custom_attributes marked as `filterable`. The syntax for this expression is a + # subset of SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and ` + # >=` where the left of the operator is a custom field key and the right of the + # operator is a number or a quoted string. You must escape backslash (\\) and + # quote (\") characters. Supported functions are `LOWER([field_name])` to # perform a case insensitive match and `EMPTY([field_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. - # Sample Query: - # `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND - # driving_years > 10` + # 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. Sample Query: `(LOWER(driving_license)="class \ + # "a\"" OR EMPTY(driving_license)) AND driving_years > 10` # Corresponds to the JSON property `customAttributeFilter` # @return [String] attr_accessor :custom_attribute_filter - # Optional. This flag controls the spell-check feature. If false, the - # service attempts to correct a misspelled query, - # for example, "enginee" is corrected to "engineer". - # Defaults to false: a spell check is performed. + # Optional. This flag controls the spell-check feature. If false, the service + # attempts to correct a misspelled query, for example, "enginee" is corrected to + # "engineer". Defaults to false: a spell check is performed. # Corresponds to the JSON property `disableSpellCheck` # @return [Boolean] attr_accessor :disable_spell_check alias_method :disable_spell_check?, :disable_spell_check # Optional. The employment type filter specifies the employment type of jobs to - # search against, such as EmploymentType.FULL_TIME. - # If a value is not specified, jobs in the search results includes any - # employment type. - # If multiple values are specified, jobs in the search results include - # any of the specified employment types. + # search against, such as EmploymentType.FULL_TIME. If a value is not specified, + # jobs in the search results includes any employment type. If multiple values + # are specified, jobs in the search results include any of the specified + # employment types. # Corresponds to the JSON property `employmentTypes` # @return [Array] attr_accessor :employment_types # Optional. The category filter specifies the categories of jobs to search - # against. - # See Category for more information. - # If a value is not specified, jobs from any category are searched against. - # If multiple values are specified, jobs from any of the specified - # categories are searched against. + # against. See Category for more information. If a value is not specified, jobs + # from any category are searched against. If multiple values are specified, jobs + # from any of the specified categories are searched against. # Corresponds to the JSON property `jobCategories` # @return [Array] attr_accessor :job_categories - # Optional. This filter specifies the locale of jobs to search against, - # for example, "en-US". - # If a value isn't specified, the search results can contain jobs in any - # locale. - # Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". - # For more information, see - # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). - # At most 10 language code filters are allowed. + # Optional. This filter specifies the locale of jobs to search against, for + # example, "en-US". If a value isn't specified, the search results can contain + # jobs in any locale. Language codes should be in BCP-47 format, such as "en-US" + # or "sr-Latn". For more information, see [Tags for Identifying Languages](https: + # //tools.ietf.org/html/bcp47). At most 10 language code filters are allowed. # Corresponds to the JSON property `languageCodes` # @return [Array] attr_accessor :language_codes # Optional. The location filter specifies geo-regions containing the jobs to - # search against. See LocationFilter for more information. - # If a location value isn't specified, jobs fitting the other search - # criteria are retrieved regardless of where they're located. - # If multiple values are specified, jobs are retrieved from any of the - # specified locations. If different values are specified for the - # LocationFilter.distance_in_miles parameter, the maximum provided - # distance is used for all locations. - # At most 5 location filters are allowed. + # search against. See LocationFilter for more information. If a location value + # isn't specified, jobs fitting the other search criteria are retrieved + # regardless of where they're located. If multiple values are specified, jobs + # are retrieved from any of the specified locations. If different values are + # specified for the LocationFilter.distance_in_miles parameter, the maximum + # provided distance is used for all locations. At most 5 location filters are + # allowed. # Corresponds to the JSON property `locationFilters` # @return [Array] attr_accessor :location_filters @@ -1568,20 +1450,16 @@ module Google attr_accessor :publish_time_range # Optional. The query string that matches against the job title, description, - # and - # location fields. - # The maximum number of allowed characters is 255. + # and location fields. The maximum number of allowed characters is 255. # Corresponds to the JSON property `query` # @return [String] attr_accessor :query - # The language code of query. For example, "en-US". This field helps to - # better interpret the query. - # If a value isn't specified, the query language code is automatically - # detected, which may not be accurate. - # Language code should be in BCP-47 format, such as "en-US" or "sr-Latn". - # For more information, see - # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). + # The language code of query. For example, "en-US". This field helps to better + # interpret the query. If a value isn't specified, the query language code is + # automatically detected, which may not be accurate. Language code should be in + # BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags + # for Identifying Languages](https://tools.ietf.org/html/bcp47). # Corresponds to the JSON property `queryLanguageCode` # @return [String] attr_accessor :query_language_code @@ -1610,9 +1488,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. class LatLng include Google::Apis::Core::Hashable @@ -1637,8 +1514,7 @@ module Google end end - # Output only. - # The List companies response object. + # Output only. The List companies response object. class ListCompaniesResponse include Google::Apis::Core::Hashable @@ -1647,8 +1523,8 @@ module Google # @return [Array] attr_accessor :companies - # Output only. - # Additional information returned to client, such as debugging information. + # Output only. Additional information returned to client, such as debugging + # information. # Corresponds to the JSON property `metadata` # @return [Google::Apis::JobsV3::ResponseMetadata] attr_accessor :metadata @@ -1670,20 +1546,18 @@ module Google end end - # Output only. - # List jobs response. + # Output only. List jobs response. class ListJobsResponse include Google::Apis::Core::Hashable - # The Jobs for a given company. - # The maximum number of items returned is based on the limit field - # provided in the request. + # The Jobs for a given company. The maximum number of items returned is based on + # the limit field provided in the request. # Corresponds to the JSON property `jobs` # @return [Array] attr_accessor :jobs - # Output only. - # Additional information returned to client, such as debugging information. + # Output only. Additional information returned to client, such as debugging + # information. # Corresponds to the JSON property `metadata` # @return [Google::Apis::JobsV3::ResponseMetadata] attr_accessor :metadata @@ -1705,16 +1579,15 @@ module Google end end - # Output only. - # A resource that represents a location with full geographic information. + # Output only. A resource that represents a location with full geographic + # information. class Location include Google::Apis::Core::Hashable # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::JobsV3::LatLng] attr_accessor :lat_lng @@ -1729,27 +1602,22 @@ module Google # Represents a postal address, e.g. for postal delivery or payments addresses. # Given a postal address, a postal service can deliver items to a premise, P.O. - # Box or similar. - # It is not intended to model geographical locations (roads, towns, - # mountains). - # In typical usage an address would be created via user input or from importing - # existing data, depending on the type of process. - # Advice on address input / editing: - # - Use an i18n-ready address widget such as - # https://github.com/google/libaddressinput) - # - Users should not be presented with UI elements for input or editing of - # fields outside countries where that field is used. - # For more guidance on how to use this schema, please see: - # https://support.google.com/business/answer/6397478 + # Box or similar. It is not intended to model geographical locations (roads, + # towns, mountains). In typical usage an address would be created via user input + # or from importing existing data, depending on the type of process. Advice on + # address input / editing: - Use an i18n-ready address widget such as https:// + # github.com/google/libaddressinput) - Users should not be presented with UI + # elements for input or editing of fields outside countries where that field is + # used. For more guidance on how to use this schema, please see: https://support. + # google.com/business/answer/6397478 # Corresponds to the JSON property `postalAddress` # @return [Google::Apis::JobsV3::PostalAddress] attr_accessor :postal_address - # Radius in miles of the job location. This value is derived from the - # location bounding box in which a circle with the specified radius - # centered from LatLng covers the area associated with the job location. - # For example, currently, "Mountain View, CA, USA" has a radius of - # 6.17 miles. + # Radius in miles of the job location. This value is derived from the location + # bounding box in which a circle with the specified radius centered from LatLng + # covers the area associated with the job location. For example, currently, " + # Mountain View, CA, USA" has a radius of 6.17 miles. # Corresponds to the JSON property `radiusInMiles` # @return [Float] attr_accessor :radius_in_miles @@ -1767,8 +1635,7 @@ module Google end end - # Input only. - # Geographic region of the search. + # Input only. Geographic region of the search. class LocationFilter include Google::Apis::Core::Hashable @@ -1778,49 +1645,43 @@ module Google attr_accessor :address # Optional. The distance_in_miles is applied when the location being searched - # for is - # identified as a city or smaller. When the location being searched for is a - # state or larger, this field is ignored. + # for is identified as a city or smaller. When the location being searched for + # is a state or larger, this field is ignored. # Corresponds to the JSON property `distanceInMiles` # @return [Float] attr_accessor :distance_in_miles # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::JobsV3::LatLng] attr_accessor :lat_lng # Optional. CLDR region code of the country/region of the address. This is used # to address ambiguity of the user-input location, for example, "Liverpool" - # against "Liverpool, NY, US" or "Liverpool, UK". - # Set this field if all the jobs to search against are from a same region, - # or jobs are world-wide, but the job seeker is from a specific region. - # See http://cldr.unicode.org/ and - # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - # for details. Example: "CH" for Switzerland. + # against "Liverpool, NY, US" or "Liverpool, UK". Set this field if all the jobs + # to search against are from a same region, or jobs are world-wide, but the job + # seeker is from a specific region. See http://cldr.unicode.org/ and http://www. + # unicode.org/cldr/charts/30/supplemental/territory_information.html for details. + # Example: "CH" for Switzerland. # Corresponds to the JSON property `regionCode` # @return [String] attr_accessor :region_code - # Optional. Allows the client to return jobs without a - # set location, specifically, telecommuting jobs (telecommuting is considered - # by the service as a special location. - # Job.posting_region indicates if a job permits telecommuting. - # If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, - # telecommuting jobs are searched, and address and lat_lng are - # ignored. If not set or set to - # TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not - # searched. - # This filter can be used by itself to search exclusively for telecommuting - # jobs, or it can be combined with another location - # filter to search for a combination of job locations, - # such as "Mountain View" or "telecommuting" jobs. However, when used in - # combination with other location filters, telecommuting jobs can be - # treated as less relevant than other jobs in the search response. + # Optional. Allows the client to return jobs without a set location, + # specifically, telecommuting jobs (telecommuting is considered by the service + # as a special location. Job.posting_region indicates if a job permits + # telecommuting. If this field is set to TelecommutePreference. + # TELECOMMUTE_ALLOWED, telecommuting jobs are searched, and address and lat_lng + # are ignored. If not set or set to TelecommutePreference.TELECOMMUTE_EXCLUDED, + # telecommute job are not searched. This filter can be used by itself to search + # exclusively for telecommuting jobs, or it can be combined with another + # location filter to search for a combination of job locations, such as " + # Mountain View" or "telecommuting" jobs. However, when used in combination with + # other location filters, telecommuting jobs can be treated as less relevant + # than other jobs in the search response. # Corresponds to the JSON property `telecommutePreference` # @return [String] attr_accessor :telecommute_preference @@ -1839,20 +1700,18 @@ module Google end end - # Output only. - # Job entry with metadata inside SearchJobsResponse. + # Output only. Job entry with metadata inside SearchJobsResponse. class MatchingJob include Google::Apis::Core::Hashable - # Output only. - # Commute details related to this job. + # Output only. Commute details related to this job. # Corresponds to the JSON property `commuteInfo` # @return [Google::Apis::JobsV3::CommuteInfo] attr_accessor :commute_info # A Job resource represents a job posting (also referred to as a "job listing" - # or "job requisition"). A job belongs to a Company, which is the hiring - # entity responsible for the job. + # or "job requisition"). A job belongs to a Company, which is the hiring entity + # responsible for the job. # Corresponds to the JSON property `job` # @return [Google::Apis::JobsV3::Job] attr_accessor :job @@ -1863,17 +1722,17 @@ module Google # @return [String] attr_accessor :job_summary - # Contains snippets of text from the Job.job_title field most - # closely matching a search query's keywords, if available. The matching - # query keywords are enclosed in HTML bold tags. + # Contains snippets of text from the Job.job_title field most closely matching a + # search query's keywords, if available. The matching query keywords are + # enclosed in HTML bold tags. # Corresponds to the JSON property `jobTitleSnippet` # @return [String] attr_accessor :job_title_snippet - # Contains snippets of text from the Job.description and similar - # fields that most closely match a search query's keywords, if available. - # All HTML tags in the original fields are stripped when returned in this - # field, and matching query keywords are enclosed in HTML bold tags. + # Contains snippets of text from the Job.description and similar fields that + # most closely match a search query's keywords, if available. All HTML tags in + # the original fields are stripped when returned in this field, and matching + # query keywords are enclosed in HTML bold tags. # Corresponds to the JSON property `searchTextSnippet` # @return [String] attr_accessor :search_text_snippet @@ -1892,20 +1751,18 @@ module Google end end - # Message representing input to a Mendel server for debug forcing. - # See go/mendel-debug-forcing for more details. - # Next ID: 2 + # Message representing input to a Mendel server for debug forcing. See go/mendel- + # debug-forcing for more details. Next ID: 2 class MendelDebugInput include Google::Apis::Core::Hashable - # When a request spans multiple servers, a MendelDebugInput may travel with - # the request and take effect in all the servers. This field is a map of - # namespaces to NamespacedMendelDebugInput protos. In a single server, up to - # two NamespacedMendelDebugInput protos are applied: - # 1. NamespacedMendelDebugInput with the global namespace (key == ""). - # 2. NamespacedMendelDebugInput with the server's namespace. - # When both NamespacedMendelDebugInput protos are present, they are merged. - # See go/mendel-debug-forcing for more details. + # When a request spans multiple servers, a MendelDebugInput may travel with the + # request and take effect in all the servers. This field is a map of namespaces + # to NamespacedMendelDebugInput protos. In a single server, up to two + # NamespacedMendelDebugInput protos are applied: 1. NamespacedMendelDebugInput + # with the global namespace (key == ""). 2. NamespacedMendelDebugInput with the + # server's namespace. When both NamespacedMendelDebugInput protos are present, + # they are merged. See go/mendel-debug-forcing for more details. # Corresponds to the JSON property `namespacedDebugInput` # @return [Hash] attr_accessor :namespaced_debug_input @@ -1929,18 +1786,17 @@ module Google # @return [String] attr_accessor :currency_code - # Number of nano (10^-9) units of the amount. - # The value must be between -999,999,999 and +999,999,999 inclusive. - # If `units` is positive, `nanos` must be positive or zero. - # If `units` is zero, `nanos` can be positive, zero, or negative. - # If `units` is negative, `nanos` must be negative or zero. - # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + # Number of nano (10^-9) units of the amount. The value must be between -999,999, + # 999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be + # positive or zero. If `units` is zero, `nanos` can be positive, zero, or + # negative. If `units` is negative, `nanos` must be negative or zero. For + # example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. # Corresponds to the JSON property `nanos` # @return [Fixnum] attr_accessor :nanos - # The whole units of the amount. - # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + # The whole units of the amount. For example if `currencyCode` is `"USD"`, then + # 1 unit is one US dollar. # Corresponds to the JSON property `units` # @return [Fixnum] attr_accessor :units @@ -1961,89 +1817,85 @@ module Google class NamespacedDebugInput include Google::Apis::Core::Hashable - # Set of experiment names to be absolutely forced. - # These experiments will be forced without evaluating the conditions. + # Set of experiment names to be absolutely forced. These experiments will be + # forced without evaluating the conditions. # Corresponds to the JSON property `absolutelyForcedExpNames` # @return [Array] attr_accessor :absolutely_forced_exp_names - # Set of experiment tags to be absolutely forced. - # The experiments with these tags will be forced without evaluating the - # conditions. + # Set of experiment tags to be absolutely forced. The experiments with these + # tags will be forced without evaluating the conditions. # Corresponds to the JSON property `absolutelyForcedExpTags` # @return [Array] attr_accessor :absolutely_forced_exp_tags - # Set of experiment ids to be absolutely forced. - # These ids will be forced without evaluating the conditions. + # Set of experiment ids to be absolutely forced. These ids will be forced + # without evaluating the conditions. # Corresponds to the JSON property `absolutelyForcedExps` # @return [Array] attr_accessor :absolutely_forced_exps - # Set of experiment names to be conditionally forced. - # These experiments will be forced only if their conditions and their - # parent domain's conditions are true. + # Set of experiment names to be conditionally forced. These experiments will be + # forced only if their conditions and their parent domain's conditions are true. # Corresponds to the JSON property `conditionallyForcedExpNames` # @return [Array] attr_accessor :conditionally_forced_exp_names - # Set of experiment tags to be conditionally forced. - # The experiments with these tags will be forced only if their conditions - # and their parent domain's conditions are true. + # Set of experiment tags to be conditionally forced. The experiments with these + # tags will be forced only if their conditions and their parent domain's + # conditions are true. # Corresponds to the JSON property `conditionallyForcedExpTags` # @return [Array] attr_accessor :conditionally_forced_exp_tags - # Set of experiment ids to be conditionally forced. - # These ids will be forced only if their conditions and their parent - # domain's conditions are true. + # Set of experiment ids to be conditionally forced. These ids will be forced + # only if their conditions and their parent domain's conditions are true. # Corresponds to the JSON property `conditionallyForcedExps` # @return [Array] attr_accessor :conditionally_forced_exps - # If true, disable automatic enrollment selection (at all diversion - # points). Automatic enrollment selection means experiment selection - # process based on the experiment's automatic enrollment condition. This - # does not disable selection of forced experiments. + # If true, disable automatic enrollment selection (at all diversion points). + # Automatic enrollment selection means experiment selection process based on the + # experiment's automatic enrollment condition. This does not disable selection + # of forced experiments. # Corresponds to the JSON property `disableAutomaticEnrollmentSelection` # @return [Boolean] attr_accessor :disable_automatic_enrollment_selection alias_method :disable_automatic_enrollment_selection?, :disable_automatic_enrollment_selection - # Set of experiment names to be disabled. - # If an experiment is disabled, it is never selected nor forced. - # If an aggregate experiment is disabled, its partitions are disabled - # together. If an experiment with an enrollment is disabled, the enrollment - # is disabled together. If a name corresponds to a domain, the domain - # itself and all descendant experiments and domains are disabled together. + # Set of experiment names to be disabled. If an experiment is disabled, it is + # never selected nor forced. If an aggregate experiment is disabled, its + # partitions are disabled together. If an experiment with an enrollment is + # disabled, the enrollment is disabled together. If a name corresponds to a + # domain, the domain itself and all descendant experiments and domains are + # disabled together. # Corresponds to the JSON property `disableExpNames` # @return [Array] attr_accessor :disable_exp_names - # Set of experiment tags to be disabled. All experiments that are tagged - # with one or more of these tags are disabled. - # If an experiment is disabled, it is never selected nor forced. - # If an aggregate experiment is disabled, its partitions are disabled - # together. If an experiment with an enrollment is disabled, the enrollment - # is disabled together. + # Set of experiment tags to be disabled. All experiments that are tagged with + # one or more of these tags are disabled. If an experiment is disabled, it is + # never selected nor forced. If an aggregate experiment is disabled, its + # partitions are disabled together. If an experiment with an enrollment is + # disabled, the enrollment is disabled together. # Corresponds to the JSON property `disableExpTags` # @return [Array] attr_accessor :disable_exp_tags - # Set of experiment ids to be disabled. - # If an experiment is disabled, it is never selected nor forced. - # If an aggregate experiment is disabled, its partitions are disabled - # together. If an experiment with an enrollment is disabled, the enrollment - # is disabled together. If an ID corresponds to a domain, the domain itself - # and all descendant experiments and domains are disabled together. + # Set of experiment ids to be disabled. If an experiment is disabled, it is + # never selected nor forced. If an aggregate experiment is disabled, its + # partitions are disabled together. If an experiment with an enrollment is + # disabled, the enrollment is disabled together. If an ID corresponds to a + # domain, the domain itself and all descendant experiments and domains are + # disabled together. # Corresponds to the JSON property `disableExps` # @return [Array] attr_accessor :disable_exps - # If true, disable manual enrollment selection (at all diversion points). - # Manual enrollment selection means experiment selection process based on - # the request's manual enrollment states (a.k.a. opt-in experiments). - # This does not disable selection of forced experiments. + # If true, disable manual enrollment selection (at all diversion points). Manual + # enrollment selection means experiment selection process based on the request's + # manual enrollment states (a.k.a. opt-in experiments). This does not disable + # selection of forced experiments. # Corresponds to the JSON property `disableManualEnrollmentSelection` # @return [Boolean] attr_accessor :disable_manual_enrollment_selection @@ -2051,24 +1903,23 @@ module Google # If true, disable organic experiment selection (at all diversion points). # Organic selection means experiment selection process based on traffic - # allocation and diversion condition evaluation. - # This does not disable selection of forced experiments. - # This is useful in cases when it is not known whether experiment selection - # behavior is responsible for a error or breakage. Disabling organic - # selection may help to isolate the cause of a given problem. + # allocation and diversion condition evaluation. This does not disable selection + # of forced experiments. This is useful in cases when it is not known whether + # experiment selection behavior is responsible for a error or breakage. + # Disabling organic selection may help to isolate the cause of a given problem. # Corresponds to the JSON property `disableOrganicSelection` # @return [Boolean] attr_accessor :disable_organic_selection alias_method :disable_organic_selection?, :disable_organic_selection - # Flags to force in a particular experiment state. - # Map from flag name to flag value. + # Flags to force in a particular experiment state. Map from flag name to flag + # value. # Corresponds to the JSON property `forcedFlags` # @return [Hash] attr_accessor :forced_flags - # Rollouts to force in a particular experiment state. - # Map from rollout name to rollout value. + # Rollouts to force in a particular experiment state. Map from rollout name to + # rollout value. # Corresponds to the JSON property `forcedRollouts` # @return [Hash] attr_accessor :forced_rollouts @@ -2096,21 +1947,21 @@ module Google end end - # Input only. - # Use this field to specify bucketing option for the histogram search response. + # Input only. Use this field to specify bucketing option for the histogram + # search response. class NumericBucketingOption include Google::Apis::Core::Hashable # Required. Two adjacent values form a histogram bucket. Values should be in # ascending order. For example, if [5, 10, 15] are provided, four buckets are - # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 - # [buckets_bound is supported. + # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 [buckets_bound is + # supported. # Corresponds to the JSON property `bucketBounds` # @return [Array] attr_accessor :bucket_bounds - # Optional. If set to true, the histogram result includes minimum/maximum - # value of the numeric field. + # Optional. If set to true, the histogram result includes minimum/maximum value + # of the numeric field. # Corresponds to the JSON property `requiresMinMax` # @return [Boolean] attr_accessor :requires_min_max @@ -2127,25 +1978,24 @@ module Google end end - # Output only. - # Custom numeric bucketing result. + # Output only. Custom numeric bucketing result. class NumericBucketingResult include Google::Apis::Core::Hashable - # Count within each bucket. Its size is the length of - # NumericBucketingOption.bucket_bounds plus 1. + # Count within each bucket. Its size is the length of NumericBucketingOption. + # bucket_bounds plus 1. # Corresponds to the JSON property `counts` # @return [Array] attr_accessor :counts - # Stores the maximum value of the numeric field. Is populated only if - # [NumericBucketingOption.requires_min_max] is set to true. + # Stores the maximum value of the numeric field. Is populated only if [ + # NumericBucketingOption.requires_min_max] is set to true. # Corresponds to the JSON property `maxValue` # @return [Float] attr_accessor :max_value - # Stores the minimum value of the numeric field. Will be populated only if - # [NumericBucketingOption.requires_min_max] is set to true. + # Stores the minimum value of the numeric field. Will be populated only if [ + # NumericBucketingOption.requires_min_max] is set to true. # Corresponds to the JSON property `minValue` # @return [Float] attr_accessor :min_value @@ -2164,73 +2014,63 @@ module Google # Represents a postal address, e.g. for postal delivery or payments addresses. # Given a postal address, a postal service can deliver items to a premise, P.O. - # Box or similar. - # It is not intended to model geographical locations (roads, towns, - # mountains). - # In typical usage an address would be created via user input or from importing - # existing data, depending on the type of process. - # Advice on address input / editing: - # - Use an i18n-ready address widget such as - # https://github.com/google/libaddressinput) - # - Users should not be presented with UI elements for input or editing of - # fields outside countries where that field is used. - # For more guidance on how to use this schema, please see: - # https://support.google.com/business/answer/6397478 + # Box or similar. It is not intended to model geographical locations (roads, + # towns, mountains). In typical usage an address would be created via user input + # or from importing existing data, depending on the type of process. Advice on + # address input / editing: - Use an i18n-ready address widget such as https:// + # github.com/google/libaddressinput) - Users should not be presented with UI + # elements for input or editing of fields outside countries where that field is + # used. For more guidance on how to use this schema, please see: https://support. + # google.com/business/answer/6397478 class PostalAddress include Google::Apis::Core::Hashable - # Unstructured address lines describing the lower levels of an address. - # Because values in address_lines do not have type information and may - # sometimes contain multiple values in a single field (e.g. - # "Austin, TX"), it is important that the line order is clear. The order of - # address lines should be "envelope order" for the country/region of the - # address. In places where this can vary (e.g. Japan), address_language is - # used to make it explicit (e.g. "ja" for large-to-small ordering and - # "ja-Latn" or "en" for small-to-large). This way, the most specific line of - # an address can be selected based on the language. - # The minimum permitted structural representation of an address consists - # of a region_code with all remaining information placed in the - # address_lines. It would be possible to format such an address very - # approximately without geocoding, but no semantic reasoning could be - # made about any of the address components until it was at least - # partially resolved. - # Creating an address only containing a region_code and address_lines, and - # then geocoding is the recommended way to handle completely unstructured - # addresses (as opposed to guessing which parts of the address should be - # localities or administrative areas). + # Unstructured address lines describing the lower levels of an address. Because + # values in address_lines do not have type information and may sometimes contain + # multiple values in a single field (e.g. "Austin, TX"), it is important that + # the line order is clear. The order of address lines should be "envelope order" + # for the country/region of the address. In places where this can vary (e.g. + # Japan), address_language is used to make it explicit (e.g. "ja" for large-to- + # small ordering and "ja-Latn" or "en" for small-to-large). This way, the most + # specific line of an address can be selected based on the language. The minimum + # permitted structural representation of an address consists of a region_code + # with all remaining information placed in the address_lines. It would be + # possible to format such an address very approximately without geocoding, but + # no semantic reasoning could be made about any of the address components until + # it was at least partially resolved. Creating an address only containing a + # region_code and address_lines, and then geocoding is the recommended way to + # handle completely unstructured addresses (as opposed to guessing which parts + # of the address should be localities or administrative areas). # Corresponds to the JSON property `addressLines` # @return [Array] attr_accessor :address_lines # Optional. Highest administrative subdivision which is used for postal - # addresses of a country or region. - # For example, this can be a state, a province, an oblast, or a prefecture. - # Specifically, for Spain this is the province and not the autonomous - # community (e.g. "Barcelona" and not "Catalonia"). - # Many countries don't use an administrative area in postal addresses. E.g. - # in Switzerland this should be left unpopulated. + # addresses of a country or region. For example, this can be a state, a province, + # an oblast, or a prefecture. Specifically, for Spain this is the province and + # not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many + # countries don't use an administrative area in postal addresses. E.g. in + # Switzerland this should be left unpopulated. # Corresponds to the JSON property `administrativeArea` # @return [String] attr_accessor :administrative_area - # Optional. BCP-47 language code of the contents of this address (if - # known). This is often the UI language of the input form or is expected - # to match one of the languages used in the address' country/region, or their - # transliterated equivalents. - # This can affect formatting in certain countries, but is not critical - # to the correctness of the data and will never affect any validation or - # other non-formatting related operations. - # If this value is not known, it should be omitted (rather than specifying a - # possibly incorrect default). + # Optional. BCP-47 language code of the contents of this address (if known). + # This is often the UI language of the input form or is expected to match one of + # the languages used in the address' country/region, or their transliterated + # equivalents. This can affect formatting in certain countries, but is not + # critical to the correctness of the data and will never affect any validation + # or other non-formatting related operations. If this value is not known, it + # should be omitted (rather than specifying a possibly incorrect default). # Examples: "zh-Hant", "ja", "ja-Latn", "en". # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code - # Optional. Generally refers to the city/town portion of the address. - # Examples: US city, IT comune, UK post town. - # In regions of the world where localities are not well defined or do not fit - # into this structure well, leave locality empty and use address_lines. + # Optional. Generally refers to the city/town portion of the address. Examples: + # US city, IT comune, UK post town. In regions of the world where localities are + # not well defined or do not fit into this structure well, leave locality empty + # and use address_lines. # Corresponds to the JSON property `locality` # @return [String] attr_accessor :locality @@ -2240,48 +2080,47 @@ module Google # @return [String] attr_accessor :organization - # Optional. Postal code of the address. Not all countries use or require - # postal codes to be present, but where they are used, they may trigger - # additional validation with other parts of the address (e.g. state/zip - # validation in the U.S.A.). + # Optional. Postal code of the address. Not all countries use or require postal + # codes to be present, but where they are used, they may trigger additional + # validation with other parts of the address (e.g. state/zip validation in the U. + # S.A.). # Corresponds to the JSON property `postalCode` # @return [String] attr_accessor :postal_code - # Optional. The recipient at the address. - # This field may, under certain circumstances, contain multiline information. - # For example, it might contain "care of" information. + # Optional. The recipient at the address. This field may, under certain + # circumstances, contain multiline information. For example, it might contain " + # care of" information. # Corresponds to the JSON property `recipients` # @return [Array] attr_accessor :recipients - # Required. CLDR region code of the country/region of the address. This - # is never inferred and it is up to the user to ensure the value is - # correct. See http://cldr.unicode.org/ and - # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - # for details. Example: "CH" for Switzerland. + # Required. CLDR region code of the country/region of the address. This is never + # inferred and it is up to the user to ensure the value is correct. See http:// + # cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/ + # territory_information.html for details. Example: "CH" for Switzerland. # Corresponds to the JSON property `regionCode` # @return [String] attr_accessor :region_code # The schema revision of the `PostalAddress`. This must be set to 0, which is - # the latest revision. - # All new revisions **must** be backward compatible with old revisions. + # the latest revision. All new revisions **must** be backward compatible with + # old revisions. # Corresponds to the JSON property `revision` # @return [Fixnum] attr_accessor :revision - # Optional. Additional, country-specific, sorting code. This is not used - # in most regions. Where it is used, the value is either a string like - # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number - # alone, representing the "sector code" (Jamaica), "delivery area indicator" - # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). + # Optional. Additional, country-specific, sorting code. This is not used in most + # regions. Where it is used, the value is either a string like "CEDEX", + # optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, + # representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) + # or "post office indicator" (e.g. Côte d'Ivoire). # Corresponds to the JSON property `sortingCode` # @return [String] attr_accessor :sorting_code - # Optional. Sublocality of the address. - # For example, this can be neighborhoods, boroughs, districts. + # Optional. Sublocality of the address. For example, this can be neighborhoods, + # boroughs, districts. # Corresponds to the JSON property `sublocality` # @return [String] attr_accessor :sublocality @@ -2306,27 +2145,21 @@ module Google end end - # Input only. - # Options for job processing. + # Input only. Options for job processing. class ProcessingOptions include Google::Apis::Core::Hashable - # Optional. If set to `true`, the service does not attempt to resolve a - # more precise address for the job. + # Optional. If set to `true`, the service does not attempt to resolve a more + # precise address for the job. # Corresponds to the JSON property `disableStreetAddressResolution` # @return [Boolean] attr_accessor :disable_street_address_resolution alias_method :disable_street_address_resolution?, :disable_street_address_resolution - # Optional. Option for job HTML content sanitization. Applied fields are: - # * description - # * applicationInfo.instruction - # * incentives - # * qualifications - # * responsibilities - # HTML tags in these fields may be stripped if sanitiazation is not - # disabled. - # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. + # Optional. Option for job HTML content sanitization. Applied fields are: * + # description * applicationInfo.instruction * incentives * qualifications * + # responsibilities HTML tags in these fields may be stripped if sanitiazation is + # not disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. # Corresponds to the JSON property `htmlSanitization` # @return [String] attr_accessor :html_sanitization @@ -2342,58 +2175,50 @@ module Google end end - # Input only. - # Meta information related to the job searcher or entity - # conducting the job search. This information is used to improve the - # performance of the service. + # Input only. Meta information related to the job searcher or entity conducting + # the job search. This information is used to improve the performance of the + # service. class RequestMetadata include Google::Apis::Core::Hashable - # Device information collected from the job seeker, candidate, or - # other entity conducting the job search. Providing this information improves - # the quality of the search results across devices. + # Device information collected from the job seeker, candidate, or other entity + # conducting the job search. Providing this information improves the quality of + # the search results across devices. # Corresponds to the JSON property `deviceInfo` # @return [Google::Apis::JobsV3::DeviceInfo] attr_accessor :device_info # Required. The client-defined scope or source of the service call, which - # typically - # is the domain on - # which the service has been implemented and is currently being run. - # For example, if the service is being run by client Foo, Inc., on - # job board www.foo.com and career site www.bar.com, then this field is - # set to "foo.com" for use on the job board, and "bar.com" for use on the - # career site. - # If this field isn't available for some reason, send "UNKNOWN". - # Any improvements to the model for a particular tenant site rely on this - # field being set correctly to a domain. - # The maximum number of allowed characters is 255. + # typically is the domain on which the service has been implemented and is + # currently being run. For example, if the service is being run by client *Foo, + # Inc.*, on job board www.foo.com and career site www.bar.com, then this field + # is set to "foo.com" for use on the job board, and "bar.com" for use on the + # career site. If this field isn't available for some reason, send "UNKNOWN". + # Any improvements to the model for a particular tenant site rely on this field + # being set correctly to a domain. The maximum number of allowed characters is + # 255. # Corresponds to the JSON property `domain` # @return [String] attr_accessor :domain # Required. A unique session identification string. A session is defined as the - # duration of an end user's interaction with the service over a certain - # period. - # Obfuscate this field for privacy concerns before - # providing it to the service. - # If this field is not available for some reason, send "UNKNOWN". Note - # that any improvements to the model for a particular tenant - # site, rely on this field being set correctly to some unique session_id. - # The maximum number of allowed characters is 255. + # duration of an end user's interaction with the service over a certain period. + # Obfuscate this field for privacy concerns before providing it to the service. + # If this field is not available for some reason, send "UNKNOWN". Note that any + # improvements to the model for a particular tenant site, rely on this field + # being set correctly to some unique session_id. The maximum number of allowed + # characters is 255. # Corresponds to the JSON property `sessionId` # @return [String] attr_accessor :session_id - # Required. A unique user identification string, as determined by the client. - # To have the strongest positive impact on search quality - # make sure the client-level is unique. - # Obfuscate this field for privacy concerns before - # providing it to the service. - # If this field is not available for some reason, send "UNKNOWN". Note - # that any improvements to the model for a particular tenant - # site, rely on this field being set correctly to a unique user_id. - # The maximum number of allowed characters is 255. + # Required. A unique user identification string, as determined by the client. To + # have the strongest positive impact on search quality make sure the client- + # level is unique. Obfuscate this field for privacy concerns before providing it + # to the service. If this field is not available for some reason, send "UNKNOWN". + # Note that any improvements to the model for a particular tenant site, rely on + # this field being set correctly to a unique user_id. The maximum number of + # allowed characters is 255. # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id @@ -2411,13 +2236,12 @@ module Google end end - # Output only. - # Additional information returned to client, such as debugging information. + # Output only. Additional information returned to client, such as debugging + # information. class ResponseMetadata include Google::Apis::Core::Hashable - # A unique id associated with this call. - # This id is logged for tracking purposes. + # A unique id associated with this call. This id is logged for tracking purposes. # Corresponds to the JSON property `requestId` # @return [String] attr_accessor :request_id @@ -2432,114 +2256,91 @@ module Google end end - # Input only. - # The Request body of the `SearchJobs` call. + # Input only. The Request body of the `SearchJobs` call. class SearchJobsRequest include Google::Apis::Core::Hashable # Optional. Controls whether to disable exact keyword match on Job.job_title, - # Job.description, Job.company_display_name, Job.locations, - # Job.qualifications. When disable keyword match is turned off, a - # keyword match returns jobs that do not match given category filters when - # there are matching keywords. For example, the query "program manager," a - # result is returned even if the job posting has the title "software - # developer," which does not fall into "program manager" ontology, but does - # have "program manager" appearing in its description. - # For queries like "cloud" that does not contain title or - # location specific ontology, jobs with "cloud" keyword matches are returned - # regardless of this flag's value. - # Please use Company.keyword_searchable_custom_fields or - # Company.keyword_searchable_custom_attributes if company specific - # globally matched custom field/attribute string values is needed. Enabling - # keyword match improves recall of subsequent search requests. - # Defaults to false. + # Job.description, Job.company_display_name, Job.locations, Job.qualifications. + # When disable keyword match is turned off, a keyword match returns jobs that do + # not match given category filters when there are matching keywords. For example, + # the query "program manager," a result is returned even if the job posting has + # the title "software developer," which does not fall into "program manager" + # ontology, but does have "program manager" appearing in its description. For + # queries like "cloud" that does not contain title or location specific ontology, + # jobs with "cloud" keyword matches are returned regardless of this flag's + # value. Please use Company.keyword_searchable_custom_fields or Company. + # keyword_searchable_custom_attributes if company specific globally matched + # custom field/attribute string values is needed. Enabling keyword match + # improves recall of subsequent search requests. Defaults to false. # Corresponds to the JSON property `disableKeywordMatch` # @return [Boolean] attr_accessor :disable_keyword_match alias_method :disable_keyword_match?, :disable_keyword_match # Optional. Controls whether highly similar jobs are returned next to each other - # in - # the search results. Jobs are identified as highly similar based on - # their titles, job categories, and locations. Highly similar results are - # clustered so that only one representative job of the cluster is - # displayed to the job seeker higher up in the results, with the other jobs - # being displayed lower down in the results. - # Defaults to DiversificationLevel.SIMPLE if no value - # is specified. + # in the search results. Jobs are identified as highly similar based on their + # titles, job categories, and locations. Highly similar results are clustered so + # that only one representative job of the cluster is displayed to the job seeker + # higher up in the results, with the other jobs being displayed lower down in + # the results. Defaults to DiversificationLevel.SIMPLE if no value is specified. # Corresponds to the JSON property `diversificationLevel` # @return [String] attr_accessor :diversification_level # Optional. Controls whether to broaden the search when it produces sparse - # results. - # Broadened queries append results to the end of the matching results - # list. - # Defaults to false. + # results. Broadened queries append results to the end of the matching results + # list. Defaults to false. # Corresponds to the JSON property `enableBroadening` # @return [Boolean] attr_accessor :enable_broadening alias_method :enable_broadening?, :enable_broadening - # Input only. - # Histogram facets to be specified in SearchJobsRequest. + # Input only. Histogram facets to be specified in SearchJobsRequest. # Corresponds to the JSON property `histogramFacets` # @return [Google::Apis::JobsV3::HistogramFacets] attr_accessor :histogram_facets - # Input only. - # The query required to perform a search query. + # Input only. The query required to perform a search query. # Corresponds to the JSON property `jobQuery` # @return [Google::Apis::JobsV3::JobQuery] attr_accessor :job_query - # Optional. The desired job attributes returned for jobs in the - # search response. Defaults to JobView.SMALL if no value is specified. + # Optional. The desired job attributes returned for jobs in the search response. + # Defaults to JobView.SMALL if no value is specified. # Corresponds to the JSON property `jobView` # @return [String] attr_accessor :job_view # Optional. An integer that specifies the current offset (that is, starting - # result - # location, amongst the jobs deemed by the API as relevant) in search - # results. This field is only considered if page_token is unset. - # The maximum allowed value is 5000. Otherwise an error is thrown. - # For example, 0 means to return results starting from the first matching - # job, and 10 means to return from the 11th job. This can be used for - # pagination, (for example, pageSize = 10 and offset = 10 means to return - # from the second page). + # result location, amongst the jobs deemed by the API as relevant) in search + # results. This field is only considered if page_token is unset. The maximum + # allowed value is 5000. Otherwise an error is thrown. For example, 0 means to + # return results starting from the first matching job, and 10 means to return + # from the 11th job. This can be used for pagination, (for example, pageSize = + # 10 and offset = 10 means to return from the second page). # Corresponds to the JSON property `offset` # @return [Fixnum] attr_accessor :offset - # Optional. The criteria determining how search results are sorted. Default is - # "relevance desc". - # Supported options are: - # * `"relevance desc"`: By relevance descending, as determined by the API - # algorithms. Relevance thresholding of query results is only available - # with this ordering. - # * `"posting_publish_time desc"`: By Job.posting_publish_time - # descending. - # * `"posting_update_time desc"`: By Job.posting_update_time - # descending. - # * `"title"`: By Job.title ascending. - # * `"title desc"`: By Job.title descending. - # * `"annualized_base_compensation"`: By job's - # CompensationInfo.annualized_base_compensation_range ascending. Jobs - # whose annualized base compensation is unspecified are put at the end of - # search results. - # * `"annualized_base_compensation desc"`: By job's - # CompensationInfo.annualized_base_compensation_range descending. Jobs - # whose annualized base compensation is unspecified are put at the end of - # search results. - # * `"annualized_total_compensation"`: By job's - # CompensationInfo.annualized_total_compensation_range ascending. Jobs - # whose annualized base compensation is unspecified are put at the end of - # search results. - # * `"annualized_total_compensation desc"`: By job's - # CompensationInfo.annualized_total_compensation_range descending. Jobs - # whose annualized base compensation is unspecified are put at the end of - # search results. + # Optional. The criteria determining how search results are sorted. Default is " + # relevance desc". Supported options are: * `"relevance desc"`: By relevance + # descending, as determined by the API algorithms. Relevance thresholding of + # query results is only available with this ordering. * `"posting_publish_time + # desc"`: By Job.posting_publish_time descending. * `"posting_update_time desc"`: + # By Job.posting_update_time descending. * `"title"`: By Job.title ascending. * + # `"title desc"`: By Job.title descending. * `"annualized_base_compensation"`: + # By job's CompensationInfo.annualized_base_compensation_range ascending. Jobs + # whose annualized base compensation is unspecified are put at the end of search + # results. * `"annualized_base_compensation desc"`: By job's CompensationInfo. + # annualized_base_compensation_range descending. Jobs whose annualized base + # compensation is unspecified are put at the end of search results. * `" + # annualized_total_compensation"`: By job's CompensationInfo. + # annualized_total_compensation_range ascending. Jobs whose annualized base + # compensation is unspecified are put at the end of search results. * `" + # annualized_total_compensation desc"`: By job's CompensationInfo. + # annualized_total_compensation_range descending. Jobs whose annualized base + # compensation is unspecified are put at the end of search results. # Corresponds to the JSON property `orderBy` # @return [String] attr_accessor :order_by @@ -2551,35 +2352,27 @@ module Google # @return [Fixnum] attr_accessor :page_size - # Optional. The token specifying the current offset within - # search results. See SearchJobsResponse.next_page_token for - # an explanation of how to obtain the next set of query results. + # Optional. The token specifying the current offset within search results. See + # SearchJobsResponse.next_page_token for an explanation of how to obtain the + # next set of query results. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token - # Input only. - # Meta information related to the job searcher or entity - # conducting the job search. This information is used to improve the - # performance of the service. + # Input only. Meta information related to the job searcher or entity conducting + # the job search. This information is used to improve the performance of the + # service. # Corresponds to the JSON property `requestMetadata` # @return [Google::Apis::JobsV3::RequestMetadata] attr_accessor :request_metadata - # Optional. Controls if the search job request requires the return of a precise - # count of the first 300 results. Setting this to `true` ensures - # consistency in the number of results per page. Best practice is to set this - # value to true if a client allows users to jump directly to a - # non-sequential search results page. - # Enabling this flag may adversely impact performance. - # Defaults to false. + # This field is deprecated. # Corresponds to the JSON property `requirePreciseResultSize` # @return [Boolean] attr_accessor :require_precise_result_size alias_method :require_precise_result_size?, :require_precise_result_size - # Optional. Mode of a search. - # Defaults to SearchMode.JOB_SEARCH. + # Optional. Mode of a search. Defaults to SearchMode.JOB_SEARCH. # Corresponds to the JSON property `searchMode` # @return [String] attr_accessor :search_mode @@ -2606,39 +2399,37 @@ module Google end end - # Output only. - # Response for SearchJob method. + # Output only. Response for SearchJob method. class SearchJobsResponse include Google::Apis::Core::Hashable # If query broadening is enabled, we may append additional results from the # broadened query. This number indicates how many of the jobs returned in the - # jobs field are from the broadened query. These results are always at the - # end of the jobs list. In particular, a value of 0, or if the field isn't - # set, all the jobs in the jobs list are from the original - # (without broadening) query. If this field is non-zero, subsequent requests - # with offset after this result set should contain all broadened results. + # jobs field are from the broadened query. These results are always at the end + # of the jobs list. In particular, a value of 0, or if the field isn't set, all + # the jobs in the jobs list are from the original (without broadening) query. If + # this field is non-zero, subsequent requests with offset after this result set + # should contain all broadened results. # Corresponds to the JSON property `broadenedQueryJobsCount` # @return [Fixnum] attr_accessor :broadened_query_jobs_count - # An estimation of the number of jobs that match the specified query. - # This number is not guaranteed to be accurate. For accurate results, - # see enable_precise_result_size. + # An estimation of the number of jobs that match the specified query. This + # number is not guaranteed to be accurate. For accurate results, see + # SearchJobsResponse.total_size. # Corresponds to the JSON property `estimatedTotalSize` # @return [Fixnum] attr_accessor :estimated_total_size - # Output only. - # Histogram results that match HistogramFacets specified in + # Output only. Histogram results that match HistogramFacets specified in # SearchJobsRequest. # Corresponds to the JSON property `histogramResults` # @return [Google::Apis::JobsV3::HistogramResults] attr_accessor :histogram_results - # The location filters that the service applied to the specified query. If - # any filters are lat-lng based, the JobLocation.location_type is - # JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED. + # The location filters that the service applied to the specified query. If any + # filters are lat-lng based, the JobLocation.location_type is JobLocation. + # LocationType#LOCATION_TYPE_UNSPECIFIED. # Corresponds to the JSON property `locationFilters` # @return [Array] attr_accessor :location_filters @@ -2648,8 +2439,8 @@ module Google # @return [Array] attr_accessor :matching_jobs - # Output only. - # Additional information returned to client, such as debugging information. + # Output only. Additional information returned to client, such as debugging + # information. # Corresponds to the JSON property `metadata` # @return [Google::Apis::JobsV3::ResponseMetadata] attr_accessor :metadata @@ -2660,15 +2451,12 @@ module Google # @return [String] attr_accessor :next_page_token - # Output only. - # Spell check result. + # Output only. Spell check result. # Corresponds to the JSON property `spellCorrection` # @return [Google::Apis::JobsV3::SpellingCorrection] attr_accessor :spell_correction - # The precise result count, which is available only if the client set - # enable_precise_result_size to `true`, or if the response - # is the last page of results. Otherwise, the value is `-1`. + # The precise result count with limit 100,000. # Corresponds to the JSON property `totalSize` # @return [Fixnum] attr_accessor :total_size @@ -2691,8 +2479,7 @@ module Google end end - # Output only. - # Spell check result. + # Output only. Spell check result. class SpellingCorrection include Google::Apis::Core::Hashable @@ -2718,14 +2505,14 @@ module Google end end - # Represents a time of day. The date and time zone are either not significant - # or are specified elsewhere. An API may choose to allow leap seconds. Related + # Represents a time of day. The date and time zone are either not significant or + # are specified elsewhere. An API may choose to allow leap seconds. Related # types are google.type.Date and `google.protobuf.Timestamp`. class TimeOfDay include Google::Apis::Core::Hashable - # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose - # to allow the value "24:00:00" for scenarios like business closing time. + # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to + # allow the value "24:00:00" for scenarios like business closing time. # Corresponds to the JSON property `hours` # @return [Fixnum] attr_accessor :hours @@ -2784,8 +2571,7 @@ module Google end end - # Input only. - # Request for updating a specified company. + # Input only. Request for updating a specified company. class UpdateCompanyRequest include Google::Apis::Core::Hashable @@ -2796,12 +2582,10 @@ module Google # @return [Google::Apis::JobsV3::Company] attr_accessor :company - # Optional but strongly recommended for the best service - # experience. - # If update_mask is provided, only the specified fields in - # company are updated. Otherwise all the fields are updated. - # A field mask to specify the company fields to be updated. Only - # top level fields of Company are supported. + # Optional but strongly recommended for the best service experience. If + # update_mask is provided, only the specified fields in company are updated. + # Otherwise all the fields are updated. A field mask to specify the company + # fields to be updated. Only top level fields of Company are supported. # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask @@ -2817,24 +2601,21 @@ module Google end end - # Input only. - # Update job request. + # Input only. Update job request. class UpdateJobRequest include Google::Apis::Core::Hashable # A Job resource represents a job posting (also referred to as a "job listing" - # or "job requisition"). A job belongs to a Company, which is the hiring - # entity responsible for the job. + # or "job requisition"). A job belongs to a Company, which is the hiring entity + # responsible for the job. # Corresponds to the JSON property `job` # @return [Google::Apis::JobsV3::Job] attr_accessor :job # Optional but strongly recommended to be provided for the best service - # experience. - # If update_mask is provided, only the specified fields in - # job are updated. Otherwise all the fields are updated. - # A field mask to restrict the fields that are updated. Only - # top level fields of Job are supported. + # experience. If update_mask is provided, only the specified fields in job are + # updated. Otherwise all the fields are updated. A field mask to restrict the + # fields that are updated. Only top level fields of Job are supported. # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask diff --git a/generated/google/apis/jobs_v3/service.rb b/generated/google/apis/jobs_v3/service.rb index c995d319b..540fafb7c 100644 --- a/generated/google/apis/jobs_v3/service.rb +++ b/generated/google/apis/jobs_v3/service.rb @@ -48,52 +48,39 @@ module Google @batch_path = 'batch' end - # Completes the specified prefix with keyword suggestions. - # Intended for use by a job search auto-complete search box. + # Completes the specified prefix with keyword suggestions. Intended for use by a + # job search auto-complete search box. # @param [String] name - # Required. Resource name of project the completion is performed within. - # The format is "projects/`project_id`", for example, - # "projects/api-test-project". + # Required. Resource name of project the completion is performed within. The + # format is "projects/`project_id`", for example, "projects/api-test-project". # @param [String] company_name - # Optional. If provided, restricts completion to specified company. - # The format is "projects/`project_id`/companies/`company_id`", for example, - # "projects/api-test-project/companies/foo". + # Optional. If provided, restricts completion to specified company. The format + # is "projects/`project_id`/companies/`company_id`", for example, "projects/api- + # test-project/companies/foo". # @param [String] language_code - # Deprecated. Use language_codes instead. - # Optional. - # The language of the query. This is - # the BCP-47 language code, such as "en-US" or "sr-Latn". - # For more information, see - # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). - # For CompletionType.JOB_TITLE type, only open jobs with the same - # language_code are returned. - # For CompletionType.COMPANY_NAME type, - # only companies having open jobs with the same language_code are - # returned. - # For CompletionType.COMBINED type, only open jobs with the same - # language_code or companies having open jobs with the same - # language_code are returned. - # The maximum number of allowed characters is 255. + # Deprecated. Use language_codes instead. Optional. The language of the query. + # This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more + # information, see [Tags for Identifying Languages](https://tools.ietf.org/html/ + # bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same + # language_code are returned. For CompletionType.COMPANY_NAME type, only + # companies having open jobs with the same language_code are returned. For + # CompletionType.COMBINED type, only open jobs with the same language_code or + # companies having open jobs with the same language_code are returned. The + # maximum number of allowed characters is 255. # @param [Array, String] language_codes - # Optional. The list of languages of the query. This is - # the BCP-47 language code, such as "en-US" or "sr-Latn". - # For more information, see - # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). - # For CompletionType.JOB_TITLE type, only open jobs with the same - # language_codes are returned. - # For CompletionType.COMPANY_NAME type, - # only companies having open jobs with the same language_codes are - # returned. - # For CompletionType.COMBINED type, only open jobs with the same - # language_codes or companies having open jobs with the same - # language_codes are returned. - # The maximum number of allowed characters is 255. + # Optional. The list of languages of the query. This is the BCP-47 language code, + # such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying + # Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE + # type, only open jobs with the same language_codes are returned. For + # CompletionType.COMPANY_NAME type, only companies having open jobs with the + # same language_codes are returned. For CompletionType.COMBINED type, only open + # jobs with the same language_codes or companies having open jobs with the same + # language_codes are returned. The maximum number of allowed characters is 255. # @param [Fixnum] page_size - # Required. Completion result count. - # The maximum allowed page size is 10. + # Required. Completion result count. The maximum allowed page size is 10. # @param [String] query - # Required. The query used to generate suggestions. - # The maximum number of allowed characters is 255. + # Required. The query used to generate suggestions. The maximum number of + # allowed characters is 255. # @param [String] scope # Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC. # @param [String] type @@ -132,12 +119,10 @@ module Google execute_or_queue_command(command, &block) end - # Report events issued when end user interacts with customer's application - # that uses Cloud Talent Solution. You may inspect the created events in - # [self service - # tools](https://console.cloud.google.com/talent-solution/overview). - # [Learn - # more](https://cloud.google.com/talent-solution/docs/management-tools) + # Report events issued when end user interacts with customer's application that + # uses Cloud Talent Solution. You may inspect the created events in [self + # service tools](https://console.cloud.google.com/talent-solution/overview). [ + # Learn more](https://cloud.google.com/talent-solution/docs/management-tools) # about self service tools. # @param [String] parent # Parent project name. @@ -173,9 +158,8 @@ module Google # Creates a new company entity. # @param [String] parent - # Required. Resource name of the project under which the company is created. - # The format is "projects/`project_id`", for example, - # "projects/api-test-project". + # Required. Resource name of the project under which the company is created. The + # format is "projects/`project_id`", for example, "projects/api-test-project". # @param [Google::Apis::JobsV3::CreateCompanyRequest] create_company_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -206,12 +190,12 @@ module Google execute_or_queue_command(command, &block) end - # Deletes specified company. - # Prerequisite: The company has no jobs associated with it. + # Deletes specified company. Prerequisite: The company has no jobs associated + # with it. # @param [String] name - # Required. The resource name of the company to be deleted. - # The format is "projects/`project_id`/companies/`company_id`", for example, - # "projects/api-test-project/companies/foo". + # Required. The resource name of the company to be deleted. The format is " + # projects/`project_id`/companies/`company_id`", for example, "projects/api-test- + # project/companies/foo". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -241,9 +225,9 @@ module Google # Retrieves specified company. # @param [String] name - # Required. The resource name of the company to be retrieved. - # The format is "projects/`project_id`/companies/`company_id`", for example, - # "projects/api-test-project/companies/foo". + # Required. The resource name of the company to be retrieved. The format is " + # projects/`project_id`/companies/`company_id`", for example, "projects/api-test- + # project/companies/foo". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -273,18 +257,16 @@ module Google # Lists all companies associated with the service account. # @param [String] parent - # Required. Resource name of the project under which the company is created. - # The format is "projects/`project_id`", for example, - # "projects/api-test-project". + # Required. Resource name of the project under which the company is created. The + # format is "projects/`project_id`", for example, "projects/api-test-project". # @param [Fixnum] page_size - # Optional. The maximum number of companies to be returned, at most 100. - # Default is 100 if a non-positive number is provided. + # Optional. The maximum number of companies to be returned, at most 100. Default + # is 100 if a non-positive number is provided. # @param [String] page_token # Optional. The starting indicator from which to return results. # @param [Boolean] require_open_jobs - # Optional. Set to true if the companies requested must have open jobs. - # Defaults to false. - # If true, at most page_size of companies are fetched, among which + # Optional. Set to true if the companies requested must have open jobs. Defaults + # to false. If true, at most page_size of companies are fetched, among which # only those with open jobs are returned. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -316,15 +298,14 @@ module Google execute_or_queue_command(command, &block) end - # Updates specified company. Company names can't be updated. To update a - # company name, delete the company and all jobs associated with it, and only - # then re-create them. + # Updates specified company. Company names can't be updated. To update a company + # name, delete the company and all jobs associated with it, and only then re- + # create them. # @param [String] name - # Required during company update. - # The resource name for a company. This is generated by the service when a - # company is created. - # The format is "projects/`project_id`/companies/`company_id`", for example, - # "projects/api-test-project/companies/foo". + # Required during company update. The resource name for a company. This is + # generated by the service when a company is created. The format is "projects/` + # project_id`/companies/`company_id`", for example, "projects/api-test-project/ + # companies/foo". # @param [Google::Apis::JobsV3::UpdateCompanyRequest] update_company_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -357,9 +338,8 @@ module Google # Deletes a list of Jobs by filter. # @param [String] parent - # Required. The resource name of the project under which the job is created. - # The format is "projects/`project_id`", for example, - # "projects/api-test-project". + # Required. The resource name of the project under which the job is created. The + # format is "projects/`project_id`", for example, "projects/api-test-project". # @param [Google::Apis::JobsV3::BatchDeleteJobsRequest] batch_delete_jobs_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -390,13 +370,11 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new job. - # Typically, the job becomes searchable within 10 seconds, but it may take - # up to 5 minutes. + # Creates a new job. Typically, the job becomes searchable within 10 seconds, + # but it may take up to 5 minutes. # @param [String] parent - # Required. The resource name of the project under which the job is created. - # The format is "projects/`project_id`", for example, - # "projects/api-test-project". + # Required. The resource name of the project under which the job is created. The + # format is "projects/`project_id`", for example, "projects/api-test-project". # @param [Google::Apis::JobsV3::CreateJobRequest] create_job_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -427,13 +405,11 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified job. - # Typically, the job becomes unsearchable within 10 seconds, but it may take - # up to 5 minutes. + # Deletes the specified job. Typically, the job becomes unsearchable within 10 + # seconds, but it may take up to 5 minutes. # @param [String] name - # Required. The resource name of the job to be deleted. - # The format is "projects/`project_id`/jobs/`job_id`", - # for example, "projects/api-test-project/jobs/1234". + # Required. The resource name of the job to be deleted. The format is "projects/` + # project_id`/jobs/`job_id`", for example, "projects/api-test-project/jobs/1234". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -461,12 +437,11 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the specified job, whose status is OPEN or recently EXPIRED - # within the last 90 days. + # Retrieves the specified job, whose status is OPEN or recently EXPIRED within + # the last 90 days. # @param [String] name - # Required. The resource name of the job to retrieve. - # The format is "projects/`project_id`/jobs/`job_id`", - # for example, "projects/api-test-project/jobs/1234". + # Required. The resource name of the job to retrieve. The format is "projects/` + # project_id`/jobs/`job_id`", for example, "projects/api-test-project/jobs/1234". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -496,28 +471,22 @@ module Google # Lists jobs by filter. # @param [String] parent - # Required. The resource name of the project under which the job is created. - # The format is "projects/`project_id`", for example, - # "projects/api-test-project". + # Required. The resource name of the project under which the job is created. The + # format is "projects/`project_id`", for example, "projects/api-test-project". # @param [String] filter - # Required. The filter string specifies the jobs to be enumerated. - # Supported operator: =, AND - # The fields eligible for filtering are: - # * `companyName` (Required) - # * `requisitionId` (Optional) - # Sample Query: - # * companyName = "projects/api-test-project/companies/123" - # * companyName = "projects/api-test-project/companies/123" AND requisitionId - # = "req-1" + # Required. The filter string specifies the jobs to be enumerated. Supported + # operator: =, AND The fields eligible for filtering are: * `companyName` ( + # Required) * `requisitionId` (Optional) Sample Query: * companyName = "projects/ + # api-test-project/companies/123" * companyName = "projects/api-test-project/ + # companies/123" AND requisitionId = "req-1" # @param [String] job_view - # Optional. The desired job attributes returned for jobs in the - # search response. Defaults to JobView.JOB_VIEW_FULL if no value is - # specified. + # Optional. The desired job attributes returned for jobs in the search response. + # Defaults to JobView.JOB_VIEW_FULL if no value is specified. # @param [Fixnum] page_size - # Optional. The maximum number of jobs to be returned per page of results. - # If job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed - # page size is 1000. Otherwise, the maximum allowed page size is 100. - # Default is 100 if empty or a number < 1 is specified. + # Optional. The maximum number of jobs to be returned per page of results. If + # job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed page size is + # 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty + # or a number < 1 is specified. # @param [String] page_token # Optional. The starting point of a query result. # @param [String] fields @@ -551,16 +520,13 @@ module Google execute_or_queue_command(command, &block) end - # Updates specified job. - # Typically, updated contents become visible in search results within 10 - # seconds, but it may take up to 5 minutes. + # Updates specified job. Typically, updated contents become visible in search + # results within 10 seconds, but it may take up to 5 minutes. # @param [String] name - # Required during job update. - # The resource name for the job. This is generated by the service when a - # job is created. - # The format is "projects/`project_id`/jobs/`job_id`", - # for example, "projects/api-test-project/jobs/1234". - # Use of this field in job queries and API calls is preferred over the use of + # Required during job update. The resource name for the job. This is generated + # by the service when a job is created. The format is "projects/`project_id`/ + # jobs/`job_id`", for example, "projects/api-test-project/jobs/1234". Use of + # this field in job queries and API calls is preferred over the use of # requisition_id since this value is unique. # @param [Google::Apis::JobsV3::UpdateJobRequest] update_job_request_object # @param [String] fields @@ -592,14 +558,12 @@ module Google execute_or_queue_command(command, &block) end - # Searches for jobs using the provided SearchJobsRequest. - # This call constrains the visibility of jobs - # present in the database, and only returns jobs that the caller has - # permission to search against. + # Searches for jobs using the provided SearchJobsRequest. This call constrains + # the visibility of jobs present in the database, and only returns jobs that the + # caller has permission to search against. # @param [String] parent - # Required. The resource name of the project to search within. - # The format is "projects/`project_id`", for example, - # "projects/api-test-project". + # Required. The resource name of the project to search within. The format is " + # projects/`project_id`", for example, "projects/api-test-project". # @param [Google::Apis::JobsV3::SearchJobsRequest] search_jobs_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -630,18 +594,16 @@ module Google execute_or_queue_command(command, &block) end - # Searches for jobs using the provided SearchJobsRequest. - # This API call is intended for the use case of targeting passive job - # seekers (for example, job seekers who have signed up to receive email - # alerts about potential job opportunities), and has different algorithmic - # adjustments that are targeted to passive job seekers. - # This call constrains the visibility of jobs - # present in the database, and only returns jobs the caller has - # permission to search against. + # Searches for jobs using the provided SearchJobsRequest. This API call is + # intended for the use case of targeting passive job seekers (for example, job + # seekers who have signed up to receive email alerts about potential job + # opportunities), and has different algorithmic adjustments that are targeted to + # passive job seekers. This call constrains the visibility of jobs present in + # the database, and only returns jobs the caller has permission to search + # against. # @param [String] parent - # Required. The resource name of the project to search within. - # The format is "projects/`project_id`", for example, - # "projects/api-test-project". + # Required. The resource name of the project to search within. The format is " + # projects/`project_id`", for example, "projects/api-test-project". # @param [Google::Apis::JobsV3::SearchJobsRequest] search_jobs_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/jobs_v3p1beta1.rb b/generated/google/apis/jobs_v3p1beta1.rb index 06544e190..7ab27efaf 100644 --- a/generated/google/apis/jobs_v3p1beta1.rb +++ b/generated/google/apis/jobs_v3p1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/talent-solution/job-search/docs/ module JobsV3p1beta1 VERSION = 'V3p1beta1' - REVISION = '20200604' + REVISION = '20200828' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/jobs_v3p1beta1/classes.rb b/generated/google/apis/jobs_v3p1beta1/classes.rb index b373da87d..4cb0ad6f5 100644 --- a/generated/google/apis/jobs_v3p1beta1/classes.rb +++ b/generated/google/apis/jobs_v3p1beta1/classes.rb @@ -26,34 +26,26 @@ module Google class ApplicationInfo include Google::Apis::Core::Hashable - # Optional but at least one of uris, - # emails or instruction must be - # specified. - # Use this field to specify email address(es) to which resumes or - # applications can be sent. - # The maximum number of allowed characters for each entry is 255. + # Optional but at least one of uris, emails or instruction must be specified. + # Use this field to specify email address(es) to which resumes or applications + # can be sent. The maximum number of allowed characters for each entry is 255. # Corresponds to the JSON property `emails` # @return [Array] attr_accessor :emails - # Optional but at least one of uris, - # emails or instruction must be - # specified. - # Use this field to provide instructions, such as "Mail your application - # to ...", that a candidate can follow to apply for the job. - # This field accepts and sanitizes HTML input, and also accepts - # bold, italic, ordered list, and unordered list markup tags. - # The maximum number of allowed characters is 3,000. + # Optional but at least one of uris, emails or instruction must be specified. + # Use this field to provide instructions, such as "Mail your application to ...", + # that a candidate can follow to apply for the job. This field accepts and + # sanitizes HTML input, and also accepts bold, italic, ordered list, and + # unordered list markup tags. The maximum number of allowed characters is 3,000. # Corresponds to the JSON property `instruction` # @return [String] attr_accessor :instruction - # Optional but at least one of uris, - # emails or instruction must be - # specified. - # Use this URI field to direct an applicant to a website, for example to - # link to an online application form. - # The maximum number of allowed characters for each entry is 2,000. + # Optional but at least one of uris, emails or instruction must be specified. + # Use this URI field to direct an applicant to a website, for example to link to + # an online application form. The maximum number of allowed characters for each + # entry is 2,000. # Corresponds to the JSON property `uris` # @return [Array] attr_accessor :uris @@ -70,18 +62,14 @@ module Google end end - # Input only. - # Batch delete jobs request. + # Input only. Batch delete jobs request. class BatchDeleteJobsRequest include Google::Apis::Core::Hashable - # Required. The filter string specifies the jobs to be deleted. - # Supported operator: =, AND - # The fields eligible for filtering are: - # * `companyName` (Required) - # * `requisitionId` (Required) - # Sample Query: companyName = "projects/api-test-project/companies/123" AND - # requisitionId = "req-1" + # Required. The filter string specifies the jobs to be deleted. Supported + # operator: =, AND The fields eligible for filtering are: * `companyName` ( + # Required) * `requisitionId` (Required) Sample Query: companyName = "projects/ + # api-test-project/companies/123" AND requisitionId = "req-1" # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter @@ -148,9 +136,9 @@ module Google # An event issued when an end user interacts with the application that # implements Cloud Talent Solution. Providing this information improves the - # quality of search and recommendation for the API clients, enabling the - # service to perform optimally. The number of events sent must be consistent - # with other calls, such as job searches, issued to the service by the client. + # quality of search and recommendation for the API clients, enabling the service + # to perform optimally. The number of events sent must be consistent with other + # calls, such as job searches, issued to the service by the client. class ClientEvent include Google::Apis::Core::Hashable @@ -160,19 +148,16 @@ module Google attr_accessor :create_time # Required. A unique identifier, generated by the client application. This ` - # event_id` - # is used to establish the relationship between different events - # (see parent_event_id). + # event_id` is used to establish the relationship between different events (see + # parent_event_id). # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id # Optional. Extra information about this event. Used for storing information - # with no - # matching field in event payload, for example, user application specific - # context or details. - # At most 20 keys are supported. The maximum total size of all keys and - # values is 2 KB. + # with no matching field in event payload, for example, user application + # specific context or details. At most 20 keys are supported. The maximum total + # size of all keys and values is 2 KB. # Corresponds to the JSON property `extraInfo` # @return [Hash] attr_accessor :extra_info @@ -184,13 +169,10 @@ module Google attr_accessor :job_event # Optional. The event_id of an event that resulted in the current event. For - # example, a - # Job view event usually follows a parent - # impression event: A job seeker first does a - # search where a list of jobs appears - # (impression). The job seeker then selects a - # result and views the description of a particular job (Job - # view). + # example, a Job view event usually follows a parent impression event: A job + # seeker first does a search where a list of jobs appears (impression). The job + # seeker then selects a result and views the description of a particular job ( + # Job view). # Corresponds to the JSON property `parentEventId` # @return [String] attr_accessor :parent_event_id @@ -216,21 +198,18 @@ module Google end end - # Input only. - # Parameters needed for commute search. + # Input only. Parameters needed for commute search. class CommuteFilter include Google::Apis::Core::Hashable # Optional. If true, jobs without "precise" addresses (street level addresses or - # GPS - # coordinates) might also be returned. For city and coarser level addresses, - # text matching is used. If this field is set to false or is not specified, - # only jobs that include precise addresses are returned by Commute - # Search. - # Note: If `allow_imprecise_addresses` is set to true, Commute Search is not - # able to calculate accurate commute times to jobs with city level and - # coarser address information. Jobs with imprecise addresses will return a - # `travel_duration` time of 0 regardless of distance from the job seeker. + # GPS coordinates) might also be returned. For city and coarser level addresses, + # text matching is used. If this field is set to false or is not specified, only + # jobs that include precise addresses are returned by Commute Search. Note: If ` + # allow_imprecise_addresses` is set to true, Commute Search is not able to + # calculate accurate commute times to jobs with city level and coarser address + # information. Jobs with imprecise addresses will return a `travel_duration` + # time of 0 regardless of distance from the job seeker. # Corresponds to the JSON property `allowImpreciseAddresses` # @return [Boolean] attr_accessor :allow_imprecise_addresses @@ -241,8 +220,8 @@ module Google # @return [String] attr_accessor :commute_method - # Represents a time of day. The date and time zone are either not significant - # or are specified elsewhere. An API may choose to allow leap seconds. Related + # Represents a time of day. The date and time zone are either not significant or + # are specified elsewhere. An API may choose to allow leap seconds. Related # types are google.type.Date and `google.protobuf.Timestamp`. # Corresponds to the JSON property `departureTime` # @return [Google::Apis::JobsV3p1beta1::TimeOfDay] @@ -255,16 +234,14 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `startCoordinates` # @return [Google::Apis::JobsV3p1beta1::LatLng] attr_accessor :start_coordinates # Required. The maximum travel time in seconds. The maximum allowed value is ` - # 3600s` - # (one hour). Format is `123s`. + # 3600s` (one hour). Format is `123s`. # Corresponds to the JSON property `travelDuration` # @return [String] attr_accessor :travel_duration @@ -284,21 +261,19 @@ module Google end end - # Output only. - # Commute details related to this job. + # Output only. Commute details related to this job. class CommuteInfo include Google::Apis::Core::Hashable - # Output only. - # A resource that represents a location with full geographic information. + # Output only. A resource that represents a location with full geographic + # information. # Corresponds to the JSON property `jobLocation` # @return [Google::Apis::JobsV3p1beta1::Location] attr_accessor :job_location - # The number of seconds required to travel to the job location from the - # query location. A duration of 0 seconds indicates that the job is not - # reachable within the requested duration, but was returned as part of an - # expanded query. + # The number of seconds required to travel to the job location from the query + # location. A duration of 0 seconds indicates that the job is not reachable + # within the requested duration, but was returned as part of an expanded query. # Corresponds to the JSON property `travelDuration` # @return [String] attr_accessor :travel_duration @@ -321,8 +296,7 @@ module Google include Google::Apis::Core::Hashable # Optional. The URI to employer's career site or careers page on the employer's - # web - # site, for example, "https://careers.google.com". + # web site, for example, "https://careers.google.com". # Corresponds to the JSON property `careerSiteUri` # @return [String] attr_accessor :career_site_uri @@ -337,32 +311,29 @@ module Google # @return [String] attr_accessor :display_name - # Optional. Equal Employment Opportunity legal disclaimer text to be - # associated with all jobs, and typically to be displayed in all - # roles. - # The maximum number of allowed characters is 500. + # Optional. Equal Employment Opportunity legal disclaimer text to be associated + # with all jobs, and typically to be displayed in all roles. The maximum number + # of allowed characters is 500. # Corresponds to the JSON property `eeoText` # @return [String] attr_accessor :eeo_text # Required. Client side company identifier, used to uniquely identify the - # company. - # The maximum number of allowed characters is 255. + # company. The maximum number of allowed characters is 255. # Corresponds to the JSON property `externalId` # @return [String] attr_accessor :external_id # Optional. The street address of the company's main headquarters, which may be - # different from the job location. The service attempts - # to geolocate the provided address, and populates a more specific - # location wherever possible in DerivedInfo.headquarters_location. + # different from the job location. The service attempts to geolocate the + # provided address, and populates a more specific location wherever possible in + # DerivedInfo.headquarters_location. # Corresponds to the JSON property `headquartersAddress` # @return [String] attr_accessor :headquarters_address # Optional. Set to true if it is the hiring agency that post jobs for other - # employers. - # Defaults to false if not provided. + # employers. Defaults to false if not provided. # Corresponds to the JSON property `hiringAgency` # @return [Boolean] attr_accessor :hiring_agency @@ -374,20 +345,19 @@ module Google attr_accessor :image_uri # Optional. A list of keys of filterable Job.custom_attributes, whose - # corresponding `string_values` are used in keyword search. Jobs with - # `string_values` under these specified field keys are returned if any - # of the values matches the search keyword. Custom field values with - # parenthesis, brackets and special symbols won't be properly searchable, - # and those keyword queries need to be surrounded by quotes. + # corresponding `string_values` are used in keyword search. Jobs with ` + # string_values` under these specified field keys are returned if any of the + # values matches the search keyword. Custom field values with parenthesis, + # brackets and special symbols won't be properly searchable, and those keyword + # queries need to be surrounded by quotes. # Corresponds to the JSON property `keywordSearchableJobCustomAttributes` # @return [Array] attr_accessor :keyword_searchable_job_custom_attributes - # Required during company update. - # The resource name for a company. This is generated by the service when a - # company is created. - # The format is "projects/`project_id`/companies/`company_id`", for example, - # "projects/api-test-project/companies/foo". + # Required during company update. The resource name for a company. This is + # generated by the service when a company is created. The format is "projects/` + # project_id`/companies/`company_id`", for example, "projects/api-test-project/ + # companies/foo". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -406,8 +376,8 @@ module Google alias_method :suspended?, :suspended # Optional. The URI representing the company's primary web site or home page, - # for example, "https://www.google.com". - # The maximum number of allowed characters is 255. + # for example, "https://www.google.com". The maximum number of allowed + # characters is 255. # Corresponds to the JSON property `websiteUri` # @return [String] attr_accessor :website_uri @@ -438,8 +408,8 @@ module Google class CompanyDerivedInfo include Google::Apis::Core::Hashable - # Output only. - # A resource that represents a location with full geographic information. + # Output only. A resource that represents a location with full geographic + # information. # Corresponds to the JSON property `headquartersLocation` # @return [Google::Apis::JobsV3p1beta1::Location] attr_accessor :headquarters_location @@ -454,13 +424,11 @@ module Google end end - # A compensation entry that represents one component of compensation, such - # as base pay, bonus, or other compensation type. - # Annualization: One compensation entry can be annualized if - # - it contains valid amount or range. - # - and its expected_units_per_year is set or can be derived. - # Its annualized range is determined as (amount or range) times - # expected_units_per_year. + # A compensation entry that represents one component of compensation, such as + # base pay, bonus, or other compensation type. Annualization: One compensation + # entry can be annualized if - it contains valid amount or range. - and its + # expected_units_per_year is set or can be derived. Its annualized range is + # determined as (amount or range) times expected_units_per_year. class CompensationEntry include Google::Apis::Core::Hashable @@ -469,21 +437,16 @@ module Google # @return [Google::Apis::JobsV3p1beta1::Money] attr_accessor :amount - # Optional. Compensation description. For example, could - # indicate equity terms or provide additional context to an estimated - # bonus. + # Optional. Compensation description. For example, could indicate equity terms + # or provide additional context to an estimated bonus. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Optional. Expected number of units paid each year. If not specified, when - # Job.employment_types is FULLTIME, a default value is inferred - # based on unit. Default values: - # - HOURLY: 2080 - # - DAILY: 260 - # - WEEKLY: 52 - # - MONTHLY: 12 - # - ANNUAL: 1 + # Optional. Expected number of units paid each year. If not specified, when Job. + # employment_types is FULLTIME, a default value is inferred based on unit. + # Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - + # ANNUAL: 1 # Corresponds to the JSON property `expectedUnitsPerYear` # @return [Float] attr_accessor :expected_units_per_year @@ -493,14 +456,14 @@ module Google # @return [Google::Apis::JobsV3p1beta1::CompensationRange] attr_accessor :range - # Optional. Compensation type. - # Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED. + # Optional. Compensation type. Default is CompensationUnit. + # COMPENSATION_TYPE_UNSPECIFIED. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # Optional. Frequency of the specified amount. - # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. + # Optional. Frequency of the specified amount. Default is CompensationUnit. + # COMPENSATION_UNIT_UNSPECIFIED. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit @@ -520,8 +483,7 @@ module Google end end - # Input only. - # Filter on job compensation type and amount. + # Input only. Filter on job compensation type and amount. class CompensationFilter include Google::Apis::Core::Hashable @@ -542,8 +504,8 @@ module Google # @return [String] attr_accessor :type - # Required. Specify desired `base compensation entry's` - # CompensationInfo.CompensationUnit. + # Required. Specify desired `base compensation entry's` CompensationInfo. + # CompensationUnit. # Corresponds to the JSON property `units` # @return [Array] attr_accessor :units @@ -561,21 +523,19 @@ module Google end end - # Input only. - # Compensation based histogram request. + # Input only. Compensation based histogram request. class CompensationHistogramRequest include Google::Apis::Core::Hashable - # Input only. - # Use this field to specify bucketing option for the histogram search response. + # Input only. Use this field to specify bucketing option for the histogram + # search response. # Corresponds to the JSON property `bucketingOption` # @return [Google::Apis::JobsV3p1beta1::NumericBucketingOption] attr_accessor :bucketing_option # Required. Type of the request, representing which field the histogramming - # should be - # performed over. A single request can only specify one histogram of each - # `CompensationHistogramRequestType`. + # should be performed over. A single request can only specify one histogram of + # each `CompensationHistogramRequestType`. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -591,19 +551,16 @@ module Google end end - # Output only. - # Compensation based histogram result. + # Output only. Compensation based histogram result. class CompensationHistogramResult include Google::Apis::Core::Hashable - # Output only. - # Custom numeric bucketing result. + # Output only. Custom numeric bucketing result. # Corresponds to the JSON property `result` # @return [Google::Apis::JobsV3p1beta1::NumericBucketingResult] attr_accessor :result - # Type of the request, corresponding to - # CompensationHistogramRequest.type. + # Type of the request, corresponding to CompensationHistogramRequest.type. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -633,10 +590,9 @@ module Google # @return [Google::Apis::JobsV3p1beta1::CompensationRange] attr_accessor :annualized_total_compensation_range - # Optional. Job compensation information. - # At most one entry can be of type - # CompensationInfo.CompensationType.BASE, which is - # referred as ** base compensation entry ** for the job. + # Optional. Job compensation information. At most one entry can be of type + # CompensationInfo.CompensationType.BASE, which is referred as ** base + # compensation entry ** for the job. # Corresponds to the JSON property `entries` # @return [Array] attr_accessor :entries @@ -678,8 +634,7 @@ module Google end end - # Output only. - # Response of auto-complete query. + # Output only. Response of auto-complete query. class CompleteQueryResponse include Google::Apis::Core::Hashable @@ -688,8 +643,8 @@ module Google # @return [Array] attr_accessor :completion_results - # Output only. - # Additional information returned to client, such as debugging information. + # Output only. Additional information returned to client, such as debugging + # information. # Corresponds to the JSON property `metadata` # @return [Google::Apis::JobsV3p1beta1::ResponseMetadata] attr_accessor :metadata @@ -705,8 +660,7 @@ module Google end end - # Output only. - # Resource that represents completion results. + # Output only. Resource that represents completion results. class CompletionResult include Google::Apis::Core::Hashable @@ -743,9 +697,9 @@ module Google # An event issued when an end user interacts with the application that # implements Cloud Talent Solution. Providing this information improves the - # quality of search and recommendation for the API clients, enabling the - # service to perform optimally. The number of events sent must be consistent - # with other calls, such as job searches, issued to the service by the client. + # quality of search and recommendation for the API clients, enabling the service + # to perform optimally. The number of events sent must be consistent with other + # calls, such as job searches, issued to the service by the client. # Corresponds to the JSON property `clientEvent` # @return [Google::Apis::JobsV3p1beta1::ClientEvent] attr_accessor :client_event @@ -760,8 +714,7 @@ module Google end end - # Input only. - # The Request of the CreateCompany method. + # Input only. The Request of the CreateCompany method. class CreateCompanyRequest include Google::Apis::Core::Hashable @@ -782,14 +735,13 @@ module Google end end - # Input only. - # Create job request. + # Input only. Create job request. class CreateJobRequest include Google::Apis::Core::Hashable # A Job resource represents a job posting (also referred to as a "job listing" - # or "job requisition"). A job belongs to a Company, which is the hiring - # entity responsible for the job. + # or "job requisition"). A job belongs to a Company, which is the hiring entity + # responsible for the job. # Corresponds to the JSON property `job` # @return [Google::Apis::JobsV3p1beta1::Job] attr_accessor :job @@ -809,33 +761,27 @@ module Google include Google::Apis::Core::Hashable # Optional. If the `filterable` flag is true, the custom field values may be - # used for - # custom attribute filters JobQuery.custom_attribute_filter. - # If false, these values may not be used for custom attribute filters. - # Default is false. + # used for custom attribute filters JobQuery.custom_attribute_filter. If false, + # these values may not be used for custom attribute filters. Default is false. # Corresponds to the JSON property `filterable` # @return [Boolean] attr_accessor :filterable alias_method :filterable?, :filterable - # Optional but exactly one of string_values or long_values must - # be specified. - # This field is used to perform number range search. - # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. - # Currently at most 1 long_values is supported. + # Optional but exactly one of string_values or long_values must be specified. + # This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, ` + # LT`) over filterable `long_value`. Currently at most 1 long_values is + # supported. # Corresponds to the JSON property `longValues` # @return [Array] attr_accessor :long_values - # Optional but exactly one of string_values or long_values must - # be specified. - # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or - # `CASE_INSENSITIVE_MATCH`) search. - # For filterable `string_value`s, a maximum total number of 200 values - # is allowed, with each `string_value` has a byte size of no more than - # 500B. For unfilterable `string_values`, the maximum total byte size of - # unfilterable `string_values` is 50KB. - # Empty string is not allowed. + # Optional but exactly one of string_values or long_values must be specified. + # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or ` + # CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum + # total number of 200 values is allowed, with each `string_value` has a byte + # size of no more than 500B. For unfilterable `string_values`, the maximum total + # byte size of unfilterable `string_values` is 50KB. Empty string is not allowed. # Corresponds to the JSON property `stringValues` # @return [Array] attr_accessor :string_values @@ -853,28 +799,27 @@ module Google end # Custom attributes histogram request. An error is thrown if neither - # string_value_histogram or long_value_histogram_bucketing_option has - # been defined. + # string_value_histogram or long_value_histogram_bucketing_option has been + # defined. class CustomAttributeHistogramRequest include Google::Apis::Core::Hashable # Required. Specifies the custom field key to perform a histogram on. If - # specified - # without `long_value_histogram_bucketing_option`, histogram on string values - # of the given `key` is triggered, otherwise histogram is performed on long - # values. + # specified without `long_value_histogram_bucketing_option`, histogram on string + # values of the given `key` is triggered, otherwise histogram is performed on + # long values. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key - # Input only. - # Use this field to specify bucketing option for the histogram search response. + # Input only. Use this field to specify bucketing option for the histogram + # search response. # Corresponds to the JSON property `longValueHistogramBucketingOption` # @return [Google::Apis::JobsV3p1beta1::NumericBucketingOption] attr_accessor :long_value_histogram_bucketing_option - # Optional. If set to true, the response includes the histogram value for - # each key as a string. + # Optional. If set to true, the response includes the histogram value for each + # key as a string. # Corresponds to the JSON property `stringValueHistogram` # @return [Boolean] attr_accessor :string_value_histogram @@ -892,8 +837,7 @@ module Google end end - # Output only. - # Custom attribute histogram result. + # Output only. Custom attribute histogram result. class CustomAttributeHistogramResult include Google::Apis::Core::Hashable @@ -902,14 +846,13 @@ module Google # @return [String] attr_accessor :key - # Output only. - # Custom numeric bucketing result. + # Output only. Custom numeric bucketing result. # Corresponds to the JSON property `longValueHistogramResult` # @return [Google::Apis::JobsV3p1beta1::NumericBucketingResult] attr_accessor :long_value_histogram_result - # Stores a map from the values of string custom field associated - # with `key` to the number of jobs with that value in this histogram result. + # Stores a map from the values of string custom field associated with `key` to + # the number of jobs with that value in this histogram result. # Corresponds to the JSON property `stringValueHistogramResult` # @return [Hash] attr_accessor :string_value_histogram_result @@ -926,36 +869,30 @@ module Google end end - # Input only. - # Custom ranking information for SearchJobsRequest. + # Input only. Custom ranking information for SearchJobsRequest. class CustomRankingInfo include Google::Apis::Core::Hashable - # Required. Controls over how important the score of - # CustomRankingInfo.ranking_expression gets applied to job's final - # ranking position. - # An error is thrown if not specified. + # Required. Controls over how important the score of CustomRankingInfo. + # ranking_expression gets applied to job's final ranking position. An error is + # thrown if not specified. # Corresponds to the JSON property `importanceLevel` # @return [String] attr_accessor :importance_level # Required. Controls over how job documents get ranked on top of existing - # relevance - # score (determined by API algorithm). A combination of the ranking + # relevance score (determined by API algorithm). A combination of the ranking # expression and relevance score is used to determine job's final ranking - # position. - # The syntax for this expression is a subset of Google SQL syntax. - # Supported operators are: +, -, *, /, where the left and right side of - # the operator is either a numeric Job.custom_attributes key, - # integer/double value or an expression that can be evaluated to a number. - # Parenthesis are supported to adjust calculation precedence. The - # expression must be < 100 characters in length. - # The expression is considered invalid for a job if the expression + # position. The syntax for this expression is a subset of Google SQL syntax. + # Supported operators are: +, -, *, /, where the left and right side of the + # operator is either a numeric Job.custom_attributes key, integer/double value + # or an expression that can be evaluated to a number. Parenthesis are supported + # to adjust calculation precedence. The expression must be < 100 characters in + # length. The expression is considered invalid for a job if the expression # references custom attributes that are not populated on the job or if the - # expression results in a divide by zero. If an expression is invalid for a - # job, that job is demoted to the end of the results. - # Sample ranking expression - # (year + 25) * 0.25 - (freshness / 0.5) + # expression results in a divide by zero. If an expression is invalid for a job, + # that job is demoted to the end of the results. Sample ranking expression (year + # + 25) * 0.25 - (freshness / 0.5) # Corresponds to the JSON property `rankingExpression` # @return [String] attr_accessor :ranking_expression @@ -971,9 +908,9 @@ module Google end end - # Device information collected from the job seeker, candidate, or - # other entity conducting the job search. Providing this information improves - # the quality of the search results across devices. + # Device information collected from the job seeker, candidate, or other entity + # conducting the job search. Providing this information improves the quality of + # the search results across devices. class DeviceInfo include Google::Apis::Core::Hashable @@ -999,13 +936,11 @@ module Google end end - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. class Empty include Google::Apis::Core::Hashable @@ -1018,26 +953,24 @@ module Google end end - # Input only. - # Histogram facets to be specified in SearchJobsRequest. + # Input only. Histogram facets to be specified in SearchJobsRequest. class HistogramFacets include Google::Apis::Core::Hashable - # Optional. Specifies compensation field-based histogram requests. - # Duplicate values of CompensationHistogramRequest.type are not allowed. + # Optional. Specifies compensation field-based histogram requests. Duplicate + # values of CompensationHistogramRequest.type are not allowed. # Corresponds to the JSON property `compensationHistogramFacets` # @return [Array] attr_accessor :compensation_histogram_facets - # Optional. Specifies the custom attributes histogram requests. - # Duplicate values of CustomAttributeHistogramRequest.key are not - # allowed. + # Optional. Specifies the custom attributes histogram requests. Duplicate values + # of CustomAttributeHistogramRequest.key are not allowed. # Corresponds to the JSON property `customAttributeHistogramFacets` # @return [Array] attr_accessor :custom_attribute_histogram_facets - # Optional. Specifies the simple type of histogram facets, for example, - # `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. + # Optional. Specifies the simple type of histogram facets, for example, ` + # COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. # Corresponds to the JSON property `simpleHistogramFacets` # @return [Array] attr_accessor :simple_histogram_facets @@ -1054,89 +987,64 @@ module Google end end - # Input Only. - # The histogram request. + # Input Only. The histogram request. class HistogramQuery include Google::Apis::Core::Hashable - # An expression specifies a histogram request against matching resources - # (for example, jobs) for searches. - # Expression syntax is a aggregation function call with histogram facets and - # other options. - # Available aggregation function calls are: - # * `count(string_histogram_facet)`: Count the number of matching entity, for - # each distinct attribute value. - # * `count(numeric_histogram_facet, list of buckets)`: Count the number of - # matching entity within each bucket. - # Data types: - # * Histogram facet: facet names with format a-zA-Z+. - # * String: string like "any string with backslash escape for quote(\")." - # * Number: whole number and floating point number like 10, -1 and -0.01. - # * List: list of elements with comma(,) separator surrounded by square - # brackets. For example, [1, 2, 3] and ["one", "two", "three"]. - # Built-in constants: - # * MIN (minimum number similar to java Double.MIN_VALUE) - # * MAX (maximum number similar to java Double.MAX_VALUE) - # Built-in functions: - # * bucket(start, end[, label]): bucket built-in function creates a bucket - # with range of start, end). Note that the end is exclusive. For example, - # bucket(1, MAX, "positive number") or bucket(1, 10). - # Job histogram facets: - # * company_id: histogram by [Job.distributor_company_id. - # * company_display_name: histogram by Job.company_display_name. - # * employment_type: histogram by Job.employment_types. For example, - # "FULL_TIME", "PART_TIME". - # * company_size: histogram by CompanySize, for example, "SMALL", - # "MEDIUM", "BIG". - # * publish_time_in_month: histogram by the Job.publish_time in months. - # Must specify list of numeric buckets in spec. - # * publish_time_in_year: histogram by the Job.publish_time in years. - # Must specify list of numeric buckets in spec. - # * degree_type: histogram by the Job.degree_type. For example, - # "Bachelors", "Masters". - # * job_level: histogram by the Job.job_level. For example, "Entry - # Level". - # * country: histogram by the country code of jobs. For example, "US", "FR". - # * admin1: histogram by the admin1 code of jobs, which is a global - # placeholder referring to the state, province, or the particular term a - # country uses to define the geographic structure below the country level. - # For example, "CA", "IL". - # * city: histogram by a combination of the "city name, admin1 code". For - # example, "Mountain View, CA", "New York, NY". - # * admin1_country: histogram by a combination of the "admin1 code, country". - # For example, "CA, US", "IL, US". - # * city_coordinate: histogram by the city center's GPS coordinates (latitude - # and longitude). For example, 37.4038522,-122.0987765. Since the coordinates - # of a city center can change, customers may need to refresh them - # periodically. - # * locale: histogram by the Job.language_code. For example, "en-US", - # "fr-FR". - # * language: histogram by the language subtag of the Job.language_code. - # For example, "en", "fr". - # * category: histogram by the JobCategory. For example, - # "COMPUTER_AND_IT", "HEALTHCARE". - # * base_compensation_unit: histogram by the CompensationUnit of base - # salary. For example, "WEEKLY", "MONTHLY". - # * base_compensation: histogram by the base salary. Must specify list of - # numeric buckets to group results by. - # * annualized_base_compensation: histogram by the base annualized salary. - # Must specify list of numeric buckets to group results by. - # * annualized_total_compensation: histogram by the total annualized salary. - # Must specify list of numeric buckets to group results by. - # * string_custom_attribute: histogram by string Job.custom_attributes. - # Values can be accessed via square bracket notations like - # string_custom_attribute["key1"]. - # * numeric_custom_attribute: histogram by numeric Job.custom_attributes. - # Values can be accessed via square bracket notations like - # numeric_custom_attribute["key1"]. Must specify list of numeric buckets to - # group results by. - # Example expressions: - # * count(admin1) - # * count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), - # bucket(100000, MAX)]) - # * count(string_custom_attribute["some-string-custom-attribute"]) - # * count(numeric_custom_attribute["some-numeric-custom-attribute"], - # [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative"]) + # An expression specifies a histogram request against matching resources (for + # example, jobs) for searches. Expression syntax is a aggregation function call + # with histogram facets and other options. Available aggregation function calls + # are: * `count(string_histogram_facet)`: Count the number of matching entity, + # for each distinct attribute value. * `count(numeric_histogram_facet, list of + # buckets)`: Count the number of matching entity within each bucket. Data types: + # * Histogram facet: facet names with format a-zA-Z+. * String: string like "any + # string with backslash escape for quote(\")." * Number: whole number and + # floating point number like 10, -1 and -0.01. * List: list of elements with + # comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and [" + # one", "two", "three"]. Built-in constants: * MIN (minimum number similar to + # java Double.MIN_VALUE) * MAX (maximum number similar to java Double.MAX_VALUE) + # Built-in functions: * bucket(start, end[, label]): bucket built-in function + # creates a bucket with range of start, end). Note that the end is exclusive. + # For example, bucket(1, MAX, "positive number") or bucket(1, 10). Job histogram + # facets: * company_id: histogram by [Job.distributor_company_id. * + # company_display_name: histogram by Job.company_display_name. * employment_type: + # histogram by Job.employment_types. For example, "FULL_TIME", "PART_TIME". * + # company_size: histogram by CompanySize, for example, "SMALL", "MEDIUM", "BIG". + # * publish_time_in_month: histogram by the Job.publish_time in months. Must + # specify list of numeric buckets in spec. * publish_time_in_year: histogram by + # the Job.publish_time in years. Must specify list of numeric buckets in spec. * + # degree_type: histogram by the Job.degree_type. For example, "Bachelors", " + # Masters". * job_level: histogram by the Job.job_level. For example, "Entry + # Level". * country: histogram by the country code of jobs. For example, "US", " + # FR". * admin1: histogram by the admin1 code of jobs, which is a global + # placeholder referring to the state, province, or the particular term a country + # uses to define the geographic structure below the country level. For example, " + # CA", "IL". * city: histogram by a combination of the "city name, admin1 code". + # For example, "Mountain View, CA", "New York, NY". * admin1_country: histogram + # by a combination of the "admin1 code, country". For example, "CA, US", "IL, US" + # . * city_coordinate: histogram by the city center's GPS coordinates (latitude + # and longitude). For example, 37.4038522,-122.0987765. Since the coordinates of + # a city center can change, customers may need to refresh them periodically. * + # locale: histogram by the Job.language_code. For example, "en-US", "fr-FR". * + # language: histogram by the language subtag of the Job.language_code. For + # example, "en", "fr". * category: histogram by the JobCategory. For example, " + # COMPUTER_AND_IT", "HEALTHCARE". * base_compensation_unit: histogram by the + # CompensationUnit of base salary. For example, "WEEKLY", "MONTHLY". * + # base_compensation: histogram by the base salary. Must specify list of numeric + # buckets to group results by. * annualized_base_compensation: histogram by the + # base annualized salary. Must specify list of numeric buckets to group results + # by. * annualized_total_compensation: histogram by the total annualized salary. + # Must specify list of numeric buckets to group results by. * + # string_custom_attribute: histogram by string Job.custom_attributes. Values can + # be accessed via square bracket notations like string_custom_attribute["key1"]. + # * numeric_custom_attribute: histogram by numeric Job.custom_attributes. Values + # can be accessed via square bracket notations like numeric_custom_attribute[" + # key1"]. Must specify list of numeric buckets to group results by. Example + # expressions: * count(admin1) * count(base_compensation, [bucket(1000, 10000), + # bucket(10000, 100000), bucket(100000, MAX)]) * count(string_custom_attribute[" + # some-string-custom-attribute"]) * count(numeric_custom_attribute["some-numeric- + # custom-attribute"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative"] + # ) # Corresponds to the JSON property `histogramQuery` # @return [String] attr_accessor :histogram_query @@ -1151,19 +1059,16 @@ module Google end end - # Output only. - # Histogram result that matches HistogramSpec specified in searches. + # Output only. Histogram result that matches HistogramSpec specified in searches. class HistogramQueryResult include Google::Apis::Core::Hashable # A map from the values of the facet associated with distinct values to the - # number of matching entries with corresponding value. - # The key format is: - # * (for string histogram) string values stored in the field. - # * (for named numeric bucket) name specified in `bucket()` function, like - # for `bucket(0, MAX, "non-negative")`, the key will be `non-negative`. - # * (for anonymous numeric bucket) range formatted as `-`, for - # example, `0-1000`, `MIN-0`, and `0-MAX`. + # number of matching entries with corresponding value. The key format is: * (for + # string histogram) string values stored in the field. * (for named numeric + # bucket) name specified in `bucket()` function, like for `bucket(0, MAX, "non- + # negative")`, the key will be `non-negative`. * (for anonymous numeric bucket) + # range formatted as `-`, for example, `0-1000`, `MIN-0`, and `0-MAX`. # Corresponds to the JSON property `histogram` # @return [Hash] attr_accessor :histogram @@ -1184,11 +1089,9 @@ module Google end end - # Output only. - # Result of a histogram call. The response contains the histogram map for the - # search type specified by HistogramResult.field. - # The response is a map of each filter value to the corresponding count of - # jobs for that filter. + # Output only. Result of a histogram call. The response contains the histogram + # map for the search type specified by HistogramResult.field. The response is a + # map of each filter value to the corresponding count of jobs for that filter. class HistogramResult include Google::Apis::Core::Hashable @@ -1197,9 +1100,8 @@ module Google # @return [String] attr_accessor :search_type - # A map from the values of field to the number of jobs with that value - # in this search result. - # Key: search type (filter names, such as the companyName). + # A map from the values of field to the number of jobs with that value in this + # search result. Key: search type (filter names, such as the companyName). # Values: the count of jobs that match the filter for this search. # Corresponds to the JSON property `values` # @return [Hash] @@ -1216,8 +1118,7 @@ module Google end end - # Output only. - # Histogram results that match HistogramFacets specified in + # Output only. Histogram results that match HistogramFacets specified in # SearchJobsRequest. class HistogramResults include Google::Apis::Core::Hashable @@ -1228,14 +1129,14 @@ module Google # @return [Array] attr_accessor :compensation_histogram_results - # Specifies histogram results for custom attributes that match - # HistogramFacets.custom_attribute_histogram_facets. + # Specifies histogram results for custom attributes that match HistogramFacets. + # custom_attribute_histogram_facets. # Corresponds to the JSON property `customAttributeHistogramResults` # @return [Array] attr_accessor :custom_attribute_histogram_results - # Specifies histogram results that matches - # HistogramFacets.simple_histogram_facets. + # Specifies histogram results that matches HistogramFacets. + # simple_histogram_facets. # Corresponds to the JSON property `simpleHistogramResults` # @return [Array] attr_accessor :simple_histogram_results @@ -1253,24 +1154,22 @@ module Google end # A Job resource represents a job posting (also referred to as a "job listing" - # or "job requisition"). A job belongs to a Company, which is the hiring - # entity responsible for the job. + # or "job requisition"). A job belongs to a Company, which is the hiring entity + # responsible for the job. class Job include Google::Apis::Core::Hashable - # Optional but strongly recommended for the best service experience. - # Location(s) where the employer is looking to hire for this job posting. - # Specifying the full street address(es) of the hiring location enables - # better API results, especially job searches by commute time. - # At most 50 locations are allowed for best search performance. If a job has - # more locations, it is suggested to split it into multiple jobs with unique - # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as - # multiple jobs with the same company_name, language_code and - # requisition_id are not allowed. If the original requisition_id must - # be preserved, a custom field should be used for storage. It is also - # suggested to group the locations that close to each other in the same job - # for better search experience. - # The maximum number of allowed characters is 500. + # Optional but strongly recommended for the best service experience. Location(s) + # where the employer is looking to hire for this job posting. Specifying the + # full street address(es) of the hiring location enables better API results, + # especially job searches by commute time. At most 50 locations are allowed for + # best search performance. If a job has more locations, it is suggested to split + # it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1' + # , 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code + # and requisition_id are not allowed. If the original requisition_id must be + # preserved, a custom field should be used for storage. It is also suggested to + # group the locations that close to each other in the same job for better search + # experience. The maximum number of allowed characters is 500. # Corresponds to the JSON property `addresses` # @return [Array] attr_accessor :addresses @@ -1285,8 +1184,8 @@ module Google # @return [String] attr_accessor :company_display_name - # Required. The resource name of the company listing the job, such as - # "projects/api-test-project/companies/foo". + # Required. The resource name of the company listing the job, such as "projects/ + # api-test-project/companies/foo". # Corresponds to the JSON property `companyName` # @return [String] attr_accessor :company_name @@ -1297,16 +1196,13 @@ module Google attr_accessor :compensation_info # Optional. A map of fields to hold both filterable and non-filterable custom - # job - # attributes that are not covered by the provided structured fields. - # The keys of the map are strings up to 64 bytes and must match the - # pattern: a-zA-Z*. For example, key0LikeThis or - # KEY_1_LIKE_THIS. - # At most 100 filterable and at most 100 unfilterable keys are supported. - # For filterable `string_values`, across all keys at most 200 values are - # allowed, with each string no more than 255 characters. For unfilterable - # `string_values`, the maximum total size of `string_values` across all keys - # is 50KB. + # job attributes that are not covered by the provided structured fields. The + # keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. + # For example, key0LikeThis or KEY_1_LIKE_THIS. At most 100 filterable and at + # most 100 unfilterable keys are supported. For filterable `string_values`, + # across all keys at most 200 values are allowed, with each string no more than + # 255 characters. For unfilterable `string_values`, the maximum total size of ` + # string_values` across all keys is 50KB. # Corresponds to the JSON property `customAttributes` # @return [Hash] attr_accessor :custom_attributes @@ -1318,41 +1214,35 @@ module Google attr_accessor :degree_types # Optional. The department or functional area within the company with the open - # position. - # The maximum number of allowed characters is 255. + # position. The maximum number of allowed characters is 255. # Corresponds to the JSON property `department` # @return [String] attr_accessor :department - # Output only. - # Derived details about the job posting. + # Output only. Derived details about the job posting. # Corresponds to the JSON property `derivedInfo` # @return [Google::Apis::JobsV3p1beta1::JobDerivedInfo] attr_accessor :derived_info # Required. The description of the job, which typically includes a multi- - # paragraph - # description of the company and related information. Separate fields are - # provided on the job object for responsibilities, - # qualifications, and other job characteristics. Use of - # these separate job fields is recommended. - # This field accepts and sanitizes HTML input, and also accepts - # bold, italic, ordered list, and unordered list markup tags. - # The maximum number of allowed characters is 100,000. + # paragraph description of the company and related information. Separate fields + # are provided on the job object for responsibilities, qualifications, and other + # job characteristics. Use of these separate job fields is recommended. This + # field accepts and sanitizes HTML input, and also accepts bold, italic, ordered + # list, and unordered list markup tags. The maximum number of allowed characters + # is 100,000. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Optional. The employment type(s) of a job, for example, - # full time or - # part time. + # Optional. The employment type(s) of a job, for example, full time or part time. # Corresponds to the JSON property `employmentTypes` # @return [Array] attr_accessor :employment_types # Optional. A description of bonus, commission, and other compensation - # incentives associated with the job not including salary or pay. - # The maximum number of allowed characters is 10,000. + # incentives associated with the job not including salary or pay. The maximum + # number of allowed characters is 10,000. # Corresponds to the JSON property `incentives` # @return [String] attr_accessor :incentives @@ -1363,8 +1253,7 @@ module Google attr_accessor :job_benefits # Optional. The end timestamp of the job. Typically this field is used for - # contracting - # engagements. Invalid timestamps are ignored. + # contracting engagements. Invalid timestamps are ignored. # Corresponds to the JSON property `jobEndTime` # @return [String] attr_accessor :job_end_time @@ -1375,31 +1264,26 @@ module Google attr_accessor :job_level # Optional. The start timestamp of the job in UTC time zone. Typically this - # field - # is used for contracting engagements. Invalid timestamps are ignored. + # field is used for contracting engagements. Invalid timestamps are ignored. # Corresponds to the JSON property `jobStartTime` # @return [String] attr_accessor :job_start_time - # Optional. The language of the posting. This field is distinct from - # any requirements for fluency that are associated with the job. - # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". - # For more information, see - # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47)`: - # class="external" target="_blank" `. - # If this field is unspecified and Job.description is present, detected - # language code based on Job.description is assigned, otherwise - # defaults to 'en_US'. + # Optional. The language of the posting. This field is distinct from any + # requirements for fluency that are associated with the job. Language codes must + # be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [ + # Tags for Identifying Languages](https://tools.ietf.org/html/bcp47)`: class=" + # external" target="_blank" `. If this field is unspecified and Job.description + # is present, detected language code based on Job.description is assigned, + # otherwise defaults to 'en_US'. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code - # Required during job update. - # The resource name for the job. This is generated by the service when a - # job is created. - # The format is "projects/`project_id`/jobs/`job_id`", - # for example, "projects/api-test-project/jobs/1234". - # Use of this field in job queries and API calls is preferred over the use of + # Required during job update. The resource name for the job. This is generated + # by the service when a job is created. The format is "projects/`project_id`/ + # jobs/`job_id`", for example, "projects/api-test-project/jobs/1234". Use of + # this field in job queries and API calls is preferred over the use of # requisition_id since this value is unique. # Corresponds to the JSON property `name` # @return [String] @@ -1410,52 +1294,45 @@ module Google # @return [String] attr_accessor :posting_create_time - # Optional but strongly recommended for the best service - # experience. - # The expiration timestamp of the job. After this timestamp, the - # job is marked as expired, and it no longer appears in search results. The - # expired job can't be deleted or listed by the DeleteJob and - # ListJobs APIs, but it can be retrieved with the GetJob API or - # updated with the UpdateJob API. An expired job can be updated and - # opened again by using a future expiration timestamp. Updating an expired - # job fails if there is another existing open job with same company_name, - # language_code and requisition_id. - # The expired jobs are retained in our system for 90 days. However, the - # overall expired job count cannot exceed 3 times the maximum of open jobs - # count over the past week, otherwise jobs with earlier expire time are - # cleaned first. Expired jobs are no longer accessible after they are cleaned - # out. - # Invalid timestamps are ignored, and treated as expire time not provided. - # Timestamp before the instant request is made is considered valid, the job - # will be treated as expired immediately. - # If this value is not provided at the time of job creation or is invalid, - # the job posting expires after 30 days from the job's creation time. For - # example, if the job was created on 2017/01/01 13:00AM UTC with an - # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. - # If this value is not provided on job update, it depends on the field masks - # set by UpdateJobRequest.update_mask. If the field masks include - # expiry_time, or the masks are empty meaning that every field is - # updated, the job posting expires after 30 days from the job's last + # Optional but strongly recommended for the best service experience. The + # expiration timestamp of the job. After this timestamp, the job is marked as + # expired, and it no longer appears in search results. The expired job can't be + # deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved + # with the GetJob API or updated with the UpdateJob API. An expired job can be + # updated and opened again by using a future expiration timestamp. Updating an + # expired job fails if there is another existing open job with same company_name, + # language_code and requisition_id. The expired jobs are retained in our system + # for 90 days. However, the overall expired job count cannot exceed 3 times the + # maximum of open jobs count over the past week, otherwise jobs with earlier + # expire time are cleaned first. Expired jobs are no longer accessible after + # they are cleaned out. Invalid timestamps are ignored, and treated as expire + # time not provided. Timestamp before the instant request is made is considered + # valid, the job will be treated as expired immediately. If this value is not + # provided at the time of job creation or is invalid, the job posting expires + # after 30 days from the job's creation time. For example, if the job was + # created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job + # expires after 2017/01/31 13:00AM UTC. If this value is not provided on job + # update, it depends on the field masks set by UpdateJobRequest.update_mask. If + # the field masks include expiry_time, or the masks are empty meaning that every + # field is updated, the job posting expires after 30 days from the job's last # update time. Otherwise the expiration date isn't updated. # Corresponds to the JSON property `postingExpireTime` # @return [String] attr_accessor :posting_expire_time # Optional. The timestamp this job posting was most recently published. The - # default - # value is the time the request arrives at the server. Invalid timestamps are - # ignored. + # default value is the time the request arrives at the server. Invalid + # timestamps are ignored. # Corresponds to the JSON property `postingPublishTime` # @return [String] attr_accessor :posting_publish_time # Optional. The job PostingRegion (for example, state, country) throughout which - # the job is available. If this field is set, a - # LocationFilter in a search query within the job region - # finds this job posting if an exact location match isn't specified. - # If this field is set to PostingRegion.NATION or - # PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses - # to the same location level as this field is strongly recommended. + # the job is available. If this field is set, a LocationFilter in a search query + # within the job region finds this job posting if an exact location match isn't + # specified. If this field is set to PostingRegion.NATION or PostingRegion. + # ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as + # this field is strongly recommended. # Corresponds to the JSON property `postingRegion` # @return [String] attr_accessor :posting_region @@ -1465,61 +1342,55 @@ module Google # @return [String] attr_accessor :posting_update_time - # Input only. - # Options for job processing. + # Input only. Options for job processing. # Corresponds to the JSON property `processingOptions` # @return [Google::Apis::JobsV3p1beta1::ProcessingOptions] attr_accessor :processing_options - # Optional. A promotion value of the job, as determined by the client. - # The value determines the sort order of the jobs returned when searching for - # jobs using the featured jobs search call, with higher promotional values - # being returned first and ties being resolved by relevance sort. Only the - # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. - # Default value is 0, and negative values are treated as 0. + # Optional. A promotion value of the job, as determined by the client. The value + # determines the sort order of the jobs returned when searching for jobs using + # the featured jobs search call, with higher promotional values being returned + # first and ties being resolved by relevance sort. Only the jobs with a + # promotionValue >0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, + # and negative values are treated as 0. # Corresponds to the JSON property `promotionValue` # @return [Fixnum] attr_accessor :promotion_value - # Optional. A description of the qualifications required to perform the - # job. The use of this field is recommended - # as an alternative to using the more general description field. - # This field accepts and sanitizes HTML input, and also accepts - # bold, italic, ordered list, and unordered list markup tags. - # The maximum number of allowed characters is 10,000. + # Optional. A description of the qualifications required to perform the job. The + # use of this field is recommended as an alternative to using the more general + # description field. This field accepts and sanitizes HTML input, and also + # accepts bold, italic, ordered list, and unordered list markup tags. The + # maximum number of allowed characters is 10,000. # Corresponds to the JSON property `qualifications` # @return [String] attr_accessor :qualifications # Required. The requisition ID, also referred to as the posting ID, assigned by - # the - # client to identify a job. This field is intended to be used by clients - # for client identification and tracking of postings. A job is not allowed - # to be created if there is another job with the same [company_name], - # language_code and requisition_id. - # The maximum number of allowed characters is 255. + # the client to identify a job. This field is intended to be used by clients for + # client identification and tracking of postings. A job is not allowed to be + # created if there is another job with the same [company_name], language_code + # and requisition_id. The maximum number of allowed characters is 255. # Corresponds to the JSON property `requisitionId` # @return [String] attr_accessor :requisition_id # Optional. A description of job responsibilities. The use of this field is - # recommended as an alternative to using the more general description - # field. - # This field accepts and sanitizes HTML input, and also accepts - # bold, italic, ordered list, and unordered list markup tags. - # The maximum number of allowed characters is 10,000. + # recommended as an alternative to using the more general description field. + # This field accepts and sanitizes HTML input, and also accepts bold, italic, + # ordered list, and unordered list markup tags. The maximum number of allowed + # characters is 10,000. # Corresponds to the JSON property `responsibilities` # @return [String] attr_accessor :responsibilities - # Required. The title of the job, such as "Software Engineer" - # The maximum number of allowed characters is 500. + # Required. The title of the job, such as "Software Engineer" The maximum number + # of allowed characters is 500. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title - # Deprecated. The job is only visible to the owner. - # The visibility of the job. + # Deprecated. The job is only visible to the owner. The visibility of the job. # Defaults to Visibility.ACCOUNT_ONLY if not specified. # Corresponds to the JSON property `visibility` # @return [String] @@ -1564,8 +1435,7 @@ module Google end end - # Output only. - # Derived details about the job posting. + # Output only. Derived details about the job posting. class JobDerivedInfo include Google::Apis::Core::Hashable @@ -1574,9 +1444,8 @@ module Google # @return [Array] attr_accessor :job_categories - # Structured locations of the job, resolved from Job.addresses. - # locations are exactly matched to Job.addresses in the same - # order. + # Structured locations of the job, resolved from Job.addresses. locations are + # exactly matched to Job.addresses in the same order. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations @@ -1597,11 +1466,10 @@ module Google class JobEvent include Google::Apis::Core::Hashable - # Required. The job name(s) associated with this event. - # For example, if this is an impression event, - # this field contains the identifiers of all jobs shown to the job seeker. - # If this was a view event, this field contains the - # identifier of the viewed job. + # Required. The job name(s) associated with this event. For example, if this is + # an impression event, this field contains the identifiers of all jobs shown to + # the job seeker. If this was a view event, this field contains the identifier + # of the viewed job. # Corresponds to the JSON property `jobs` # @return [Array] attr_accessor :jobs @@ -1622,124 +1490,103 @@ module Google end end - # Input only. - # The query required to perform a search query. + # Input only. The query required to perform a search query. class JobQuery include Google::Apis::Core::Hashable - # Input only. - # Parameters needed for commute search. + # Input only. Parameters needed for commute search. # Corresponds to the JSON property `commuteFilter` # @return [Google::Apis::JobsV3p1beta1::CommuteFilter] attr_accessor :commute_filter - # Optional. This filter specifies the exact company display - # name of the jobs to search against. - # If a value isn't specified, jobs within the search results are - # associated with any company. - # If multiple values are specified, jobs within the search results may be - # associated with any of the specified companies. - # At most 20 company display name filters are allowed. + # Optional. This filter specifies the exact company display name of the jobs to + # search against. If a value isn't specified, jobs within the search results are + # associated with any company. If multiple values are specified, jobs within the + # search results may be associated with any of the specified companies. At most + # 20 company display name filters are allowed. # Corresponds to the JSON property `companyDisplayNames` # @return [Array] attr_accessor :company_display_names - # Optional. This filter specifies the company entities to search against. - # If a value isn't specified, jobs are searched for against all - # companies. - # If multiple values are specified, jobs are searched against the - # companies specified. - # The format is "projects/`project_id`/companies/`company_id`", for example, - # "projects/api-test-project/companies/foo". - # At most 20 company filters are allowed. + # Optional. This filter specifies the company entities to search against. If a + # value isn't specified, jobs are searched for against all companies. If + # multiple values are specified, jobs are searched against the companies + # specified. The format is "projects/`project_id`/companies/`company_id`", for + # example, "projects/api-test-project/companies/foo". At most 20 company filters + # are allowed. # Corresponds to the JSON property `companyNames` # @return [Array] attr_accessor :company_names - # Input only. - # Filter on job compensation type and amount. + # Input only. Filter on job compensation type and amount. # Corresponds to the JSON property `compensationFilter` # @return [Google::Apis::JobsV3p1beta1::CompensationFilter] attr_accessor :compensation_filter - # Optional. This filter specifies a structured syntax to match against the - # Job.custom_attributes marked as `filterable`. - # The syntax for this expression is a subset of SQL syntax. - # Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the - # left of the operator is a custom field key and the right of the operator - # is a number or a quoted string. You must escape backslash (\\) and - # quote (\") characters. - # Supported functions are `LOWER([field_name])` to + # Optional. This filter specifies a structured syntax to match against the Job. + # custom_attributes marked as `filterable`. The syntax for this expression is a + # subset of SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and ` + # >=` where the left of the operator is a custom field key and the right of the + # operator is a number or a quoted string. You must escape backslash (\\) and + # quote (\") characters. Supported functions are `LOWER([field_name])` to # perform a case insensitive match and `EMPTY([field_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. - # Sample Query: - # `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND - # driving_years > 10` + # 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. Sample Query: `(LOWER(driving_license)="class \ + # "a\"" OR EMPTY(driving_license)) AND driving_years > 10` # Corresponds to the JSON property `customAttributeFilter` # @return [String] attr_accessor :custom_attribute_filter - # Optional. This flag controls the spell-check feature. If false, the - # service attempts to correct a misspelled query, - # for example, "enginee" is corrected to "engineer". - # Defaults to false: a spell check is performed. + # Optional. This flag controls the spell-check feature. If false, the service + # attempts to correct a misspelled query, for example, "enginee" is corrected to + # "engineer". Defaults to false: a spell check is performed. # Corresponds to the JSON property `disableSpellCheck` # @return [Boolean] attr_accessor :disable_spell_check alias_method :disable_spell_check?, :disable_spell_check # Optional. The employment type filter specifies the employment type of jobs to - # search against, such as EmploymentType.FULL_TIME. - # If a value is not specified, jobs in the search results includes any - # employment type. - # If multiple values are specified, jobs in the search results include - # any of the specified employment types. + # search against, such as EmploymentType.FULL_TIME. If a value is not specified, + # jobs in the search results includes any employment type. If multiple values + # are specified, jobs in the search results include any of the specified + # employment types. # Corresponds to the JSON property `employmentTypes` # @return [Array] attr_accessor :employment_types # Optional. This filter specifies a list of job names to be excluded during - # search. - # At most 400 excluded job names are allowed. + # search. At most 400 excluded job names are allowed. # Corresponds to the JSON property `excludedJobs` # @return [Array] attr_accessor :excluded_jobs # Optional. The category filter specifies the categories of jobs to search - # against. - # See Category for more information. - # If a value is not specified, jobs from any category are searched against. - # If multiple values are specified, jobs from any of the specified - # categories are searched against. + # against. See Category for more information. If a value is not specified, jobs + # from any category are searched against. If multiple values are specified, jobs + # from any of the specified categories are searched against. # Corresponds to the JSON property `jobCategories` # @return [Array] attr_accessor :job_categories - # Optional. This filter specifies the locale of jobs to search against, - # for example, "en-US". - # If a value isn't specified, the search results can contain jobs in any - # locale. - # Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". - # For more information, see - # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). - # At most 10 language code filters are allowed. + # Optional. This filter specifies the locale of jobs to search against, for + # example, "en-US". If a value isn't specified, the search results can contain + # jobs in any locale. Language codes should be in BCP-47 format, such as "en-US" + # or "sr-Latn". For more information, see [Tags for Identifying Languages](https: + # //tools.ietf.org/html/bcp47). At most 10 language code filters are allowed. # Corresponds to the JSON property `languageCodes` # @return [Array] attr_accessor :language_codes # Optional. The location filter specifies geo-regions containing the jobs to - # search against. See LocationFilter for more information. - # If a location value isn't specified, jobs fitting the other search - # criteria are retrieved regardless of where they're located. - # If multiple values are specified, jobs are retrieved from any of the - # specified locations. If different values are specified for the - # LocationFilter.distance_in_miles parameter, the maximum provided - # distance is used for all locations. - # At most 5 location filters are allowed. + # search against. See LocationFilter for more information. If a location value + # isn't specified, jobs fitting the other search criteria are retrieved + # regardless of where they're located. If multiple values are specified, jobs + # are retrieved from any of the specified locations. If different values are + # specified for the LocationFilter.distance_in_miles parameter, the maximum + # provided distance is used for all locations. At most 5 location filters are + # allowed. # Corresponds to the JSON property `locationFilters` # @return [Array] attr_accessor :location_filters @@ -1750,20 +1597,16 @@ module Google attr_accessor :publish_time_range # Optional. The query string that matches against the job title, description, - # and - # location fields. - # The maximum number of allowed characters is 255. + # and location fields. The maximum number of allowed characters is 255. # Corresponds to the JSON property `query` # @return [String] attr_accessor :query - # The language code of query. For example, "en-US". This field helps to - # better interpret the query. - # If a value isn't specified, the query language code is automatically - # detected, which may not be accurate. - # Language code should be in BCP-47 format, such as "en-US" or "sr-Latn". - # For more information, see - # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). + # The language code of query. For example, "en-US". This field helps to better + # interpret the query. If a value isn't specified, the query language code is + # automatically detected, which may not be accurate. Language code should be in + # BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags + # for Identifying Languages](https://tools.ietf.org/html/bcp47). # Corresponds to the JSON property `queryLanguageCode` # @return [String] attr_accessor :query_language_code @@ -1793,9 +1636,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. class LatLng include Google::Apis::Core::Hashable @@ -1820,8 +1662,7 @@ module Google end end - # Output only. - # The List companies response object. + # Output only. The List companies response object. class ListCompaniesResponse include Google::Apis::Core::Hashable @@ -1830,8 +1671,8 @@ module Google # @return [Array] attr_accessor :companies - # Output only. - # Additional information returned to client, such as debugging information. + # Output only. Additional information returned to client, such as debugging + # information. # Corresponds to the JSON property `metadata` # @return [Google::Apis::JobsV3p1beta1::ResponseMetadata] attr_accessor :metadata @@ -1853,20 +1694,18 @@ module Google end end - # Output only. - # List jobs response. + # Output only. List jobs response. class ListJobsResponse include Google::Apis::Core::Hashable - # The Jobs for a given company. - # The maximum number of items returned is based on the limit field - # provided in the request. + # The Jobs for a given company. The maximum number of items returned is based on + # the limit field provided in the request. # Corresponds to the JSON property `jobs` # @return [Array] attr_accessor :jobs - # Output only. - # Additional information returned to client, such as debugging information. + # Output only. Additional information returned to client, such as debugging + # information. # Corresponds to the JSON property `metadata` # @return [Google::Apis::JobsV3p1beta1::ResponseMetadata] attr_accessor :metadata @@ -1888,16 +1727,15 @@ module Google end end - # Output only. - # A resource that represents a location with full geographic information. + # Output only. A resource that represents a location with full geographic + # information. class Location include Google::Apis::Core::Hashable # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::JobsV3p1beta1::LatLng] attr_accessor :lat_lng @@ -1912,27 +1750,22 @@ module Google # Represents a postal address, e.g. for postal delivery or payments addresses. # Given a postal address, a postal service can deliver items to a premise, P.O. - # Box or similar. - # It is not intended to model geographical locations (roads, towns, - # mountains). - # In typical usage an address would be created via user input or from importing - # existing data, depending on the type of process. - # Advice on address input / editing: - # - Use an i18n-ready address widget such as - # https://github.com/google/libaddressinput) - # - Users should not be presented with UI elements for input or editing of - # fields outside countries where that field is used. - # For more guidance on how to use this schema, please see: - # https://support.google.com/business/answer/6397478 + # Box or similar. It is not intended to model geographical locations (roads, + # towns, mountains). In typical usage an address would be created via user input + # or from importing existing data, depending on the type of process. Advice on + # address input / editing: - Use an i18n-ready address widget such as https:// + # github.com/google/libaddressinput) - Users should not be presented with UI + # elements for input or editing of fields outside countries where that field is + # used. For more guidance on how to use this schema, please see: https://support. + # google.com/business/answer/6397478 # Corresponds to the JSON property `postalAddress` # @return [Google::Apis::JobsV3p1beta1::PostalAddress] attr_accessor :postal_address - # Radius in miles of the job location. This value is derived from the - # location bounding box in which a circle with the specified radius - # centered from LatLng covers the area associated with the job location. - # For example, currently, "Mountain View, CA, USA" has a radius of - # 6.17 miles. + # Radius in miles of the job location. This value is derived from the location + # bounding box in which a circle with the specified radius centered from LatLng + # covers the area associated with the job location. For example, currently, " + # Mountain View, CA, USA" has a radius of 6.17 miles. # Corresponds to the JSON property `radiusInMiles` # @return [Float] attr_accessor :radius_in_miles @@ -1950,8 +1783,7 @@ module Google end end - # Input only. - # Geographic region of the search. + # Input only. Geographic region of the search. class LocationFilter include Google::Apis::Core::Hashable @@ -1961,49 +1793,43 @@ module Google attr_accessor :address # Optional. The distance_in_miles is applied when the location being searched - # for is - # identified as a city or smaller. When the location being searched for is a - # state or larger, this field is ignored. + # for is identified as a city or smaller. When the location being searched for + # is a state or larger, this field is ignored. # Corresponds to the JSON property `distanceInMiles` # @return [Float] attr_accessor :distance_in_miles # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::JobsV3p1beta1::LatLng] attr_accessor :lat_lng # Optional. CLDR region code of the country/region of the address. This is used # to address ambiguity of the user-input location, for example, "Liverpool" - # against "Liverpool, NY, US" or "Liverpool, UK". - # Set this field if all the jobs to search against are from a same region, - # or jobs are world-wide, but the job seeker is from a specific region. - # See http://cldr.unicode.org/ and - # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - # for details. Example: "CH" for Switzerland. + # against "Liverpool, NY, US" or "Liverpool, UK". Set this field if all the jobs + # to search against are from a same region, or jobs are world-wide, but the job + # seeker is from a specific region. See http://cldr.unicode.org/ and http://www. + # unicode.org/cldr/charts/30/supplemental/territory_information.html for details. + # Example: "CH" for Switzerland. # Corresponds to the JSON property `regionCode` # @return [String] attr_accessor :region_code - # Optional. Allows the client to return jobs without a - # set location, specifically, telecommuting jobs (telecommuting is considered - # by the service as a special location. - # Job.posting_region indicates if a job permits telecommuting. - # If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, - # telecommuting jobs are searched, and address and lat_lng are - # ignored. If not set or set to - # TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not - # searched. - # This filter can be used by itself to search exclusively for telecommuting - # jobs, or it can be combined with another location - # filter to search for a combination of job locations, - # such as "Mountain View" or "telecommuting" jobs. However, when used in - # combination with other location filters, telecommuting jobs can be - # treated as less relevant than other jobs in the search response. + # Optional. Allows the client to return jobs without a set location, + # specifically, telecommuting jobs (telecommuting is considered by the service + # as a special location. Job.posting_region indicates if a job permits + # telecommuting. If this field is set to TelecommutePreference. + # TELECOMMUTE_ALLOWED, telecommuting jobs are searched, and address and lat_lng + # are ignored. If not set or set to TelecommutePreference.TELECOMMUTE_EXCLUDED, + # telecommute job are not searched. This filter can be used by itself to search + # exclusively for telecommuting jobs, or it can be combined with another + # location filter to search for a combination of job locations, such as " + # Mountain View" or "telecommuting" jobs. However, when used in combination with + # other location filters, telecommuting jobs can be treated as less relevant + # than other jobs in the search response. # Corresponds to the JSON property `telecommutePreference` # @return [String] attr_accessor :telecommute_preference @@ -2022,20 +1848,18 @@ module Google end end - # Output only. - # Job entry with metadata inside SearchJobsResponse. + # Output only. Job entry with metadata inside SearchJobsResponse. class MatchingJob include Google::Apis::Core::Hashable - # Output only. - # Commute details related to this job. + # Output only. Commute details related to this job. # Corresponds to the JSON property `commuteInfo` # @return [Google::Apis::JobsV3p1beta1::CommuteInfo] attr_accessor :commute_info # A Job resource represents a job posting (also referred to as a "job listing" - # or "job requisition"). A job belongs to a Company, which is the hiring - # entity responsible for the job. + # or "job requisition"). A job belongs to a Company, which is the hiring entity + # responsible for the job. # Corresponds to the JSON property `job` # @return [Google::Apis::JobsV3p1beta1::Job] attr_accessor :job @@ -2046,17 +1870,17 @@ module Google # @return [String] attr_accessor :job_summary - # Contains snippets of text from the Job.job_title field most - # closely matching a search query's keywords, if available. The matching - # query keywords are enclosed in HTML bold tags. + # Contains snippets of text from the Job.job_title field most closely matching a + # search query's keywords, if available. The matching query keywords are + # enclosed in HTML bold tags. # Corresponds to the JSON property `jobTitleSnippet` # @return [String] attr_accessor :job_title_snippet - # Contains snippets of text from the Job.description and similar - # fields that most closely match a search query's keywords, if available. - # All HTML tags in the original fields are stripped when returned in this - # field, and matching query keywords are enclosed in HTML bold tags. + # Contains snippets of text from the Job.description and similar fields that + # most closely match a search query's keywords, if available. All HTML tags in + # the original fields are stripped when returned in this field, and matching + # query keywords are enclosed in HTML bold tags. # Corresponds to the JSON property `searchTextSnippet` # @return [String] attr_accessor :search_text_snippet @@ -2075,20 +1899,18 @@ module Google end end - # Message representing input to a Mendel server for debug forcing. - # See go/mendel-debug-forcing for more details. - # Next ID: 2 + # Message representing input to a Mendel server for debug forcing. See go/mendel- + # debug-forcing for more details. Next ID: 2 class MendelDebugInput include Google::Apis::Core::Hashable - # When a request spans multiple servers, a MendelDebugInput may travel with - # the request and take effect in all the servers. This field is a map of - # namespaces to NamespacedMendelDebugInput protos. In a single server, up to - # two NamespacedMendelDebugInput protos are applied: - # 1. NamespacedMendelDebugInput with the global namespace (key == ""). - # 2. NamespacedMendelDebugInput with the server's namespace. - # When both NamespacedMendelDebugInput protos are present, they are merged. - # See go/mendel-debug-forcing for more details. + # When a request spans multiple servers, a MendelDebugInput may travel with the + # request and take effect in all the servers. This field is a map of namespaces + # to NamespacedMendelDebugInput protos. In a single server, up to two + # NamespacedMendelDebugInput protos are applied: 1. NamespacedMendelDebugInput + # with the global namespace (key == ""). 2. NamespacedMendelDebugInput with the + # server's namespace. When both NamespacedMendelDebugInput protos are present, + # they are merged. See go/mendel-debug-forcing for more details. # Corresponds to the JSON property `namespacedDebugInput` # @return [Hash] attr_accessor :namespaced_debug_input @@ -2112,18 +1934,17 @@ module Google # @return [String] attr_accessor :currency_code - # Number of nano (10^-9) units of the amount. - # The value must be between -999,999,999 and +999,999,999 inclusive. - # If `units` is positive, `nanos` must be positive or zero. - # If `units` is zero, `nanos` can be positive, zero, or negative. - # If `units` is negative, `nanos` must be negative or zero. - # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + # Number of nano (10^-9) units of the amount. The value must be between -999,999, + # 999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be + # positive or zero. If `units` is zero, `nanos` can be positive, zero, or + # negative. If `units` is negative, `nanos` must be negative or zero. For + # example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. # Corresponds to the JSON property `nanos` # @return [Fixnum] attr_accessor :nanos - # The whole units of the amount. - # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + # The whole units of the amount. For example if `currencyCode` is `"USD"`, then + # 1 unit is one US dollar. # Corresponds to the JSON property `units` # @return [Fixnum] attr_accessor :units @@ -2144,89 +1965,85 @@ module Google class NamespacedDebugInput include Google::Apis::Core::Hashable - # Set of experiment names to be absolutely forced. - # These experiments will be forced without evaluating the conditions. + # Set of experiment names to be absolutely forced. These experiments will be + # forced without evaluating the conditions. # Corresponds to the JSON property `absolutelyForcedExpNames` # @return [Array] attr_accessor :absolutely_forced_exp_names - # Set of experiment tags to be absolutely forced. - # The experiments with these tags will be forced without evaluating the - # conditions. + # Set of experiment tags to be absolutely forced. The experiments with these + # tags will be forced without evaluating the conditions. # Corresponds to the JSON property `absolutelyForcedExpTags` # @return [Array] attr_accessor :absolutely_forced_exp_tags - # Set of experiment ids to be absolutely forced. - # These ids will be forced without evaluating the conditions. + # Set of experiment ids to be absolutely forced. These ids will be forced + # without evaluating the conditions. # Corresponds to the JSON property `absolutelyForcedExps` # @return [Array] attr_accessor :absolutely_forced_exps - # Set of experiment names to be conditionally forced. - # These experiments will be forced only if their conditions and their - # parent domain's conditions are true. + # Set of experiment names to be conditionally forced. These experiments will be + # forced only if their conditions and their parent domain's conditions are true. # Corresponds to the JSON property `conditionallyForcedExpNames` # @return [Array] attr_accessor :conditionally_forced_exp_names - # Set of experiment tags to be conditionally forced. - # The experiments with these tags will be forced only if their conditions - # and their parent domain's conditions are true. + # Set of experiment tags to be conditionally forced. The experiments with these + # tags will be forced only if their conditions and their parent domain's + # conditions are true. # Corresponds to the JSON property `conditionallyForcedExpTags` # @return [Array] attr_accessor :conditionally_forced_exp_tags - # Set of experiment ids to be conditionally forced. - # These ids will be forced only if their conditions and their parent - # domain's conditions are true. + # Set of experiment ids to be conditionally forced. These ids will be forced + # only if their conditions and their parent domain's conditions are true. # Corresponds to the JSON property `conditionallyForcedExps` # @return [Array] attr_accessor :conditionally_forced_exps - # If true, disable automatic enrollment selection (at all diversion - # points). Automatic enrollment selection means experiment selection - # process based on the experiment's automatic enrollment condition. This - # does not disable selection of forced experiments. + # If true, disable automatic enrollment selection (at all diversion points). + # Automatic enrollment selection means experiment selection process based on the + # experiment's automatic enrollment condition. This does not disable selection + # of forced experiments. # Corresponds to the JSON property `disableAutomaticEnrollmentSelection` # @return [Boolean] attr_accessor :disable_automatic_enrollment_selection alias_method :disable_automatic_enrollment_selection?, :disable_automatic_enrollment_selection - # Set of experiment names to be disabled. - # If an experiment is disabled, it is never selected nor forced. - # If an aggregate experiment is disabled, its partitions are disabled - # together. If an experiment with an enrollment is disabled, the enrollment - # is disabled together. If a name corresponds to a domain, the domain - # itself and all descendant experiments and domains are disabled together. + # Set of experiment names to be disabled. If an experiment is disabled, it is + # never selected nor forced. If an aggregate experiment is disabled, its + # partitions are disabled together. If an experiment with an enrollment is + # disabled, the enrollment is disabled together. If a name corresponds to a + # domain, the domain itself and all descendant experiments and domains are + # disabled together. # Corresponds to the JSON property `disableExpNames` # @return [Array] attr_accessor :disable_exp_names - # Set of experiment tags to be disabled. All experiments that are tagged - # with one or more of these tags are disabled. - # If an experiment is disabled, it is never selected nor forced. - # If an aggregate experiment is disabled, its partitions are disabled - # together. If an experiment with an enrollment is disabled, the enrollment - # is disabled together. + # Set of experiment tags to be disabled. All experiments that are tagged with + # one or more of these tags are disabled. If an experiment is disabled, it is + # never selected nor forced. If an aggregate experiment is disabled, its + # partitions are disabled together. If an experiment with an enrollment is + # disabled, the enrollment is disabled together. # Corresponds to the JSON property `disableExpTags` # @return [Array] attr_accessor :disable_exp_tags - # Set of experiment ids to be disabled. - # If an experiment is disabled, it is never selected nor forced. - # If an aggregate experiment is disabled, its partitions are disabled - # together. If an experiment with an enrollment is disabled, the enrollment - # is disabled together. If an ID corresponds to a domain, the domain itself - # and all descendant experiments and domains are disabled together. + # Set of experiment ids to be disabled. If an experiment is disabled, it is + # never selected nor forced. If an aggregate experiment is disabled, its + # partitions are disabled together. If an experiment with an enrollment is + # disabled, the enrollment is disabled together. If an ID corresponds to a + # domain, the domain itself and all descendant experiments and domains are + # disabled together. # Corresponds to the JSON property `disableExps` # @return [Array] attr_accessor :disable_exps - # If true, disable manual enrollment selection (at all diversion points). - # Manual enrollment selection means experiment selection process based on - # the request's manual enrollment states (a.k.a. opt-in experiments). - # This does not disable selection of forced experiments. + # If true, disable manual enrollment selection (at all diversion points). Manual + # enrollment selection means experiment selection process based on the request's + # manual enrollment states (a.k.a. opt-in experiments). This does not disable + # selection of forced experiments. # Corresponds to the JSON property `disableManualEnrollmentSelection` # @return [Boolean] attr_accessor :disable_manual_enrollment_selection @@ -2234,24 +2051,23 @@ module Google # If true, disable organic experiment selection (at all diversion points). # Organic selection means experiment selection process based on traffic - # allocation and diversion condition evaluation. - # This does not disable selection of forced experiments. - # This is useful in cases when it is not known whether experiment selection - # behavior is responsible for a error or breakage. Disabling organic - # selection may help to isolate the cause of a given problem. + # allocation and diversion condition evaluation. This does not disable selection + # of forced experiments. This is useful in cases when it is not known whether + # experiment selection behavior is responsible for a error or breakage. + # Disabling organic selection may help to isolate the cause of a given problem. # Corresponds to the JSON property `disableOrganicSelection` # @return [Boolean] attr_accessor :disable_organic_selection alias_method :disable_organic_selection?, :disable_organic_selection - # Flags to force in a particular experiment state. - # Map from flag name to flag value. + # Flags to force in a particular experiment state. Map from flag name to flag + # value. # Corresponds to the JSON property `forcedFlags` # @return [Hash] attr_accessor :forced_flags - # Rollouts to force in a particular experiment state. - # Map from rollout name to rollout value. + # Rollouts to force in a particular experiment state. Map from rollout name to + # rollout value. # Corresponds to the JSON property `forcedRollouts` # @return [Hash] attr_accessor :forced_rollouts @@ -2279,21 +2095,21 @@ module Google end end - # Input only. - # Use this field to specify bucketing option for the histogram search response. + # Input only. Use this field to specify bucketing option for the histogram + # search response. class NumericBucketingOption include Google::Apis::Core::Hashable # Required. Two adjacent values form a histogram bucket. Values should be in # ascending order. For example, if [5, 10, 15] are provided, four buckets are - # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 - # [buckets_bound is supported. + # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 [buckets_bound is + # supported. # Corresponds to the JSON property `bucketBounds` # @return [Array] attr_accessor :bucket_bounds - # Optional. If set to true, the histogram result includes minimum/maximum - # value of the numeric field. + # Optional. If set to true, the histogram result includes minimum/maximum value + # of the numeric field. # Corresponds to the JSON property `requiresMinMax` # @return [Boolean] attr_accessor :requires_min_max @@ -2310,25 +2126,24 @@ module Google end end - # Output only. - # Custom numeric bucketing result. + # Output only. Custom numeric bucketing result. class NumericBucketingResult include Google::Apis::Core::Hashable - # Count within each bucket. Its size is the length of - # NumericBucketingOption.bucket_bounds plus 1. + # Count within each bucket. Its size is the length of NumericBucketingOption. + # bucket_bounds plus 1. # Corresponds to the JSON property `counts` # @return [Array] attr_accessor :counts - # Stores the maximum value of the numeric field. Is populated only if - # [NumericBucketingOption.requires_min_max] is set to true. + # Stores the maximum value of the numeric field. Is populated only if [ + # NumericBucketingOption.requires_min_max] is set to true. # Corresponds to the JSON property `maxValue` # @return [Float] attr_accessor :max_value - # Stores the minimum value of the numeric field. Will be populated only if - # [NumericBucketingOption.requires_min_max] is set to true. + # Stores the minimum value of the numeric field. Will be populated only if [ + # NumericBucketingOption.requires_min_max] is set to true. # Corresponds to the JSON property `minValue` # @return [Float] attr_accessor :min_value @@ -2350,47 +2165,45 @@ module Google class Operation include Google::Apis::Core::Hashable - # If the value is `false`, it means the operation is still in progress. - # If `true`, the operation is completed, and either `error` or `response` is - # available. + # If the value is `false`, it means the operation is still in progress. If `true` + # , the operation is completed, and either `error` or `response` is available. # Corresponds to the JSON property `done` # @return [Boolean] attr_accessor :done alias_method :done?, :done - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). # Corresponds to the JSON property `error` # @return [Google::Apis::JobsV3p1beta1::Status] attr_accessor :error - # Service-specific metadata associated with the operation. It typically - # contains progress information and common metadata such as create time. - # Some services might not provide such metadata. Any method that returns a - # long-running operation should document the metadata type, if any. + # Service-specific metadata associated with the operation. It typically contains + # progress information and common metadata such as create time. Some services + # might not provide such metadata. Any method that returns a long-running + # operation should document the metadata type, if any. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # The server-assigned name, which is only unique within the same service that - # originally returns it. If you use the default HTTP mapping, the - # `name` should be a resource name ending with `operations/`unique_id``. + # originally returns it. If you use the default HTTP mapping, the `name` should + # be a resource name ending with `operations/`unique_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The normal response of the operation in case of success. If the original - # method returns no data on success, such as `Delete`, the response is - # `google.protobuf.Empty`. If the original method is standard - # `Get`/`Create`/`Update`, the response should be the resource. For other - # methods, the response should have the type `XxxResponse`, where `Xxx` - # is the original method name. For example, if the original method name - # is `TakeSnapshot()`, the inferred response type is - # `TakeSnapshotResponse`. + # The normal response of the operation in case of success. If the original + # method returns no data on success, such as `Delete`, the response is `google. + # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, + # the response should be the resource. For other methods, the response should + # have the type `XxxResponse`, where `Xxx` is the original method name. For + # example, if the original method name is `TakeSnapshot()`, the inferred + # response type is `TakeSnapshotResponse`. # Corresponds to the JSON property `response` # @return [Hash] attr_accessor :response @@ -2411,73 +2224,63 @@ module Google # Represents a postal address, e.g. for postal delivery or payments addresses. # Given a postal address, a postal service can deliver items to a premise, P.O. - # Box or similar. - # It is not intended to model geographical locations (roads, towns, - # mountains). - # In typical usage an address would be created via user input or from importing - # existing data, depending on the type of process. - # Advice on address input / editing: - # - Use an i18n-ready address widget such as - # https://github.com/google/libaddressinput) - # - Users should not be presented with UI elements for input or editing of - # fields outside countries where that field is used. - # For more guidance on how to use this schema, please see: - # https://support.google.com/business/answer/6397478 + # Box or similar. It is not intended to model geographical locations (roads, + # towns, mountains). In typical usage an address would be created via user input + # or from importing existing data, depending on the type of process. Advice on + # address input / editing: - Use an i18n-ready address widget such as https:// + # github.com/google/libaddressinput) - Users should not be presented with UI + # elements for input or editing of fields outside countries where that field is + # used. For more guidance on how to use this schema, please see: https://support. + # google.com/business/answer/6397478 class PostalAddress include Google::Apis::Core::Hashable - # Unstructured address lines describing the lower levels of an address. - # Because values in address_lines do not have type information and may - # sometimes contain multiple values in a single field (e.g. - # "Austin, TX"), it is important that the line order is clear. The order of - # address lines should be "envelope order" for the country/region of the - # address. In places where this can vary (e.g. Japan), address_language is - # used to make it explicit (e.g. "ja" for large-to-small ordering and - # "ja-Latn" or "en" for small-to-large). This way, the most specific line of - # an address can be selected based on the language. - # The minimum permitted structural representation of an address consists - # of a region_code with all remaining information placed in the - # address_lines. It would be possible to format such an address very - # approximately without geocoding, but no semantic reasoning could be - # made about any of the address components until it was at least - # partially resolved. - # Creating an address only containing a region_code and address_lines, and - # then geocoding is the recommended way to handle completely unstructured - # addresses (as opposed to guessing which parts of the address should be - # localities or administrative areas). + # Unstructured address lines describing the lower levels of an address. Because + # values in address_lines do not have type information and may sometimes contain + # multiple values in a single field (e.g. "Austin, TX"), it is important that + # the line order is clear. The order of address lines should be "envelope order" + # for the country/region of the address. In places where this can vary (e.g. + # Japan), address_language is used to make it explicit (e.g. "ja" for large-to- + # small ordering and "ja-Latn" or "en" for small-to-large). This way, the most + # specific line of an address can be selected based on the language. The minimum + # permitted structural representation of an address consists of a region_code + # with all remaining information placed in the address_lines. It would be + # possible to format such an address very approximately without geocoding, but + # no semantic reasoning could be made about any of the address components until + # it was at least partially resolved. Creating an address only containing a + # region_code and address_lines, and then geocoding is the recommended way to + # handle completely unstructured addresses (as opposed to guessing which parts + # of the address should be localities or administrative areas). # Corresponds to the JSON property `addressLines` # @return [Array] attr_accessor :address_lines # Optional. Highest administrative subdivision which is used for postal - # addresses of a country or region. - # For example, this can be a state, a province, an oblast, or a prefecture. - # Specifically, for Spain this is the province and not the autonomous - # community (e.g. "Barcelona" and not "Catalonia"). - # Many countries don't use an administrative area in postal addresses. E.g. - # in Switzerland this should be left unpopulated. + # addresses of a country or region. For example, this can be a state, a province, + # an oblast, or a prefecture. Specifically, for Spain this is the province and + # not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many + # countries don't use an administrative area in postal addresses. E.g. in + # Switzerland this should be left unpopulated. # Corresponds to the JSON property `administrativeArea` # @return [String] attr_accessor :administrative_area - # Optional. BCP-47 language code of the contents of this address (if - # known). This is often the UI language of the input form or is expected - # to match one of the languages used in the address' country/region, or their - # transliterated equivalents. - # This can affect formatting in certain countries, but is not critical - # to the correctness of the data and will never affect any validation or - # other non-formatting related operations. - # If this value is not known, it should be omitted (rather than specifying a - # possibly incorrect default). + # Optional. BCP-47 language code of the contents of this address (if known). + # This is often the UI language of the input form or is expected to match one of + # the languages used in the address' country/region, or their transliterated + # equivalents. This can affect formatting in certain countries, but is not + # critical to the correctness of the data and will never affect any validation + # or other non-formatting related operations. If this value is not known, it + # should be omitted (rather than specifying a possibly incorrect default). # Examples: "zh-Hant", "ja", "ja-Latn", "en". # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code - # Optional. Generally refers to the city/town portion of the address. - # Examples: US city, IT comune, UK post town. - # In regions of the world where localities are not well defined or do not fit - # into this structure well, leave locality empty and use address_lines. + # Optional. Generally refers to the city/town portion of the address. Examples: + # US city, IT comune, UK post town. In regions of the world where localities are + # not well defined or do not fit into this structure well, leave locality empty + # and use address_lines. # Corresponds to the JSON property `locality` # @return [String] attr_accessor :locality @@ -2487,48 +2290,47 @@ module Google # @return [String] attr_accessor :organization - # Optional. Postal code of the address. Not all countries use or require - # postal codes to be present, but where they are used, they may trigger - # additional validation with other parts of the address (e.g. state/zip - # validation in the U.S.A.). + # Optional. Postal code of the address. Not all countries use or require postal + # codes to be present, but where they are used, they may trigger additional + # validation with other parts of the address (e.g. state/zip validation in the U. + # S.A.). # Corresponds to the JSON property `postalCode` # @return [String] attr_accessor :postal_code - # Optional. The recipient at the address. - # This field may, under certain circumstances, contain multiline information. - # For example, it might contain "care of" information. + # Optional. The recipient at the address. This field may, under certain + # circumstances, contain multiline information. For example, it might contain " + # care of" information. # Corresponds to the JSON property `recipients` # @return [Array] attr_accessor :recipients - # Required. CLDR region code of the country/region of the address. This - # is never inferred and it is up to the user to ensure the value is - # correct. See http://cldr.unicode.org/ and - # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - # for details. Example: "CH" for Switzerland. + # Required. CLDR region code of the country/region of the address. This is never + # inferred and it is up to the user to ensure the value is correct. See http:// + # cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/ + # territory_information.html for details. Example: "CH" for Switzerland. # Corresponds to the JSON property `regionCode` # @return [String] attr_accessor :region_code # The schema revision of the `PostalAddress`. This must be set to 0, which is - # the latest revision. - # All new revisions **must** be backward compatible with old revisions. + # the latest revision. All new revisions **must** be backward compatible with + # old revisions. # Corresponds to the JSON property `revision` # @return [Fixnum] attr_accessor :revision - # Optional. Additional, country-specific, sorting code. This is not used - # in most regions. Where it is used, the value is either a string like - # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number - # alone, representing the "sector code" (Jamaica), "delivery area indicator" - # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). + # Optional. Additional, country-specific, sorting code. This is not used in most + # regions. Where it is used, the value is either a string like "CEDEX", + # optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, + # representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) + # or "post office indicator" (e.g. Côte d'Ivoire). # Corresponds to the JSON property `sortingCode` # @return [String] attr_accessor :sorting_code - # Optional. Sublocality of the address. - # For example, this can be neighborhoods, boroughs, districts. + # Optional. Sublocality of the address. For example, this can be neighborhoods, + # boroughs, districts. # Corresponds to the JSON property `sublocality` # @return [String] attr_accessor :sublocality @@ -2553,27 +2355,21 @@ module Google end end - # Input only. - # Options for job processing. + # Input only. Options for job processing. class ProcessingOptions include Google::Apis::Core::Hashable - # Optional. If set to `true`, the service does not attempt to resolve a - # more precise address for the job. + # Optional. If set to `true`, the service does not attempt to resolve a more + # precise address for the job. # Corresponds to the JSON property `disableStreetAddressResolution` # @return [Boolean] attr_accessor :disable_street_address_resolution alias_method :disable_street_address_resolution?, :disable_street_address_resolution - # Optional. Option for job HTML content sanitization. Applied fields are: - # * description - # * applicationInfo.instruction - # * incentives - # * qualifications - # * responsibilities - # HTML tags in these fields may be stripped if sanitiazation is not - # disabled. - # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. + # Optional. Option for job HTML content sanitization. Applied fields are: * + # description * applicationInfo.instruction * incentives * qualifications * + # responsibilities HTML tags in these fields may be stripped if sanitiazation is + # not disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. # Corresponds to the JSON property `htmlSanitization` # @return [String] attr_accessor :html_sanitization @@ -2589,58 +2385,50 @@ module Google end end - # Input only. - # Meta information related to the job searcher or entity - # conducting the job search. This information is used to improve the - # performance of the service. + # Input only. Meta information related to the job searcher or entity conducting + # the job search. This information is used to improve the performance of the + # service. class RequestMetadata include Google::Apis::Core::Hashable - # Device information collected from the job seeker, candidate, or - # other entity conducting the job search. Providing this information improves - # the quality of the search results across devices. + # Device information collected from the job seeker, candidate, or other entity + # conducting the job search. Providing this information improves the quality of + # the search results across devices. # Corresponds to the JSON property `deviceInfo` # @return [Google::Apis::JobsV3p1beta1::DeviceInfo] attr_accessor :device_info # Required. The client-defined scope or source of the service call, which - # typically - # is the domain on - # which the service has been implemented and is currently being run. - # For example, if the service is being run by client Foo, Inc., on - # job board www.foo.com and career site www.bar.com, then this field is - # set to "foo.com" for use on the job board, and "bar.com" for use on the - # career site. - # If this field isn't available for some reason, send "UNKNOWN". - # Any improvements to the model for a particular tenant site rely on this - # field being set correctly to a domain. - # The maximum number of allowed characters is 255. + # typically is the domain on which the service has been implemented and is + # currently being run. For example, if the service is being run by client *Foo, + # Inc.*, on job board www.foo.com and career site www.bar.com, then this field + # is set to "foo.com" for use on the job board, and "bar.com" for use on the + # career site. If this field isn't available for some reason, send "UNKNOWN". + # Any improvements to the model for a particular tenant site rely on this field + # being set correctly to a domain. The maximum number of allowed characters is + # 255. # Corresponds to the JSON property `domain` # @return [String] attr_accessor :domain # Required. A unique session identification string. A session is defined as the - # duration of an end user's interaction with the service over a certain - # period. - # Obfuscate this field for privacy concerns before - # providing it to the service. - # If this field is not available for some reason, send "UNKNOWN". Note - # that any improvements to the model for a particular tenant - # site, rely on this field being set correctly to some unique session_id. - # The maximum number of allowed characters is 255. + # duration of an end user's interaction with the service over a certain period. + # Obfuscate this field for privacy concerns before providing it to the service. + # If this field is not available for some reason, send "UNKNOWN". Note that any + # improvements to the model for a particular tenant site, rely on this field + # being set correctly to some unique session_id. The maximum number of allowed + # characters is 255. # Corresponds to the JSON property `sessionId` # @return [String] attr_accessor :session_id - # Required. A unique user identification string, as determined by the client. - # To have the strongest positive impact on search quality - # make sure the client-level is unique. - # Obfuscate this field for privacy concerns before - # providing it to the service. - # If this field is not available for some reason, send "UNKNOWN". Note - # that any improvements to the model for a particular tenant - # site, rely on this field being set correctly to a unique user_id. - # The maximum number of allowed characters is 255. + # Required. A unique user identification string, as determined by the client. To + # have the strongest positive impact on search quality make sure the client- + # level is unique. Obfuscate this field for privacy concerns before providing it + # to the service. If this field is not available for some reason, send "UNKNOWN". + # Note that any improvements to the model for a particular tenant site, rely on + # this field being set correctly to a unique user_id. The maximum number of + # allowed characters is 255. # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id @@ -2658,13 +2446,12 @@ module Google end end - # Output only. - # Additional information returned to client, such as debugging information. + # Output only. Additional information returned to client, such as debugging + # information. class ResponseMetadata include Google::Apis::Core::Hashable - # A unique id associated with this call. - # This id is logged for tracking purposes. + # A unique id associated with this call. This id is logged for tracking purposes. # Corresponds to the JSON property `requestId` # @return [String] attr_accessor :request_id @@ -2679,63 +2466,52 @@ module Google end end - # Input only. - # The Request body of the `SearchJobs` call. + # Input only. The Request body of the `SearchJobs` call. class SearchJobsRequest include Google::Apis::Core::Hashable - # Input only. - # Custom ranking information for SearchJobsRequest. + # Input only. Custom ranking information for SearchJobsRequest. # Corresponds to the JSON property `customRankingInfo` # @return [Google::Apis::JobsV3p1beta1::CustomRankingInfo] attr_accessor :custom_ranking_info # Optional. Controls whether to disable exact keyword match on Job.job_title, - # Job.description, Job.company_display_name, Job.locations, - # Job.qualifications. When disable keyword match is turned off, a - # keyword match returns jobs that do not match given category filters when - # there are matching keywords. For example, the query "program manager," a - # result is returned even if the job posting has the title "software - # developer," which does not fall into "program manager" ontology, but does - # have "program manager" appearing in its description. - # For queries like "cloud" that does not contain title or - # location specific ontology, jobs with "cloud" keyword matches are returned - # regardless of this flag's value. - # Please use Company.keyword_searchable_custom_fields or - # Company.keyword_searchable_custom_attributes if company specific - # globally matched custom field/attribute string values is needed. Enabling - # keyword match improves recall of subsequent search requests. - # Defaults to false. + # Job.description, Job.company_display_name, Job.locations, Job.qualifications. + # When disable keyword match is turned off, a keyword match returns jobs that do + # not match given category filters when there are matching keywords. For example, + # the query "program manager," a result is returned even if the job posting has + # the title "software developer," which does not fall into "program manager" + # ontology, but does have "program manager" appearing in its description. For + # queries like "cloud" that does not contain title or location specific ontology, + # jobs with "cloud" keyword matches are returned regardless of this flag's + # value. Please use Company.keyword_searchable_custom_fields or Company. + # keyword_searchable_custom_attributes if company specific globally matched + # custom field/attribute string values is needed. Enabling keyword match + # improves recall of subsequent search requests. Defaults to false. # Corresponds to the JSON property `disableKeywordMatch` # @return [Boolean] attr_accessor :disable_keyword_match alias_method :disable_keyword_match?, :disable_keyword_match # Optional. Controls whether highly similar jobs are returned next to each other - # in - # the search results. Jobs are identified as highly similar based on - # their titles, job categories, and locations. Highly similar results are - # clustered so that only one representative job of the cluster is - # displayed to the job seeker higher up in the results, with the other jobs - # being displayed lower down in the results. - # Defaults to DiversificationLevel.SIMPLE if no value - # is specified. + # in the search results. Jobs are identified as highly similar based on their + # titles, job categories, and locations. Highly similar results are clustered so + # that only one representative job of the cluster is displayed to the job seeker + # higher up in the results, with the other jobs being displayed lower down in + # the results. Defaults to DiversificationLevel.SIMPLE if no value is specified. # Corresponds to the JSON property `diversificationLevel` # @return [String] attr_accessor :diversification_level # Optional. Controls whether to broaden the search when it produces sparse - # results. - # Broadened queries append results to the end of the matching results - # list. - # Defaults to false. + # results. Broadened queries append results to the end of the matching results + # list. Defaults to false. # Corresponds to the JSON property `enableBroadening` # @return [Boolean] attr_accessor :enable_broadening alias_method :enable_broadening?, :enable_broadening - # Input only. - # Histogram facets to be specified in SearchJobsRequest. + # Input only. Histogram facets to be specified in SearchJobsRequest. # Corresponds to the JSON property `histogramFacets` # @return [Google::Apis::JobsV3p1beta1::HistogramFacets] attr_accessor :histogram_facets @@ -2745,78 +2521,61 @@ module Google # @return [Array] attr_accessor :histogram_queries - # Input only. - # The query required to perform a search query. + # Input only. The query required to perform a search query. # Corresponds to the JSON property `jobQuery` # @return [Google::Apis::JobsV3p1beta1::JobQuery] attr_accessor :job_query - # Optional. The desired job attributes returned for jobs in the - # search response. Defaults to JobView.SMALL if no value is specified. + # Optional. The desired job attributes returned for jobs in the search response. + # Defaults to JobView.SMALL if no value is specified. # Corresponds to the JSON property `jobView` # @return [String] attr_accessor :job_view # Optional. An integer that specifies the current offset (that is, starting - # result - # location, amongst the jobs deemed by the API as relevant) in search - # results. This field is only considered if page_token is unset. - # The maximum allowed value is 5000. Otherwise an error is thrown. - # For example, 0 means to return results starting from the first matching - # job, and 10 means to return from the 11th job. This can be used for - # pagination, (for example, pageSize = 10 and offset = 10 means to return - # from the second page). + # result location, amongst the jobs deemed by the API as relevant) in search + # results. This field is only considered if page_token is unset. The maximum + # allowed value is 5000. Otherwise an error is thrown. For example, 0 means to + # return results starting from the first matching job, and 10 means to return + # from the 11th job. This can be used for pagination, (for example, pageSize = + # 10 and offset = 10 means to return from the second page). # Corresponds to the JSON property `offset` # @return [Fixnum] attr_accessor :offset - # Optional. The criteria determining how search results are sorted. Default is - # "relevance desc". - # Supported options are: - # * `"relevance desc"`: By relevance descending, as determined by the API - # algorithms. Relevance thresholding of query results is only available - # with this ordering. - # * `"posting_publish_time desc"`: By Job.posting_publish_time - # descending. - # * `"posting_update_time desc"`: By Job.posting_update_time - # descending. - # * `"title"`: By Job.title ascending. - # * `"title desc"`: By Job.title descending. - # * `"annualized_base_compensation"`: By job's - # CompensationInfo.annualized_base_compensation_range ascending. Jobs - # whose annualized base compensation is unspecified are put at the end of - # search results. - # * `"annualized_base_compensation desc"`: By job's - # CompensationInfo.annualized_base_compensation_range descending. Jobs - # whose annualized base compensation is unspecified are put at the end of - # search results. - # * `"annualized_total_compensation"`: By job's - # CompensationInfo.annualized_total_compensation_range ascending. Jobs - # whose annualized base compensation is unspecified are put at the end of - # search results. - # * `"annualized_total_compensation desc"`: By job's - # CompensationInfo.annualized_total_compensation_range descending. Jobs - # whose annualized base compensation is unspecified are put at the end of - # search results. - # * `"custom_ranking desc"`: By the relevance score adjusted to the - # SearchJobsRequest.custom_ranking_info.ranking_expression with weight - # factor assigned by - # SearchJobsRequest.custom_ranking_info.importance_level in descending - # order. - # * Location sorting: Use the special syntax to order jobs by distance:
- # "`distance_from('Hawaii')`": Order by distance from Hawaii.
- # "`distance_from(19.89, 155.5)`": Order by distance from a coordinate.
- # "`distance_from('Hawaii'), distance_from('Puerto Rico')`": Order by - # multiple locations. See details below.
- # "`distance_from('Hawaii'), distance_from(19.89, 155.5)`": Order by - # multiple locations. See details below.
- # The string can have a maximum of 256 characters. When multiple distance - # centers are provided, a job that is close to any of the distance centers - # would have a high rank. When a job has multiple locations, the job location - # closest to one of the distance centers will be used. Jobs that don't have - # locations will be ranked at the bottom. Distance is calculated with a - # precision of 11.3 meters (37.4 feet). Diversification strategy is still - # applied unless explicitly disabled in + # Optional. The criteria determining how search results are sorted. Default is " + # relevance desc". Supported options are: * `"relevance desc"`: By relevance + # descending, as determined by the API algorithms. Relevance thresholding of + # query results is only available with this ordering. * `"posting_publish_time + # desc"`: By Job.posting_publish_time descending. * `"posting_update_time desc"`: + # By Job.posting_update_time descending. * `"title"`: By Job.title ascending. * + # `"title desc"`: By Job.title descending. * `"annualized_base_compensation"`: + # By job's CompensationInfo.annualized_base_compensation_range ascending. Jobs + # whose annualized base compensation is unspecified are put at the end of search + # results. * `"annualized_base_compensation desc"`: By job's CompensationInfo. + # annualized_base_compensation_range descending. Jobs whose annualized base + # compensation is unspecified are put at the end of search results. * `" + # annualized_total_compensation"`: By job's CompensationInfo. + # annualized_total_compensation_range ascending. Jobs whose annualized base + # compensation is unspecified are put at the end of search results. * `" + # annualized_total_compensation desc"`: By job's CompensationInfo. + # annualized_total_compensation_range descending. Jobs whose annualized base + # compensation is unspecified are put at the end of search results. * `" + # custom_ranking desc"`: By the relevance score adjusted to the + # SearchJobsRequest.custom_ranking_info.ranking_expression with weight factor + # assigned by SearchJobsRequest.custom_ranking_info.importance_level in + # descending order. * Location sorting: Use the special syntax to order jobs by + # distance: "`distance_from('Hawaii')`": Order by distance from Hawaii. "` + # distance_from(19.89, 155.5)`": Order by distance from a coordinate. "` + # distance_from('Hawaii'), distance_from('Puerto Rico')`": Order by multiple + # locations. See details below. "`distance_from('Hawaii'), distance_from(19.89, + # 155.5)`": Order by multiple locations. See details below. The string can have + # a maximum of 256 characters. When multiple distance centers are provided, a + # job that is close to any of the distance centers would have a high rank. When + # a job has multiple locations, the job location closest to one of the distance + # centers will be used. Jobs that don't have locations will be ranked at the + # bottom. Distance is calculated with a precision of 11.3 meters (37.4 feet). + # Diversification strategy is still applied unless explicitly disabled in # diversification_level. # Corresponds to the JSON property `orderBy` # @return [String] @@ -2829,35 +2588,27 @@ module Google # @return [Fixnum] attr_accessor :page_size - # Optional. The token specifying the current offset within - # search results. See SearchJobsResponse.next_page_token for - # an explanation of how to obtain the next set of query results. + # Optional. The token specifying the current offset within search results. See + # SearchJobsResponse.next_page_token for an explanation of how to obtain the + # next set of query results. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token - # Input only. - # Meta information related to the job searcher or entity - # conducting the job search. This information is used to improve the - # performance of the service. + # Input only. Meta information related to the job searcher or entity conducting + # the job search. This information is used to improve the performance of the + # service. # Corresponds to the JSON property `requestMetadata` # @return [Google::Apis::JobsV3p1beta1::RequestMetadata] attr_accessor :request_metadata - # Optional. Controls if the search job request requires the return of a precise - # count of the first 300 results. Setting this to `true` ensures - # consistency in the number of results per page. Best practice is to set this - # value to true if a client allows users to jump directly to a - # non-sequential search results page. - # Enabling this flag may adversely impact performance. - # Defaults to false. + # This field is deprecated. # Corresponds to the JSON property `requirePreciseResultSize` # @return [Boolean] attr_accessor :require_precise_result_size alias_method :require_precise_result_size?, :require_precise_result_size - # Optional. Mode of a search. - # Defaults to SearchMode.JOB_SEARCH. + # Optional. Mode of a search. Defaults to SearchMode.JOB_SEARCH. # Corresponds to the JSON property `searchMode` # @return [String] attr_accessor :search_mode @@ -2886,45 +2637,43 @@ module Google end end - # Output only. - # Response for SearchJob method. + # Output only. Response for SearchJob method. class SearchJobsResponse include Google::Apis::Core::Hashable # If query broadening is enabled, we may append additional results from the # broadened query. This number indicates how many of the jobs returned in the - # jobs field are from the broadened query. These results are always at the - # end of the jobs list. In particular, a value of 0, or if the field isn't - # set, all the jobs in the jobs list are from the original - # (without broadening) query. If this field is non-zero, subsequent requests - # with offset after this result set should contain all broadened results. + # jobs field are from the broadened query. These results are always at the end + # of the jobs list. In particular, a value of 0, or if the field isn't set, all + # the jobs in the jobs list are from the original (without broadening) query. If + # this field is non-zero, subsequent requests with offset after this result set + # should contain all broadened results. # Corresponds to the JSON property `broadenedQueryJobsCount` # @return [Fixnum] attr_accessor :broadened_query_jobs_count - # An estimation of the number of jobs that match the specified query. - # This number is not guaranteed to be accurate. For accurate results, - # see enable_precise_result_size. + # An estimation of the number of jobs that match the specified query. This + # number is not guaranteed to be accurate. For accurate results, see + # SearchJobsResponse.total_size. # Corresponds to the JSON property `estimatedTotalSize` # @return [Fixnum] attr_accessor :estimated_total_size - # The histogram results that match with specified - # SearchJobsRequest.histogram_queries. + # The histogram results that match with specified SearchJobsRequest. + # histogram_queries. # Corresponds to the JSON property `histogramQueryResults` # @return [Array] attr_accessor :histogram_query_results - # Output only. - # Histogram results that match HistogramFacets specified in + # Output only. Histogram results that match HistogramFacets specified in # SearchJobsRequest. # Corresponds to the JSON property `histogramResults` # @return [Google::Apis::JobsV3p1beta1::HistogramResults] attr_accessor :histogram_results - # The location filters that the service applied to the specified query. If - # any filters are lat-lng based, the JobLocation.location_type is - # JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED. + # The location filters that the service applied to the specified query. If any + # filters are lat-lng based, the JobLocation.location_type is JobLocation. + # LocationType#LOCATION_TYPE_UNSPECIFIED. # Corresponds to the JSON property `locationFilters` # @return [Array] attr_accessor :location_filters @@ -2934,8 +2683,8 @@ module Google # @return [Array] attr_accessor :matching_jobs - # Output only. - # Additional information returned to client, such as debugging information. + # Output only. Additional information returned to client, such as debugging + # information. # Corresponds to the JSON property `metadata` # @return [Google::Apis::JobsV3p1beta1::ResponseMetadata] attr_accessor :metadata @@ -2946,15 +2695,12 @@ module Google # @return [String] attr_accessor :next_page_token - # Output only. - # Spell check result. + # Output only. Spell check result. # Corresponds to the JSON property `spellCorrection` # @return [Google::Apis::JobsV3p1beta1::SpellingCorrection] attr_accessor :spell_correction - # The precise result count, which is available only if the client set - # enable_precise_result_size to `true`, or if the response - # is the last page of results. Otherwise, the value is `-1`. + # The precise result count with limit 100,000. # Corresponds to the JSON property `totalSize` # @return [Fixnum] attr_accessor :total_size @@ -2978,8 +2724,7 @@ module Google end end - # Output only. - # Spell check result. + # Output only. Spell check result. class SpellingCorrection include Google::Apis::Core::Hashable @@ -3005,12 +2750,12 @@ module Google end end - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). class Status include Google::Apis::Core::Hashable @@ -3019,15 +2764,15 @@ module Google # @return [Fixnum] attr_accessor :code - # A list of messages that carry the error details. There is a common set of + # A list of messages that carry the error details. There is a common set of # message types for APIs to use. # Corresponds to the JSON property `details` # @return [Array>] attr_accessor :details - # A developer-facing error message, which should be in English. Any - # user-facing error message should be localized and sent in the - # google.rpc.Status.details field, or localized by the client. + # A developer-facing error message, which should be in English. Any user-facing + # error message should be localized and sent in the google.rpc.Status.details + # field, or localized by the client. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -3044,14 +2789,14 @@ module Google end end - # Represents a time of day. The date and time zone are either not significant - # or are specified elsewhere. An API may choose to allow leap seconds. Related + # Represents a time of day. The date and time zone are either not significant or + # are specified elsewhere. An API may choose to allow leap seconds. Related # types are google.type.Date and `google.protobuf.Timestamp`. class TimeOfDay include Google::Apis::Core::Hashable - # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose - # to allow the value "24:00:00" for scenarios like business closing time. + # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to + # allow the value "24:00:00" for scenarios like business closing time. # Corresponds to the JSON property `hours` # @return [Fixnum] attr_accessor :hours @@ -3110,8 +2855,7 @@ module Google end end - # Input only. - # Request for updating a specified company. + # Input only. Request for updating a specified company. class UpdateCompanyRequest include Google::Apis::Core::Hashable @@ -3122,12 +2866,10 @@ module Google # @return [Google::Apis::JobsV3p1beta1::Company] attr_accessor :company - # Optional but strongly recommended for the best service - # experience. - # If update_mask is provided, only the specified fields in - # company are updated. Otherwise all the fields are updated. - # A field mask to specify the company fields to be updated. Only - # top level fields of Company are supported. + # Optional but strongly recommended for the best service experience. If + # update_mask is provided, only the specified fields in company are updated. + # Otherwise all the fields are updated. A field mask to specify the company + # fields to be updated. Only top level fields of Company are supported. # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask @@ -3143,24 +2885,21 @@ module Google end end - # Input only. - # Update job request. + # Input only. Update job request. class UpdateJobRequest include Google::Apis::Core::Hashable # A Job resource represents a job posting (also referred to as a "job listing" - # or "job requisition"). A job belongs to a Company, which is the hiring - # entity responsible for the job. + # or "job requisition"). A job belongs to a Company, which is the hiring entity + # responsible for the job. # Corresponds to the JSON property `job` # @return [Google::Apis::JobsV3p1beta1::Job] attr_accessor :job # Optional but strongly recommended to be provided for the best service - # experience. - # If update_mask is provided, only the specified fields in - # job are updated. Otherwise all the fields are updated. - # A field mask to restrict the fields that are updated. Only - # top level fields of Job are supported. + # experience. If update_mask is provided, only the specified fields in job are + # updated. Otherwise all the fields are updated. A field mask to restrict the + # fields that are updated. Only top level fields of Job are supported. # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask diff --git a/generated/google/apis/jobs_v3p1beta1/service.rb b/generated/google/apis/jobs_v3p1beta1/service.rb index b2700c773..e24cfa808 100644 --- a/generated/google/apis/jobs_v3p1beta1/service.rb +++ b/generated/google/apis/jobs_v3p1beta1/service.rb @@ -48,52 +48,39 @@ module Google @batch_path = 'batch' end - # Completes the specified prefix with keyword suggestions. - # Intended for use by a job search auto-complete search box. + # Completes the specified prefix with keyword suggestions. Intended for use by a + # job search auto-complete search box. # @param [String] name - # Required. Resource name of project the completion is performed within. - # The format is "projects/`project_id`", for example, - # "projects/api-test-project". + # Required. Resource name of project the completion is performed within. The + # format is "projects/`project_id`", for example, "projects/api-test-project". # @param [String] company_name - # Optional. If provided, restricts completion to specified company. - # The format is "projects/`project_id`/companies/`company_id`", for example, - # "projects/api-test-project/companies/foo". + # Optional. If provided, restricts completion to specified company. The format + # is "projects/`project_id`/companies/`company_id`", for example, "projects/api- + # test-project/companies/foo". # @param [String] language_code - # Deprecated. Use language_codes instead. - # Optional. - # The language of the query. This is - # the BCP-47 language code, such as "en-US" or "sr-Latn". - # For more information, see - # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). - # For CompletionType.JOB_TITLE type, only open jobs with the same - # language_code are returned. - # For CompletionType.COMPANY_NAME type, - # only companies having open jobs with the same language_code are - # returned. - # For CompletionType.COMBINED type, only open jobs with the same - # language_code or companies having open jobs with the same - # language_code are returned. - # The maximum number of allowed characters is 255. + # Deprecated. Use language_codes instead. Optional. The language of the query. + # This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more + # information, see [Tags for Identifying Languages](https://tools.ietf.org/html/ + # bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same + # language_code are returned. For CompletionType.COMPANY_NAME type, only + # companies having open jobs with the same language_code are returned. For + # CompletionType.COMBINED type, only open jobs with the same language_code or + # companies having open jobs with the same language_code are returned. The + # maximum number of allowed characters is 255. # @param [Array, String] language_codes - # Optional. The list of languages of the query. This is - # the BCP-47 language code, such as "en-US" or "sr-Latn". - # For more information, see - # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). - # For CompletionType.JOB_TITLE type, only open jobs with the same - # language_codes are returned. - # For CompletionType.COMPANY_NAME type, - # only companies having open jobs with the same language_codes are - # returned. - # For CompletionType.COMBINED type, only open jobs with the same - # language_codes or companies having open jobs with the same - # language_codes are returned. - # The maximum number of allowed characters is 255. + # Optional. The list of languages of the query. This is the BCP-47 language code, + # such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying + # Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE + # type, only open jobs with the same language_codes are returned. For + # CompletionType.COMPANY_NAME type, only companies having open jobs with the + # same language_codes are returned. For CompletionType.COMBINED type, only open + # jobs with the same language_codes or companies having open jobs with the same + # language_codes are returned. The maximum number of allowed characters is 255. # @param [Fixnum] page_size - # Required. Completion result count. - # The maximum allowed page size is 10. + # Required. Completion result count. The maximum allowed page size is 10. # @param [String] query - # Required. The query used to generate suggestions. - # The maximum number of allowed characters is 255. + # Required. The query used to generate suggestions. The maximum number of + # allowed characters is 255. # @param [String] scope # Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC. # @param [String] type @@ -132,12 +119,10 @@ module Google execute_or_queue_command(command, &block) end - # Report events issued when end user interacts with customer's application - # that uses Cloud Talent Solution. You may inspect the created events in - # [self service - # tools](https://console.cloud.google.com/talent-solution/overview). - # [Learn - # more](https://cloud.google.com/talent-solution/docs/management-tools) + # Report events issued when end user interacts with customer's application that + # uses Cloud Talent Solution. You may inspect the created events in [self + # service tools](https://console.cloud.google.com/talent-solution/overview). [ + # Learn more](https://cloud.google.com/talent-solution/docs/management-tools) # about self service tools. # @param [String] parent # Parent project name. @@ -173,9 +158,8 @@ module Google # Creates a new company entity. # @param [String] parent - # Required. Resource name of the project under which the company is created. - # The format is "projects/`project_id`", for example, - # "projects/api-test-project". + # Required. Resource name of the project under which the company is created. The + # format is "projects/`project_id`", for example, "projects/api-test-project". # @param [Google::Apis::JobsV3p1beta1::CreateCompanyRequest] create_company_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -206,12 +190,12 @@ module Google execute_or_queue_command(command, &block) end - # Deletes specified company. - # Prerequisite: The company has no jobs associated with it. + # Deletes specified company. Prerequisite: The company has no jobs associated + # with it. # @param [String] name - # Required. The resource name of the company to be deleted. - # The format is "projects/`project_id`/companies/`company_id`", for example, - # "projects/api-test-project/companies/foo". + # Required. The resource name of the company to be deleted. The format is " + # projects/`project_id`/companies/`company_id`", for example, "projects/api-test- + # project/companies/foo". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -241,9 +225,9 @@ module Google # Retrieves specified company. # @param [String] name - # Required. The resource name of the company to be retrieved. - # The format is "projects/`project_id`/companies/`company_id`", for example, - # "projects/api-test-project/companies/foo". + # Required. The resource name of the company to be retrieved. The format is " + # projects/`project_id`/companies/`company_id`", for example, "projects/api-test- + # project/companies/foo". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -273,18 +257,16 @@ module Google # Lists all companies associated with the service account. # @param [String] parent - # Required. Resource name of the project under which the company is created. - # The format is "projects/`project_id`", for example, - # "projects/api-test-project". + # Required. Resource name of the project under which the company is created. The + # format is "projects/`project_id`", for example, "projects/api-test-project". # @param [Fixnum] page_size - # Optional. The maximum number of companies to be returned, at most 100. - # Default is 100 if a non-positive number is provided. + # Optional. The maximum number of companies to be returned, at most 100. Default + # is 100 if a non-positive number is provided. # @param [String] page_token # Optional. The starting indicator from which to return results. # @param [Boolean] require_open_jobs - # Optional. Set to true if the companies requested must have open jobs. - # Defaults to false. - # If true, at most page_size of companies are fetched, among which + # Optional. Set to true if the companies requested must have open jobs. Defaults + # to false. If true, at most page_size of companies are fetched, among which # only those with open jobs are returned. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -316,15 +298,14 @@ module Google execute_or_queue_command(command, &block) end - # Updates specified company. Company names can't be updated. To update a - # company name, delete the company and all jobs associated with it, and only - # then re-create them. + # Updates specified company. Company names can't be updated. To update a company + # name, delete the company and all jobs associated with it, and only then re- + # create them. # @param [String] name - # Required during company update. - # The resource name for a company. This is generated by the service when a - # company is created. - # The format is "projects/`project_id`/companies/`company_id`", for example, - # "projects/api-test-project/companies/foo". + # Required during company update. The resource name for a company. This is + # generated by the service when a company is created. The format is "projects/` + # project_id`/companies/`company_id`", for example, "projects/api-test-project/ + # companies/foo". # @param [Google::Apis::JobsV3p1beta1::UpdateCompanyRequest] update_company_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -357,9 +338,8 @@ module Google # Deletes a list of Jobs by filter. # @param [String] parent - # Required. The resource name of the project under which the job is created. - # The format is "projects/`project_id`", for example, - # "projects/api-test-project". + # Required. The resource name of the project under which the job is created. The + # format is "projects/`project_id`", for example, "projects/api-test-project". # @param [Google::Apis::JobsV3p1beta1::BatchDeleteJobsRequest] batch_delete_jobs_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -390,13 +370,11 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new job. - # Typically, the job becomes searchable within 10 seconds, but it may take - # up to 5 minutes. + # Creates a new job. Typically, the job becomes searchable within 10 seconds, + # but it may take up to 5 minutes. # @param [String] parent - # Required. The resource name of the project under which the job is created. - # The format is "projects/`project_id`", for example, - # "projects/api-test-project". + # Required. The resource name of the project under which the job is created. The + # format is "projects/`project_id`", for example, "projects/api-test-project". # @param [Google::Apis::JobsV3p1beta1::CreateJobRequest] create_job_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -427,13 +405,11 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified job. - # Typically, the job becomes unsearchable within 10 seconds, but it may take - # up to 5 minutes. + # Deletes the specified job. Typically, the job becomes unsearchable within 10 + # seconds, but it may take up to 5 minutes. # @param [String] name - # Required. The resource name of the job to be deleted. - # The format is "projects/`project_id`/jobs/`job_id`", - # for example, "projects/api-test-project/jobs/1234". + # Required. The resource name of the job to be deleted. The format is "projects/` + # project_id`/jobs/`job_id`", for example, "projects/api-test-project/jobs/1234". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -461,12 +437,11 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the specified job, whose status is OPEN or recently EXPIRED - # within the last 90 days. + # Retrieves the specified job, whose status is OPEN or recently EXPIRED within + # the last 90 days. # @param [String] name - # Required. The resource name of the job to retrieve. - # The format is "projects/`project_id`/jobs/`job_id`", - # for example, "projects/api-test-project/jobs/1234". + # Required. The resource name of the job to retrieve. The format is "projects/` + # project_id`/jobs/`job_id`", for example, "projects/api-test-project/jobs/1234". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -496,28 +471,22 @@ module Google # Lists jobs by filter. # @param [String] parent - # Required. The resource name of the project under which the job is created. - # The format is "projects/`project_id`", for example, - # "projects/api-test-project". + # Required. The resource name of the project under which the job is created. The + # format is "projects/`project_id`", for example, "projects/api-test-project". # @param [String] filter - # Required. The filter string specifies the jobs to be enumerated. - # Supported operator: =, AND - # The fields eligible for filtering are: - # * `companyName` (Required) - # * `requisitionId` (Optional) - # Sample Query: - # * companyName = "projects/api-test-project/companies/123" - # * companyName = "projects/api-test-project/companies/123" AND requisitionId - # = "req-1" + # Required. The filter string specifies the jobs to be enumerated. Supported + # operator: =, AND The fields eligible for filtering are: * `companyName` ( + # Required) * `requisitionId` (Optional) Sample Query: * companyName = "projects/ + # api-test-project/companies/123" * companyName = "projects/api-test-project/ + # companies/123" AND requisitionId = "req-1" # @param [String] job_view - # Optional. The desired job attributes returned for jobs in the - # search response. Defaults to JobView.JOB_VIEW_FULL if no value is - # specified. + # Optional. The desired job attributes returned for jobs in the search response. + # Defaults to JobView.JOB_VIEW_FULL if no value is specified. # @param [Fixnum] page_size - # Optional. The maximum number of jobs to be returned per page of results. - # If job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed - # page size is 1000. Otherwise, the maximum allowed page size is 100. - # Default is 100 if empty or a number < 1 is specified. + # Optional. The maximum number of jobs to be returned per page of results. If + # job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed page size is + # 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty + # or a number < 1 is specified. # @param [String] page_token # Optional. The starting point of a query result. # @param [String] fields @@ -551,16 +520,13 @@ module Google execute_or_queue_command(command, &block) end - # Updates specified job. - # Typically, updated contents become visible in search results within 10 - # seconds, but it may take up to 5 minutes. + # Updates specified job. Typically, updated contents become visible in search + # results within 10 seconds, but it may take up to 5 minutes. # @param [String] name - # Required during job update. - # The resource name for the job. This is generated by the service when a - # job is created. - # The format is "projects/`project_id`/jobs/`job_id`", - # for example, "projects/api-test-project/jobs/1234". - # Use of this field in job queries and API calls is preferred over the use of + # Required during job update. The resource name for the job. This is generated + # by the service when a job is created. The format is "projects/`project_id`/ + # jobs/`job_id`", for example, "projects/api-test-project/jobs/1234". Use of + # this field in job queries and API calls is preferred over the use of # requisition_id since this value is unique. # @param [Google::Apis::JobsV3p1beta1::UpdateJobRequest] update_job_request_object # @param [String] fields @@ -592,14 +558,12 @@ module Google execute_or_queue_command(command, &block) end - # Searches for jobs using the provided SearchJobsRequest. - # This call constrains the visibility of jobs - # present in the database, and only returns jobs that the caller has - # permission to search against. + # Searches for jobs using the provided SearchJobsRequest. This call constrains + # the visibility of jobs present in the database, and only returns jobs that the + # caller has permission to search against. # @param [String] parent - # Required. The resource name of the project to search within. - # The format is "projects/`project_id`", for example, - # "projects/api-test-project". + # Required. The resource name of the project to search within. The format is " + # projects/`project_id`", for example, "projects/api-test-project". # @param [Google::Apis::JobsV3p1beta1::SearchJobsRequest] search_jobs_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -630,18 +594,16 @@ module Google execute_or_queue_command(command, &block) end - # Searches for jobs using the provided SearchJobsRequest. - # This API call is intended for the use case of targeting passive job - # seekers (for example, job seekers who have signed up to receive email - # alerts about potential job opportunities), and has different algorithmic - # adjustments that are targeted to passive job seekers. - # This call constrains the visibility of jobs - # present in the database, and only returns jobs the caller has - # permission to search against. + # Searches for jobs using the provided SearchJobsRequest. This API call is + # intended for the use case of targeting passive job seekers (for example, job + # seekers who have signed up to receive email alerts about potential job + # opportunities), and has different algorithmic adjustments that are targeted to + # passive job seekers. This call constrains the visibility of jobs present in + # the database, and only returns jobs the caller has permission to search + # against. # @param [String] parent - # Required. The resource name of the project to search within. - # The format is "projects/`project_id`", for example, - # "projects/api-test-project". + # Required. The resource name of the project to search within. The format is " + # projects/`project_id`", for example, "projects/api-test-project". # @param [Google::Apis::JobsV3p1beta1::SearchJobsRequest] search_jobs_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -672,9 +634,8 @@ module Google execute_or_queue_command(command, &block) end - # Gets the latest state of a long-running operation. Clients can use this - # method to poll the operation result at intervals as recommended by the API - # service. + # Gets the latest state of a long-running operation. Clients can use this method + # to poll the operation result at intervals as recommended by the API service. # @param [String] name # The name of the operation resource. # @param [String] fields diff --git a/generated/google/apis/managedidentities_v1alpha1.rb b/generated/google/apis/managedidentities_v1alpha1.rb index 91be2b31e..35ce0b4a5 100644 --- a/generated/google/apis/managedidentities_v1alpha1.rb +++ b/generated/google/apis/managedidentities_v1alpha1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/managed-microsoft-ad/ module ManagedidentitiesV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200727' + REVISION = '20200824' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/managedidentities_v1alpha1/classes.rb b/generated/google/apis/managedidentities_v1alpha1/classes.rb index 5637b694f..4eaf6f1fe 100644 --- a/generated/google/apis/managedidentities_v1alpha1/classes.rb +++ b/generated/google/apis/managedidentities_v1alpha1/classes.rb @@ -154,6 +154,13 @@ module Google class Domain include Google::Apis::Core::Hashable + # Optional. Configuration for audit logs. True if audit logs are enabled, else + # false. Default is audit logs disabled. + # Corresponds to the JSON property `auditLogsEnabled` + # @return [Boolean] + attr_accessor :audit_logs_enabled + alias_method :audit_logs_enabled?, :audit_logs_enabled + # Optional. The full names of the Google Compute Engine [networks](/compute/docs/ # networks-and-firewalls#networks) to which the instance is connected. Network # can be added using UpdateDomain later. Domain is only available on network @@ -236,6 +243,7 @@ module Google # Update properties of this object def update!(**args) + @audit_logs_enabled = args[:audit_logs_enabled] if args.key?(:audit_logs_enabled) @authorized_networks = args[:authorized_networks] if args.key?(:authorized_networks) @create_time = args[:create_time] if args.key?(:create_time) @fqdn = args[:fqdn] if args.key?(:fqdn) diff --git a/generated/google/apis/managedidentities_v1alpha1/representations.rb b/generated/google/apis/managedidentities_v1alpha1/representations.rb index ce497b5f4..50e7e1dce 100644 --- a/generated/google/apis/managedidentities_v1alpha1/representations.rb +++ b/generated/google/apis/managedidentities_v1alpha1/representations.rb @@ -261,6 +261,7 @@ module Google class Domain # @private class Representation < Google::Apis::Core::JsonRepresentation + property :audit_logs_enabled, as: 'auditLogsEnabled' collection :authorized_networks, as: 'authorizedNetworks' property :create_time, as: 'createTime' property :fqdn, as: 'fqdn' diff --git a/generated/google/apis/managedidentities_v1beta1.rb b/generated/google/apis/managedidentities_v1beta1.rb index 235e88e2d..8583f5885 100644 --- a/generated/google/apis/managedidentities_v1beta1.rb +++ b/generated/google/apis/managedidentities_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/managed-microsoft-ad/ module ManagedidentitiesV1beta1 VERSION = 'V1beta1' - REVISION = '20200727' + REVISION = '20200824' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/managedidentities_v1beta1/classes.rb b/generated/google/apis/managedidentities_v1beta1/classes.rb index cf672f01c..dcc361b36 100644 --- a/generated/google/apis/managedidentities_v1beta1/classes.rb +++ b/generated/google/apis/managedidentities_v1beta1/classes.rb @@ -156,6 +156,13 @@ module Google # @return [String] attr_accessor :admin + # Optional. Configuration for audit logs. True if audit logs are enabled, else + # false. Default is audit logs disabled. + # Corresponds to the JSON property `auditLogsEnabled` + # @return [Boolean] + attr_accessor :audit_logs_enabled + alias_method :audit_logs_enabled?, :audit_logs_enabled + # Optional. The full names of the Google Compute Engine [networks](/compute/docs/ # networks-and-firewalls#networks) the domain instance is connected to. Networks # can be added using UpdateDomain. The domain is only available on networks @@ -230,6 +237,7 @@ module Google # Update properties of this object def update!(**args) @admin = args[:admin] if args.key?(:admin) + @audit_logs_enabled = args[:audit_logs_enabled] if args.key?(:audit_logs_enabled) @authorized_networks = args[:authorized_networks] if args.key?(:authorized_networks) @create_time = args[:create_time] if args.key?(:create_time) @fqdn = args[:fqdn] if args.key?(:fqdn) diff --git a/generated/google/apis/managedidentities_v1beta1/representations.rb b/generated/google/apis/managedidentities_v1beta1/representations.rb index 78548bb89..8236ce385 100644 --- a/generated/google/apis/managedidentities_v1beta1/representations.rb +++ b/generated/google/apis/managedidentities_v1beta1/representations.rb @@ -262,6 +262,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :admin, as: 'admin' + property :audit_logs_enabled, as: 'auditLogsEnabled' collection :authorized_networks, as: 'authorizedNetworks' property :create_time, as: 'createTime' property :fqdn, as: 'fqdn' diff --git a/generated/google/apis/ml_v1.rb b/generated/google/apis/ml_v1.rb index 43fe98029..cceca02c4 100644 --- a/generated/google/apis/ml_v1.rb +++ b/generated/google/apis/ml_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/ml/ module MlV1 VERSION = 'V1' - REVISION = '20200821' + REVISION = '20200905' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/ml_v1/classes.rb b/generated/google/apis/ml_v1/classes.rb index e37d773e1..a1a5cbf7a 100644 --- a/generated/google/apis/ml_v1/classes.rb +++ b/generated/google/apis/ml_v1/classes.rb @@ -3120,6 +3120,12 @@ module Google class GoogleIamV1Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: @@ -3181,6 +3187,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) diff --git a/generated/google/apis/ml_v1/representations.rb b/generated/google/apis/ml_v1/representations.rb index 27f96b74f..49c7fe979 100644 --- a/generated/google/apis/ml_v1/representations.rb +++ b/generated/google/apis/ml_v1/representations.rb @@ -1276,6 +1276,7 @@ module Google class GoogleIamV1Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::MlV1::GoogleTypeExpr, decorator: Google::Apis::MlV1::GoogleTypeExpr::Representation collection :members, as: 'members' diff --git a/generated/google/apis/ml_v1/service.rb b/generated/google/apis/ml_v1/service.rb index 1b53c4a68..9e3308770 100644 --- a/generated/google/apis/ml_v1/service.rb +++ b/generated/google/apis/ml_v1/service.rb @@ -983,7 +983,7 @@ module Google end # Adds one or more trials to a study, with parameter values suggested by AI - # Platform Optimizer. Returns a long-running operation associated with the + # Platform Vizier. Returns a long-running operation associated with the # generation of trial suggestions. When this long-running operation succeeds, it # will contain a SuggestTrialsResponse. # @param [String] parent diff --git a/generated/google/apis/monitoring_v1.rb b/generated/google/apis/monitoring_v1.rb index 033f87c18..6b4f6cca4 100644 --- a/generated/google/apis/monitoring_v1.rb +++ b/generated/google/apis/monitoring_v1.rb @@ -29,7 +29,7 @@ module Google # @see https://cloud.google.com/monitoring/api/ module MonitoringV1 VERSION = 'V1' - REVISION = '20200827' + REVISION = '20200829' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/monitoring_v1/classes.rb b/generated/google/apis/monitoring_v1/classes.rb index c314556fd..d0aba4537 100644 --- a/generated/google/apis/monitoring_v1/classes.rb +++ b/generated/google/apis/monitoring_v1/classes.rb @@ -530,7 +530,8 @@ module Google class MosaicLayout include Google::Apis::Core::Hashable - # The number of columns in the mosaic grid. + # The number of columns in the mosaic grid. The number of columns must be + # between 1 and 12, inclusive. # Corresponds to the JSON property `columns` # @return [Fixnum] attr_accessor :columns @@ -947,7 +948,8 @@ module Google class Tile include Google::Apis::Core::Hashable - # The height of the tile, measured in grid squares. + # The height of the tile, measured in grid squares. Tiles must have a minimum + # height of 1. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height @@ -958,19 +960,21 @@ module Google # @return [Google::Apis::MonitoringV1::Widget] attr_accessor :widget - # The width of the tile, measured in grid squares. + # The width of the tile, measured in grid squares. Tiles must have a minimum + # width of 1. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width # The zero-indexed position of the tile in grid squares relative to the left - # edge of the grid. + # edge of the grid. Tiles must be contained within the specified number of + # columns. x_pos cannot be negative. # Corresponds to the JSON property `xPos` # @return [Fixnum] attr_accessor :x_pos # The zero-indexed position of the tile in grid squares relative to the top edge - # of the grid. + # of the grid. y_pos cannot be negative. # Corresponds to the JSON property `yPos` # @return [Fixnum] attr_accessor :y_pos diff --git a/generated/google/apis/osconfig_v1.rb b/generated/google/apis/osconfig_v1.rb index bf876df47..9b59ff15c 100644 --- a/generated/google/apis/osconfig_v1.rb +++ b/generated/google/apis/osconfig_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/ module OsconfigV1 VERSION = 'V1' - REVISION = '20200824' + REVISION = '20200903' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/osconfig_v1/classes.rb b/generated/google/apis/osconfig_v1/classes.rb index fc5a38f04..9d25c112a 100644 --- a/generated/google/apis/osconfig_v1/classes.rb +++ b/generated/google/apis/osconfig_v1/classes.rb @@ -87,74 +87,6 @@ module Google end end - # A resource that contains custom validation and enforcement steps. - class ExecResource - include Google::Apis::Core::Hashable - - # A file or script to execute. - # Corresponds to the JSON property `enforce` - # @return [Google::Apis::OsconfigV1::ExecResourceExec] - attr_accessor :enforce - - # A file or script to execute. - # Corresponds to the JSON property `validate` - # @return [Google::Apis::OsconfigV1::ExecResourceExec] - attr_accessor :validate - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @enforce = args[:enforce] if args.key?(:enforce) - @validate = args[:validate] if args.key?(:validate) - end - end - - # A file or script to execute. - class ExecResourceExec - include Google::Apis::Core::Hashable - - # Exit codes that indicate success. - # Corresponds to the JSON property `allowedSuccessCodes` - # @return [Array] - attr_accessor :allowed_success_codes - - # Arguments to use. - # Corresponds to the JSON property `args` - # @return [Array] - attr_accessor :args - - # A remote or local file. - # Corresponds to the JSON property `file` - # @return [Google::Apis::OsconfigV1::File] - attr_accessor :file - - # The script interpreter to use. - # Corresponds to the JSON property `interpreter` - # @return [String] - attr_accessor :interpreter - - # An inline script. - # Corresponds to the JSON property `script` - # @return [String] - attr_accessor :script - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @allowed_success_codes = args[:allowed_success_codes] if args.key?(:allowed_success_codes) - @args = args[:args] if args.key?(:args) - @file = args[:file] if args.key?(:file) - @interpreter = args[:interpreter] if args.key?(:interpreter) - @script = args[:script] if args.key?(:script) - end - end - # A step that runs an executable for a PatchJob. class ExecStep include Google::Apis::Core::Hashable @@ -282,200 +214,6 @@ module Google end end - # A resource that extracts an archive - class ExtractArchiveResource - include Google::Apis::Core::Hashable - - # Local file path that signals this resource is in the desired state. The - # absence of this file will indicate whether the archive needs to be extracted. - # Corresponds to the JSON property `creates` - # @return [String] - attr_accessor :creates - - # Directory to extract archive to. - # Corresponds to the JSON property `destination` - # @return [String] - attr_accessor :destination - - # Whether to overwrite existing files during extraction. If this is set to true, - # any existing files in the destination location will be overwritten by the - # extraction. - # Corresponds to the JSON property `overwrite` - # @return [Boolean] - attr_accessor :overwrite - alias_method :overwrite?, :overwrite - - # A remote or local file. - # Corresponds to the JSON property `source` - # @return [Google::Apis::OsconfigV1::File] - attr_accessor :source - - # The type of the archive to extract. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @creates = args[:creates] if args.key?(:creates) - @destination = args[:destination] if args.key?(:destination) - @overwrite = args[:overwrite] if args.key?(:overwrite) - @source = args[:source] if args.key?(:source) - @type = args[:type] if args.key?(:type) - end - end - - # A remote or local file. - class File - include Google::Apis::Core::Hashable - - # Defaults to false. When false, files will be subject to validations based on - # the file type: Remote: A checksum must be specified. GCS: An object generation - # number must be specified. - # Corresponds to the JSON property `allowInsecure` - # @return [Boolean] - attr_accessor :allow_insecure - alias_method :allow_insecure?, :allow_insecure - - # Specifies a file available as a GCS Object. - # Corresponds to the JSON property `gcs` - # @return [Google::Apis::OsconfigV1::FileGcs] - attr_accessor :gcs - - # A local path to use. - # Corresponds to the JSON property `localPath` - # @return [String] - attr_accessor :local_path - - # Specifies a file available via some URI. - # Corresponds to the JSON property `remote` - # @return [Google::Apis::OsconfigV1::FileRemote] - attr_accessor :remote - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @allow_insecure = args[:allow_insecure] if args.key?(:allow_insecure) - @gcs = args[:gcs] if args.key?(:gcs) - @local_path = args[:local_path] if args.key?(:local_path) - @remote = args[:remote] if args.key?(:remote) - end - end - - # Specifies a file available as a GCS Object. - class FileGcs - include Google::Apis::Core::Hashable - - # Bucket of the GCS object. - # Corresponds to the JSON property `bucket` - # @return [String] - attr_accessor :bucket - - # Generation number of the GCS object. - # Corresponds to the JSON property `generation` - # @return [Fixnum] - attr_accessor :generation - - # Name of the GCS object. - # Corresponds to the JSON property `object` - # @return [String] - attr_accessor :object - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @bucket = args[:bucket] if args.key?(:bucket) - @generation = args[:generation] if args.key?(:generation) - @object = args[:object] if args.key?(:object) - end - end - - # Specifies a file available via some URI. - class FileRemote - include Google::Apis::Core::Hashable - - # SHA256 checksum of the remote file. - # Corresponds to the JSON property `sha256Checksum` - # @return [String] - attr_accessor :sha256_checksum - - # URI from which to fetch the object. It should contain both the protocol and - # path following the format `protocol`://`location`. - # Corresponds to the JSON property `uri` - # @return [String] - attr_accessor :uri - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @sha256_checksum = args[:sha256_checksum] if args.key?(:sha256_checksum) - @uri = args[:uri] if args.key?(:uri) - end - end - - # A resource that manages the state of a file. - class FileResource - include Google::Apis::Core::Hashable - - # A a file with this content. - # Corresponds to the JSON property `content` - # @return [String] - attr_accessor :content - - # A remote or local file. - # Corresponds to the JSON property `file` - # @return [Google::Apis::OsconfigV1::File] - attr_accessor :file - - # The absolute path of the file. - # Corresponds to the JSON property `path` - # @return [String] - attr_accessor :path - - # Consists of three octal digits which represent, in order, the permissions of - # the owner, group, and other users for the file (similarly to the numeric mode - # used in the linux chmod utility). Each digit represents a three bit number - # with the 4 bit corresponding to the read permissions, the 2 bit corresponds to - # the write bit, and the one bit corresponds to the execute permission. Default - # behavior is 755. Below are some examples of permissions and their associated - # values: read, write, and execute: 7 read and execute: 5 read and write: 6 read - # only: 4 - # Corresponds to the JSON property `permissions` - # @return [String] - attr_accessor :permissions - - # Desired state of the file. - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @content = args[:content] if args.key?(:content) - @file = args[:file] if args.key?(:file) - @path = args[:path] if args.key?(:path) - @permissions = args[:permissions] if args.key?(:permissions) - @state = args[:state] if args.key?(:state) - end - end - # Message encapsulating a value that can be either absolute ("fixed") or # relative ("percent") to a value. class FixedOrPercent @@ -672,242 +410,6 @@ module Google end end - # A resource that manages a system package. - class PackageResource - include Google::Apis::Core::Hashable - - # A package managed by APT. install: `apt-get update && apt-get -y install [name] - # ` remove: `apt-get -y remove [name]` - # Corresponds to the JSON property `apt` - # @return [Google::Apis::OsconfigV1::PackageResourceApt] - attr_accessor :apt - - # A deb package file. dpkg packages only support INSTALLED state. - # Corresponds to the JSON property `deb` - # @return [Google::Apis::OsconfigV1::PackageResourceDeb] - attr_accessor :deb - - # The desired_state the agent should maintain for this package. The default is - # to ensure the package is installed. - # Corresponds to the JSON property `desiredState` - # @return [String] - attr_accessor :desired_state - - # A package managed by GooGet. install: `googet -noconfirm install package` - # remove: `googet -noconfirm remove package` - # Corresponds to the JSON property `googet` - # @return [Google::Apis::OsconfigV1::PackageResourceGooGet] - attr_accessor :googet - - # An MSI package. MSI packages only support INSTALLED state. Install msiexec /i / - # qn /norestart - # Corresponds to the JSON property `msi` - # @return [Google::Apis::OsconfigV1::PackageResourceMsi] - attr_accessor :msi - - # An RPM package file. RPM packages only support INSTALLED state. - # Corresponds to the JSON property `rpm` - # @return [Google::Apis::OsconfigV1::PackageResourceRpm] - attr_accessor :rpm - - # A package managed by YUM. install: `yum -y install package` remove: `yum -y - # remove package` - # Corresponds to the JSON property `yum` - # @return [Google::Apis::OsconfigV1::PackageResourceYum] - attr_accessor :yum - - # A package managed by Zypper. install: `zypper -y install package` remove: ` - # zypper -y rm package` - # Corresponds to the JSON property `zypper` - # @return [Google::Apis::OsconfigV1::PackageResourceZypper] - attr_accessor :zypper - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @apt = args[:apt] if args.key?(:apt) - @deb = args[:deb] if args.key?(:deb) - @desired_state = args[:desired_state] if args.key?(:desired_state) - @googet = args[:googet] if args.key?(:googet) - @msi = args[:msi] if args.key?(:msi) - @rpm = args[:rpm] if args.key?(:rpm) - @yum = args[:yum] if args.key?(:yum) - @zypper = args[:zypper] if args.key?(:zypper) - end - end - - # A package managed by APT. install: `apt-get update && apt-get -y install [name] - # ` remove: `apt-get -y remove [name]` - class PackageResourceApt - include Google::Apis::Core::Hashable - - # Package name. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @name = args[:name] if args.key?(:name) - end - end - - # A deb package file. dpkg packages only support INSTALLED state. - class PackageResourceDeb - include Google::Apis::Core::Hashable - - # Whether dependencies should also be installed. install when false: `dpkg -i - # package` install when true: `apt-get update && apt-get -y install package.deb` - # Corresponds to the JSON property `pullDeps` - # @return [Boolean] - attr_accessor :pull_deps - alias_method :pull_deps?, :pull_deps - - # A remote or local file. - # Corresponds to the JSON property `source` - # @return [Google::Apis::OsconfigV1::File] - attr_accessor :source - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @pull_deps = args[:pull_deps] if args.key?(:pull_deps) - @source = args[:source] if args.key?(:source) - end - end - - # A package managed by GooGet. install: `googet -noconfirm install package` - # remove: `googet -noconfirm remove package` - class PackageResourceGooGet - include Google::Apis::Core::Hashable - - # Package name. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @name = args[:name] if args.key?(:name) - end - end - - # An MSI package. MSI packages only support INSTALLED state. Install msiexec /i / - # qn /norestart - class PackageResourceMsi - include Google::Apis::Core::Hashable - - # Return codes that indicate that the software installed or updated successfully. - # Behaviour defaults to [0] - # Corresponds to the JSON property `allowedSuccessCodes` - # @return [Array] - attr_accessor :allowed_success_codes - - # Flags to use during package install. Appended to the defalts of "/i /qn / - # norestart" - # Corresponds to the JSON property `flags` - # @return [Array] - attr_accessor :flags - - # A remote or local file. - # Corresponds to the JSON property `source` - # @return [Google::Apis::OsconfigV1::File] - attr_accessor :source - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @allowed_success_codes = args[:allowed_success_codes] if args.key?(:allowed_success_codes) - @flags = args[:flags] if args.key?(:flags) - @source = args[:source] if args.key?(:source) - end - end - - # An RPM package file. RPM packages only support INSTALLED state. - class PackageResourceRpm - include Google::Apis::Core::Hashable - - # Whether dependencies should also be installed. install when false: `rpm -- - # upgrade --replacepkgs package.rpm` install when true: `yum -y install package. - # rpm` or `zypper -y install package.rpm` - # Corresponds to the JSON property `pullDeps` - # @return [Boolean] - attr_accessor :pull_deps - alias_method :pull_deps?, :pull_deps - - # A remote or local file. - # Corresponds to the JSON property `source` - # @return [Google::Apis::OsconfigV1::File] - attr_accessor :source - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @pull_deps = args[:pull_deps] if args.key?(:pull_deps) - @source = args[:source] if args.key?(:source) - end - end - - # A package managed by YUM. install: `yum -y install package` remove: `yum -y - # remove package` - class PackageResourceYum - include Google::Apis::Core::Hashable - - # Package name. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @name = args[:name] if args.key?(:name) - end - end - - # A package managed by Zypper. install: `zypper -y install package` remove: ` - # zypper -y rm package` - class PackageResourceZypper - include Google::Apis::Core::Hashable - - # Package name. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @name = args[:name] if args.key?(:name) - end - end - # Patch configuration specifications. Contains details on how to apply the patch( # es) to a VM instance. class PatchConfig @@ -1522,212 +1024,6 @@ module Google end end - # A resource that manages a package repository. - class RepositoryResource - include Google::Apis::Core::Hashable - - # Represents a single apt package repository. These will be added to a repo file - # that will be managed at /etc/apt/sources.list.d/google_osconfig.list. - # Corresponds to the JSON property `apt` - # @return [Google::Apis::OsconfigV1::RepositoryResourceAptRepository] - attr_accessor :apt - - # Represents a Goo package repository. These will be added to a repo file that - # will be managed at C:/ProgramData/GooGet/repos/google_osconfig.repo. - # Corresponds to the JSON property `goo` - # @return [Google::Apis::OsconfigV1::RepositoryResourceGooRepository] - attr_accessor :goo - - # Represents a single yum package repository. These will be added to a repo file - # that will be managed at /etc/yum.repos.d/google_osconfig.repo. - # Corresponds to the JSON property `yum` - # @return [Google::Apis::OsconfigV1::RepositoryResourceYumRepository] - attr_accessor :yum - - # Represents a single zypper package repository. These will be added to a repo - # file that will be managed at /etc/zypp/repos.d/google_osconfig.repo. - # Corresponds to the JSON property `zypper` - # @return [Google::Apis::OsconfigV1::RepositoryResourceZypperRepository] - attr_accessor :zypper - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @apt = args[:apt] if args.key?(:apt) - @goo = args[:goo] if args.key?(:goo) - @yum = args[:yum] if args.key?(:yum) - @zypper = args[:zypper] if args.key?(:zypper) - end - end - - # Represents a single apt package repository. These will be added to a repo file - # that will be managed at /etc/apt/sources.list.d/google_osconfig.list. - class RepositoryResourceAptRepository - include Google::Apis::Core::Hashable - - # Type of archive files in this repository. The default behavior is DEB. - # Corresponds to the JSON property `archiveType` - # @return [String] - attr_accessor :archive_type - - # List of components for this repository. Must contain at least one item. - # Corresponds to the JSON property `components` - # @return [Array] - attr_accessor :components - - # Distribution of this repository. - # Corresponds to the JSON property `distribution` - # @return [String] - attr_accessor :distribution - - # URI of the key file for this repository. The agent will maintain a keyring at / - # etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg. - # Corresponds to the JSON property `gpgKey` - # @return [String] - attr_accessor :gpg_key - - # URI for this repository. - # Corresponds to the JSON property `uri` - # @return [String] - attr_accessor :uri - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @archive_type = args[:archive_type] if args.key?(:archive_type) - @components = args[:components] if args.key?(:components) - @distribution = args[:distribution] if args.key?(:distribution) - @gpg_key = args[:gpg_key] if args.key?(:gpg_key) - @uri = args[:uri] if args.key?(:uri) - end - end - - # Represents a Goo package repository. These will be added to a repo file that - # will be managed at C:/ProgramData/GooGet/repos/google_osconfig.repo. - class RepositoryResourceGooRepository - include Google::Apis::Core::Hashable - - # The name of the repository. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # The url of the repository. - # Corresponds to the JSON property `url` - # @return [String] - attr_accessor :url - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @name = args[:name] if args.key?(:name) - @url = args[:url] if args.key?(:url) - end - end - - # Represents a single yum package repository. These will be added to a repo file - # that will be managed at /etc/yum.repos.d/google_osconfig.repo. - class RepositoryResourceYumRepository - include Google::Apis::Core::Hashable - - # The location of the repository directory. - # Corresponds to the JSON property `baseUrl` - # @return [String] - attr_accessor :base_url - - # The display name of the repository. - # Corresponds to the JSON property `displayName` - # @return [String] - attr_accessor :display_name - - # URIs of GPG keys. - # Corresponds to the JSON property `gpgKeys` - # @return [Array] - attr_accessor :gpg_keys - - # A one word, unique name for this repository. This will be the `repo id` in the - # yum config file and also the `display_name` if `display_name` is omitted. This - # id is also used as the unique identifier when checking for resource conflicts. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @base_url = args[:base_url] if args.key?(:base_url) - @display_name = args[:display_name] if args.key?(:display_name) - @gpg_keys = args[:gpg_keys] if args.key?(:gpg_keys) - @id = args[:id] if args.key?(:id) - end - end - - # Represents a single zypper package repository. These will be added to a repo - # file that will be managed at /etc/zypp/repos.d/google_osconfig.repo. - class RepositoryResourceZypperRepository - include Google::Apis::Core::Hashable - - # The location of the repository directory. - # Corresponds to the JSON property `baseUrl` - # @return [String] - attr_accessor :base_url - - # The display name of the repository. - # Corresponds to the JSON property `displayName` - # @return [String] - attr_accessor :display_name - - # URIs of GPG keys. - # Corresponds to the JSON property `gpgKeys` - # @return [Array] - attr_accessor :gpg_keys - - # A one word, unique name for this repository. This will be the `repo id` in the - # zypper config file and also the `display_name` if `display_name` is omitted. - # This id is also used as the unique identifier when checking for GuestPolicy - # conflicts. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @base_url = args[:base_url] if args.key?(:base_url) - @display_name = args[:display_name] if args.key?(:display_name) - @gpg_keys = args[:gpg_keys] if args.key?(:gpg_keys) - @id = args[:id] if args.key?(:id) - end - end - - # A resource that manages a system service. - class ServiceResource - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - end - end - # Represents a time of day. The date and time zone are either not significant or # are specified elsewhere. An API may choose to allow leap seconds. Related # types are google.type.Date and `google.protobuf.Timestamp`. diff --git a/generated/google/apis/osconfig_v1/representations.rb b/generated/google/apis/osconfig_v1/representations.rb index acaab92cf..69177d359 100644 --- a/generated/google/apis/osconfig_v1/representations.rb +++ b/generated/google/apis/osconfig_v1/representations.rb @@ -40,18 +40,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class ExecResource - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ExecResourceExec - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class ExecStep class Representation < Google::Apis::Core::JsonRepresentation; end @@ -70,36 +58,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class ExtractArchiveResource - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class File - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class FileGcs - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class FileRemote - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class FileResource - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class FixedOrPercent class Representation < Google::Apis::Core::JsonRepresentation; end @@ -148,54 +106,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class PackageResource - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PackageResourceApt - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PackageResourceDeb - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PackageResourceGooGet - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PackageResourceMsi - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PackageResourceRpm - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PackageResourceYum - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PackageResourceZypper - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class PatchConfig class Representation < Google::Apis::Core::JsonRepresentation; end @@ -250,42 +160,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class RepositoryResource - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RepositoryResourceAptRepository - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RepositoryResourceGooRepository - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RepositoryResourceYumRepository - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RepositoryResourceZypperRepository - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ServiceResource - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class TimeOfDay class Representation < Google::Apis::Core::JsonRepresentation; end @@ -349,28 +223,6 @@ module Google end end - class ExecResource - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :enforce, as: 'enforce', class: Google::Apis::OsconfigV1::ExecResourceExec, decorator: Google::Apis::OsconfigV1::ExecResourceExec::Representation - - property :validate, as: 'validate', class: Google::Apis::OsconfigV1::ExecResourceExec, decorator: Google::Apis::OsconfigV1::ExecResourceExec::Representation - - end - end - - class ExecResourceExec - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :allowed_success_codes, as: 'allowedSuccessCodes' - collection :args, as: 'args' - property :file, as: 'file', class: Google::Apis::OsconfigV1::File, decorator: Google::Apis::OsconfigV1::File::Representation - - property :interpreter, as: 'interpreter' - property :script, as: 'script' - end - end - class ExecStep # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -408,59 +260,6 @@ module Google end end - class ExtractArchiveResource - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :creates, as: 'creates' - property :destination, as: 'destination' - property :overwrite, as: 'overwrite' - property :source, as: 'source', class: Google::Apis::OsconfigV1::File, decorator: Google::Apis::OsconfigV1::File::Representation - - property :type, as: 'type' - end - end - - class File - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :allow_insecure, as: 'allowInsecure' - property :gcs, as: 'gcs', class: Google::Apis::OsconfigV1::FileGcs, decorator: Google::Apis::OsconfigV1::FileGcs::Representation - - property :local_path, as: 'localPath' - property :remote, as: 'remote', class: Google::Apis::OsconfigV1::FileRemote, decorator: Google::Apis::OsconfigV1::FileRemote::Representation - - end - end - - class FileGcs - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :bucket, as: 'bucket' - property :generation, :numeric_string => true, as: 'generation' - property :object, as: 'object' - end - end - - class FileRemote - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :sha256_checksum, as: 'sha256Checksum' - property :uri, as: 'uri' - end - end - - class FileResource - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :content, as: 'content' - property :file, as: 'file', class: Google::Apis::OsconfigV1::File, decorator: Google::Apis::OsconfigV1::File::Representation - - property :path, as: 'path' - property :permissions, as: 'permissions' - property :state, as: 'state' - end - end - class FixedOrPercent # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -527,83 +326,6 @@ module Google end end - class PackageResource - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :apt, as: 'apt', class: Google::Apis::OsconfigV1::PackageResourceApt, decorator: Google::Apis::OsconfigV1::PackageResourceApt::Representation - - property :deb, as: 'deb', class: Google::Apis::OsconfigV1::PackageResourceDeb, decorator: Google::Apis::OsconfigV1::PackageResourceDeb::Representation - - property :desired_state, as: 'desiredState' - property :googet, as: 'googet', class: Google::Apis::OsconfigV1::PackageResourceGooGet, decorator: Google::Apis::OsconfigV1::PackageResourceGooGet::Representation - - property :msi, as: 'msi', class: Google::Apis::OsconfigV1::PackageResourceMsi, decorator: Google::Apis::OsconfigV1::PackageResourceMsi::Representation - - property :rpm, as: 'rpm', class: Google::Apis::OsconfigV1::PackageResourceRpm, decorator: Google::Apis::OsconfigV1::PackageResourceRpm::Representation - - property :yum, as: 'yum', class: Google::Apis::OsconfigV1::PackageResourceYum, decorator: Google::Apis::OsconfigV1::PackageResourceYum::Representation - - property :zypper, as: 'zypper', class: Google::Apis::OsconfigV1::PackageResourceZypper, decorator: Google::Apis::OsconfigV1::PackageResourceZypper::Representation - - end - end - - class PackageResourceApt - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - end - end - - class PackageResourceDeb - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :pull_deps, as: 'pullDeps' - property :source, as: 'source', class: Google::Apis::OsconfigV1::File, decorator: Google::Apis::OsconfigV1::File::Representation - - end - end - - class PackageResourceGooGet - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - end - end - - class PackageResourceMsi - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :allowed_success_codes, as: 'allowedSuccessCodes' - collection :flags, as: 'flags' - property :source, as: 'source', class: Google::Apis::OsconfigV1::File, decorator: Google::Apis::OsconfigV1::File::Representation - - end - end - - class PackageResourceRpm - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :pull_deps, as: 'pullDeps' - property :source, as: 'source', class: Google::Apis::OsconfigV1::File, decorator: Google::Apis::OsconfigV1::File::Representation - - end - end - - class PackageResourceYum - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - end - end - - class PackageResourceZypper - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - end - end - class PatchConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -751,65 +473,6 @@ module Google end end - class RepositoryResource - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :apt, as: 'apt', class: Google::Apis::OsconfigV1::RepositoryResourceAptRepository, decorator: Google::Apis::OsconfigV1::RepositoryResourceAptRepository::Representation - - property :goo, as: 'goo', class: Google::Apis::OsconfigV1::RepositoryResourceGooRepository, decorator: Google::Apis::OsconfigV1::RepositoryResourceGooRepository::Representation - - property :yum, as: 'yum', class: Google::Apis::OsconfigV1::RepositoryResourceYumRepository, decorator: Google::Apis::OsconfigV1::RepositoryResourceYumRepository::Representation - - property :zypper, as: 'zypper', class: Google::Apis::OsconfigV1::RepositoryResourceZypperRepository, decorator: Google::Apis::OsconfigV1::RepositoryResourceZypperRepository::Representation - - end - end - - class RepositoryResourceAptRepository - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :archive_type, as: 'archiveType' - collection :components, as: 'components' - property :distribution, as: 'distribution' - property :gpg_key, as: 'gpgKey' - property :uri, as: 'uri' - end - end - - class RepositoryResourceGooRepository - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - property :url, as: 'url' - end - end - - class RepositoryResourceYumRepository - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :base_url, as: 'baseUrl' - property :display_name, as: 'displayName' - collection :gpg_keys, as: 'gpgKeys' - property :id, as: 'id' - end - end - - class RepositoryResourceZypperRepository - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :base_url, as: 'baseUrl' - property :display_name, as: 'displayName' - collection :gpg_keys, as: 'gpgKeys' - property :id, as: 'id' - end - end - - class ServiceResource - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - class TimeOfDay # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/osconfig_v1beta.rb b/generated/google/apis/osconfig_v1beta.rb index 8eae3e167..5208254f1 100644 --- a/generated/google/apis/osconfig_v1beta.rb +++ b/generated/google/apis/osconfig_v1beta.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/ module OsconfigV1beta VERSION = 'V1beta' - REVISION = '20200824' + REVISION = '20200903' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/osconfig_v1beta/classes.rb b/generated/google/apis/osconfig_v1beta/classes.rb index 0cc833d3f..b846b123b 100644 --- a/generated/google/apis/osconfig_v1beta/classes.rb +++ b/generated/google/apis/osconfig_v1beta/classes.rb @@ -373,74 +373,6 @@ module Google end end - # A resource that contains custom validation and enforcement steps. - class ExecResource - include Google::Apis::Core::Hashable - - # A file or script to execute. - # Corresponds to the JSON property `enforce` - # @return [Google::Apis::OsconfigV1beta::ExecResourceExec] - attr_accessor :enforce - - # A file or script to execute. - # Corresponds to the JSON property `validate` - # @return [Google::Apis::OsconfigV1beta::ExecResourceExec] - attr_accessor :validate - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @enforce = args[:enforce] if args.key?(:enforce) - @validate = args[:validate] if args.key?(:validate) - end - end - - # A file or script to execute. - class ExecResourceExec - include Google::Apis::Core::Hashable - - # Exit codes that indicate success. - # Corresponds to the JSON property `allowedSuccessCodes` - # @return [Array] - attr_accessor :allowed_success_codes - - # Arguments to use. - # Corresponds to the JSON property `args` - # @return [Array] - attr_accessor :args - - # A remote or local file. - # Corresponds to the JSON property `file` - # @return [Google::Apis::OsconfigV1beta::File] - attr_accessor :file - - # The script interpreter to use. - # Corresponds to the JSON property `interpreter` - # @return [String] - attr_accessor :interpreter - - # An inline script. - # Corresponds to the JSON property `script` - # @return [String] - attr_accessor :script - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @allowed_success_codes = args[:allowed_success_codes] if args.key?(:allowed_success_codes) - @args = args[:args] if args.key?(:args) - @file = args[:file] if args.key?(:file) - @interpreter = args[:interpreter] if args.key?(:interpreter) - @script = args[:script] if args.key?(:script) - end - end - # A step that runs an executable for a PatchJob. class ExecStep include Google::Apis::Core::Hashable @@ -568,200 +500,6 @@ module Google end end - # A resource that extracts an archive - class ExtractArchiveResource - include Google::Apis::Core::Hashable - - # Local file path that signals this resource is in the desired state. The - # absence of this file will indicate whether the archive needs to be extracted. - # Corresponds to the JSON property `creates` - # @return [String] - attr_accessor :creates - - # Directory to extract archive to. - # Corresponds to the JSON property `destination` - # @return [String] - attr_accessor :destination - - # Whether to overwrite existing files during extraction. If this is set to true, - # any existing files in the destination location will be overwritten by the - # extraction. - # Corresponds to the JSON property `overwrite` - # @return [Boolean] - attr_accessor :overwrite - alias_method :overwrite?, :overwrite - - # A remote or local file. - # Corresponds to the JSON property `source` - # @return [Google::Apis::OsconfigV1beta::File] - attr_accessor :source - - # The type of the archive to extract. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @creates = args[:creates] if args.key?(:creates) - @destination = args[:destination] if args.key?(:destination) - @overwrite = args[:overwrite] if args.key?(:overwrite) - @source = args[:source] if args.key?(:source) - @type = args[:type] if args.key?(:type) - end - end - - # A remote or local file. - class File - include Google::Apis::Core::Hashable - - # Defaults to false. When false, files will be subject to validations based on - # the file type: Remote: A checksum must be specified. GCS: An object generation - # number must be specified. - # Corresponds to the JSON property `allowInsecure` - # @return [Boolean] - attr_accessor :allow_insecure - alias_method :allow_insecure?, :allow_insecure - - # Specifies a file available as a GCS Object. - # Corresponds to the JSON property `gcs` - # @return [Google::Apis::OsconfigV1beta::FileGcs] - attr_accessor :gcs - - # A local path to use. - # Corresponds to the JSON property `localPath` - # @return [String] - attr_accessor :local_path - - # Specifies a file available via some URI. - # Corresponds to the JSON property `remote` - # @return [Google::Apis::OsconfigV1beta::FileRemote] - attr_accessor :remote - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @allow_insecure = args[:allow_insecure] if args.key?(:allow_insecure) - @gcs = args[:gcs] if args.key?(:gcs) - @local_path = args[:local_path] if args.key?(:local_path) - @remote = args[:remote] if args.key?(:remote) - end - end - - # Specifies a file available as a GCS Object. - class FileGcs - include Google::Apis::Core::Hashable - - # Bucket of the GCS object. - # Corresponds to the JSON property `bucket` - # @return [String] - attr_accessor :bucket - - # Generation number of the GCS object. - # Corresponds to the JSON property `generation` - # @return [Fixnum] - attr_accessor :generation - - # Name of the GCS object. - # Corresponds to the JSON property `object` - # @return [String] - attr_accessor :object - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @bucket = args[:bucket] if args.key?(:bucket) - @generation = args[:generation] if args.key?(:generation) - @object = args[:object] if args.key?(:object) - end - end - - # Specifies a file available via some URI. - class FileRemote - include Google::Apis::Core::Hashable - - # SHA256 checksum of the remote file. - # Corresponds to the JSON property `sha256Checksum` - # @return [String] - attr_accessor :sha256_checksum - - # URI from which to fetch the object. It should contain both the protocol and - # path following the format `protocol`://`location`. - # Corresponds to the JSON property `uri` - # @return [String] - attr_accessor :uri - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @sha256_checksum = args[:sha256_checksum] if args.key?(:sha256_checksum) - @uri = args[:uri] if args.key?(:uri) - end - end - - # A resource that manages the state of a file. - class FileResource - include Google::Apis::Core::Hashable - - # A a file with this content. - # Corresponds to the JSON property `content` - # @return [String] - attr_accessor :content - - # A remote or local file. - # Corresponds to the JSON property `file` - # @return [Google::Apis::OsconfigV1beta::File] - attr_accessor :file - - # The absolute path of the file. - # Corresponds to the JSON property `path` - # @return [String] - attr_accessor :path - - # Consists of three octal digits which represent, in order, the permissions of - # the owner, group, and other users for the file (similarly to the numeric mode - # used in the linux chmod utility). Each digit represents a three bit number - # with the 4 bit corresponding to the read permissions, the 2 bit corresponds to - # the write bit, and the one bit corresponds to the execute permission. Default - # behavior is 755. Below are some examples of permissions and their associated - # values: read, write, and execute: 7 read and execute: 5 read and write: 6 read - # only: 4 - # Corresponds to the JSON property `permissions` - # @return [String] - attr_accessor :permissions - - # Desired state of the file. - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @content = args[:content] if args.key?(:content) - @file = args[:file] if args.key?(:file) - @path = args[:path] if args.key?(:path) - @permissions = args[:permissions] if args.key?(:permissions) - @state = args[:state] if args.key?(:state) - end - end - # Message encapsulating a value that can be either absolute ("fixed") or # relative ("percent") to a value. class FixedOrPercent @@ -1213,242 +951,6 @@ module Google end end - # A resource that manages a system package. - class PackageResource - include Google::Apis::Core::Hashable - - # A package managed by APT. install: `apt-get update && apt-get -y install [name] - # ` remove: `apt-get -y remove [name]` - # Corresponds to the JSON property `apt` - # @return [Google::Apis::OsconfigV1beta::PackageResourceApt] - attr_accessor :apt - - # A deb package file. dpkg packages only support INSTALLED state. - # Corresponds to the JSON property `deb` - # @return [Google::Apis::OsconfigV1beta::PackageResourceDeb] - attr_accessor :deb - - # The desired_state the agent should maintain for this package. The default is - # to ensure the package is installed. - # Corresponds to the JSON property `desiredState` - # @return [String] - attr_accessor :desired_state - - # A package managed by GooGet. install: `googet -noconfirm install package` - # remove: `googet -noconfirm remove package` - # Corresponds to the JSON property `googet` - # @return [Google::Apis::OsconfigV1beta::PackageResourceGooGet] - attr_accessor :googet - - # An MSI package. MSI packages only support INSTALLED state. Install msiexec /i / - # qn /norestart - # Corresponds to the JSON property `msi` - # @return [Google::Apis::OsconfigV1beta::PackageResourceMsi] - attr_accessor :msi - - # An RPM package file. RPM packages only support INSTALLED state. - # Corresponds to the JSON property `rpm` - # @return [Google::Apis::OsconfigV1beta::PackageResourceRpm] - attr_accessor :rpm - - # A package managed by YUM. install: `yum -y install package` remove: `yum -y - # remove package` - # Corresponds to the JSON property `yum` - # @return [Google::Apis::OsconfigV1beta::PackageResourceYum] - attr_accessor :yum - - # A package managed by Zypper. install: `zypper -y install package` remove: ` - # zypper -y rm package` - # Corresponds to the JSON property `zypper` - # @return [Google::Apis::OsconfigV1beta::PackageResourceZypper] - attr_accessor :zypper - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @apt = args[:apt] if args.key?(:apt) - @deb = args[:deb] if args.key?(:deb) - @desired_state = args[:desired_state] if args.key?(:desired_state) - @googet = args[:googet] if args.key?(:googet) - @msi = args[:msi] if args.key?(:msi) - @rpm = args[:rpm] if args.key?(:rpm) - @yum = args[:yum] if args.key?(:yum) - @zypper = args[:zypper] if args.key?(:zypper) - end - end - - # A package managed by APT. install: `apt-get update && apt-get -y install [name] - # ` remove: `apt-get -y remove [name]` - class PackageResourceApt - include Google::Apis::Core::Hashable - - # Package name. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @name = args[:name] if args.key?(:name) - end - end - - # A deb package file. dpkg packages only support INSTALLED state. - class PackageResourceDeb - include Google::Apis::Core::Hashable - - # Whether dependencies should also be installed. install when false: `dpkg -i - # package` install when true: `apt-get update && apt-get -y install package.deb` - # Corresponds to the JSON property `pullDeps` - # @return [Boolean] - attr_accessor :pull_deps - alias_method :pull_deps?, :pull_deps - - # A remote or local file. - # Corresponds to the JSON property `source` - # @return [Google::Apis::OsconfigV1beta::File] - attr_accessor :source - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @pull_deps = args[:pull_deps] if args.key?(:pull_deps) - @source = args[:source] if args.key?(:source) - end - end - - # A package managed by GooGet. install: `googet -noconfirm install package` - # remove: `googet -noconfirm remove package` - class PackageResourceGooGet - include Google::Apis::Core::Hashable - - # Package name. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @name = args[:name] if args.key?(:name) - end - end - - # An MSI package. MSI packages only support INSTALLED state. Install msiexec /i / - # qn /norestart - class PackageResourceMsi - include Google::Apis::Core::Hashable - - # Return codes that indicate that the software installed or updated successfully. - # Behaviour defaults to [0] - # Corresponds to the JSON property `allowedSuccessCodes` - # @return [Array] - attr_accessor :allowed_success_codes - - # Flags to use during package install. Appended to the defalts of "/i /qn / - # norestart" - # Corresponds to the JSON property `flags` - # @return [Array] - attr_accessor :flags - - # A remote or local file. - # Corresponds to the JSON property `source` - # @return [Google::Apis::OsconfigV1beta::File] - attr_accessor :source - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @allowed_success_codes = args[:allowed_success_codes] if args.key?(:allowed_success_codes) - @flags = args[:flags] if args.key?(:flags) - @source = args[:source] if args.key?(:source) - end - end - - # An RPM package file. RPM packages only support INSTALLED state. - class PackageResourceRpm - include Google::Apis::Core::Hashable - - # Whether dependencies should also be installed. install when false: `rpm -- - # upgrade --replacepkgs package.rpm` install when true: `yum -y install package. - # rpm` or `zypper -y install package.rpm` - # Corresponds to the JSON property `pullDeps` - # @return [Boolean] - attr_accessor :pull_deps - alias_method :pull_deps?, :pull_deps - - # A remote or local file. - # Corresponds to the JSON property `source` - # @return [Google::Apis::OsconfigV1beta::File] - attr_accessor :source - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @pull_deps = args[:pull_deps] if args.key?(:pull_deps) - @source = args[:source] if args.key?(:source) - end - end - - # A package managed by YUM. install: `yum -y install package` remove: `yum -y - # remove package` - class PackageResourceYum - include Google::Apis::Core::Hashable - - # Package name. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @name = args[:name] if args.key?(:name) - end - end - - # A package managed by Zypper. install: `zypper -y install package` remove: ` - # zypper -y rm package` - class PackageResourceZypper - include Google::Apis::Core::Hashable - - # Package name. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @name = args[:name] if args.key?(:name) - end - end - # Patch configuration specifications. Contains details on how to apply the patch( # es) to a VM instance. class PatchConfig @@ -2059,212 +1561,6 @@ module Google end end - # A resource that manages a package repository. - class RepositoryResource - include Google::Apis::Core::Hashable - - # Represents a single apt package repository. These will be added to a repo file - # that will be managed at /etc/apt/sources.list.d/google_osconfig.list. - # Corresponds to the JSON property `apt` - # @return [Google::Apis::OsconfigV1beta::RepositoryResourceAptRepository] - attr_accessor :apt - - # Represents a Goo package repository. These will be added to a repo file that - # will be managed at C:/ProgramData/GooGet/repos/google_osconfig.repo. - # Corresponds to the JSON property `goo` - # @return [Google::Apis::OsconfigV1beta::RepositoryResourceGooRepository] - attr_accessor :goo - - # Represents a single yum package repository. These will be added to a repo file - # that will be managed at /etc/yum.repos.d/google_osconfig.repo. - # Corresponds to the JSON property `yum` - # @return [Google::Apis::OsconfigV1beta::RepositoryResourceYumRepository] - attr_accessor :yum - - # Represents a single zypper package repository. These will be added to a repo - # file that will be managed at /etc/zypp/repos.d/google_osconfig.repo. - # Corresponds to the JSON property `zypper` - # @return [Google::Apis::OsconfigV1beta::RepositoryResourceZypperRepository] - attr_accessor :zypper - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @apt = args[:apt] if args.key?(:apt) - @goo = args[:goo] if args.key?(:goo) - @yum = args[:yum] if args.key?(:yum) - @zypper = args[:zypper] if args.key?(:zypper) - end - end - - # Represents a single apt package repository. These will be added to a repo file - # that will be managed at /etc/apt/sources.list.d/google_osconfig.list. - class RepositoryResourceAptRepository - include Google::Apis::Core::Hashable - - # Type of archive files in this repository. The default behavior is DEB. - # Corresponds to the JSON property `archiveType` - # @return [String] - attr_accessor :archive_type - - # List of components for this repository. Must contain at least one item. - # Corresponds to the JSON property `components` - # @return [Array] - attr_accessor :components - - # Distribution of this repository. - # Corresponds to the JSON property `distribution` - # @return [String] - attr_accessor :distribution - - # URI of the key file for this repository. The agent will maintain a keyring at / - # etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg. - # Corresponds to the JSON property `gpgKey` - # @return [String] - attr_accessor :gpg_key - - # URI for this repository. - # Corresponds to the JSON property `uri` - # @return [String] - attr_accessor :uri - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @archive_type = args[:archive_type] if args.key?(:archive_type) - @components = args[:components] if args.key?(:components) - @distribution = args[:distribution] if args.key?(:distribution) - @gpg_key = args[:gpg_key] if args.key?(:gpg_key) - @uri = args[:uri] if args.key?(:uri) - end - end - - # Represents a Goo package repository. These will be added to a repo file that - # will be managed at C:/ProgramData/GooGet/repos/google_osconfig.repo. - class RepositoryResourceGooRepository - include Google::Apis::Core::Hashable - - # The name of the repository. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # The url of the repository. - # Corresponds to the JSON property `url` - # @return [String] - attr_accessor :url - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @name = args[:name] if args.key?(:name) - @url = args[:url] if args.key?(:url) - end - end - - # Represents a single yum package repository. These will be added to a repo file - # that will be managed at /etc/yum.repos.d/google_osconfig.repo. - class RepositoryResourceYumRepository - include Google::Apis::Core::Hashable - - # The location of the repository directory. - # Corresponds to the JSON property `baseUrl` - # @return [String] - attr_accessor :base_url - - # The display name of the repository. - # Corresponds to the JSON property `displayName` - # @return [String] - attr_accessor :display_name - - # URIs of GPG keys. - # Corresponds to the JSON property `gpgKeys` - # @return [Array] - attr_accessor :gpg_keys - - # A one word, unique name for this repository. This will be the `repo id` in the - # yum config file and also the `display_name` if `display_name` is omitted. This - # id is also used as the unique identifier when checking for resource conflicts. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @base_url = args[:base_url] if args.key?(:base_url) - @display_name = args[:display_name] if args.key?(:display_name) - @gpg_keys = args[:gpg_keys] if args.key?(:gpg_keys) - @id = args[:id] if args.key?(:id) - end - end - - # Represents a single zypper package repository. These will be added to a repo - # file that will be managed at /etc/zypp/repos.d/google_osconfig.repo. - class RepositoryResourceZypperRepository - include Google::Apis::Core::Hashable - - # The location of the repository directory. - # Corresponds to the JSON property `baseUrl` - # @return [String] - attr_accessor :base_url - - # The display name of the repository. - # Corresponds to the JSON property `displayName` - # @return [String] - attr_accessor :display_name - - # URIs of GPG keys. - # Corresponds to the JSON property `gpgKeys` - # @return [Array] - attr_accessor :gpg_keys - - # A one word, unique name for this repository. This will be the `repo id` in the - # zypper config file and also the `display_name` if `display_name` is omitted. - # This id is also used as the unique identifier when checking for GuestPolicy - # conflicts. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @base_url = args[:base_url] if args.key?(:base_url) - @display_name = args[:display_name] if args.key?(:display_name) - @gpg_keys = args[:gpg_keys] if args.key?(:gpg_keys) - @id = args[:id] if args.key?(:id) - end - end - - # A resource that manages a system service. - class ServiceResource - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - end - end - # A software recipe is a set of instructions for installing and configuring a # piece of software. It consists of a set of artifacts that are downloaded, and # a set of steps that install, configure, and/or update the software. Recipes diff --git a/generated/google/apis/osconfig_v1beta/representations.rb b/generated/google/apis/osconfig_v1beta/representations.rb index a3ecf3648..adaa51bf2 100644 --- a/generated/google/apis/osconfig_v1beta/representations.rb +++ b/generated/google/apis/osconfig_v1beta/representations.rb @@ -88,18 +88,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class ExecResource - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ExecResourceExec - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class ExecStep class Representation < Google::Apis::Core::JsonRepresentation; end @@ -118,36 +106,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class ExtractArchiveResource - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class File - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class FileGcs - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class FileRemote - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class FileResource - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class FixedOrPercent class Representation < Google::Apis::Core::JsonRepresentation; end @@ -232,54 +190,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class PackageResource - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PackageResourceApt - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PackageResourceDeb - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PackageResourceGooGet - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PackageResourceMsi - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PackageResourceRpm - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PackageResourceYum - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PackageResourceZypper - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class PatchConfig class Representation < Google::Apis::Core::JsonRepresentation; end @@ -334,42 +244,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class RepositoryResource - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RepositoryResourceAptRepository - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RepositoryResourceGooRepository - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RepositoryResourceYumRepository - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RepositoryResourceZypperRepository - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ServiceResource - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class SoftwareRecipe class Representation < Google::Apis::Core::JsonRepresentation; end @@ -596,28 +470,6 @@ module Google end end - class ExecResource - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :enforce, as: 'enforce', class: Google::Apis::OsconfigV1beta::ExecResourceExec, decorator: Google::Apis::OsconfigV1beta::ExecResourceExec::Representation - - property :validate, as: 'validate', class: Google::Apis::OsconfigV1beta::ExecResourceExec, decorator: Google::Apis::OsconfigV1beta::ExecResourceExec::Representation - - end - end - - class ExecResourceExec - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :allowed_success_codes, as: 'allowedSuccessCodes' - collection :args, as: 'args' - property :file, as: 'file', class: Google::Apis::OsconfigV1beta::File, decorator: Google::Apis::OsconfigV1beta::File::Representation - - property :interpreter, as: 'interpreter' - property :script, as: 'script' - end - end - class ExecStep # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -655,59 +507,6 @@ module Google end end - class ExtractArchiveResource - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :creates, as: 'creates' - property :destination, as: 'destination' - property :overwrite, as: 'overwrite' - property :source, as: 'source', class: Google::Apis::OsconfigV1beta::File, decorator: Google::Apis::OsconfigV1beta::File::Representation - - property :type, as: 'type' - end - end - - class File - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :allow_insecure, as: 'allowInsecure' - property :gcs, as: 'gcs', class: Google::Apis::OsconfigV1beta::FileGcs, decorator: Google::Apis::OsconfigV1beta::FileGcs::Representation - - property :local_path, as: 'localPath' - property :remote, as: 'remote', class: Google::Apis::OsconfigV1beta::FileRemote, decorator: Google::Apis::OsconfigV1beta::FileRemote::Representation - - end - end - - class FileGcs - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :bucket, as: 'bucket' - property :generation, :numeric_string => true, as: 'generation' - property :object, as: 'object' - end - end - - class FileRemote - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :sha256_checksum, as: 'sha256Checksum' - property :uri, as: 'uri' - end - end - - class FileResource - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :content, as: 'content' - property :file, as: 'file', class: Google::Apis::OsconfigV1beta::File, decorator: Google::Apis::OsconfigV1beta::File::Representation - - property :path, as: 'path' - property :permissions, as: 'permissions' - property :state, as: 'state' - end - end - class FixedOrPercent # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -842,83 +641,6 @@ module Google end end - class PackageResource - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :apt, as: 'apt', class: Google::Apis::OsconfigV1beta::PackageResourceApt, decorator: Google::Apis::OsconfigV1beta::PackageResourceApt::Representation - - property :deb, as: 'deb', class: Google::Apis::OsconfigV1beta::PackageResourceDeb, decorator: Google::Apis::OsconfigV1beta::PackageResourceDeb::Representation - - property :desired_state, as: 'desiredState' - property :googet, as: 'googet', class: Google::Apis::OsconfigV1beta::PackageResourceGooGet, decorator: Google::Apis::OsconfigV1beta::PackageResourceGooGet::Representation - - property :msi, as: 'msi', class: Google::Apis::OsconfigV1beta::PackageResourceMsi, decorator: Google::Apis::OsconfigV1beta::PackageResourceMsi::Representation - - property :rpm, as: 'rpm', class: Google::Apis::OsconfigV1beta::PackageResourceRpm, decorator: Google::Apis::OsconfigV1beta::PackageResourceRpm::Representation - - property :yum, as: 'yum', class: Google::Apis::OsconfigV1beta::PackageResourceYum, decorator: Google::Apis::OsconfigV1beta::PackageResourceYum::Representation - - property :zypper, as: 'zypper', class: Google::Apis::OsconfigV1beta::PackageResourceZypper, decorator: Google::Apis::OsconfigV1beta::PackageResourceZypper::Representation - - end - end - - class PackageResourceApt - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - end - end - - class PackageResourceDeb - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :pull_deps, as: 'pullDeps' - property :source, as: 'source', class: Google::Apis::OsconfigV1beta::File, decorator: Google::Apis::OsconfigV1beta::File::Representation - - end - end - - class PackageResourceGooGet - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - end - end - - class PackageResourceMsi - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :allowed_success_codes, as: 'allowedSuccessCodes' - collection :flags, as: 'flags' - property :source, as: 'source', class: Google::Apis::OsconfigV1beta::File, decorator: Google::Apis::OsconfigV1beta::File::Representation - - end - end - - class PackageResourceRpm - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :pull_deps, as: 'pullDeps' - property :source, as: 'source', class: Google::Apis::OsconfigV1beta::File, decorator: Google::Apis::OsconfigV1beta::File::Representation - - end - end - - class PackageResourceYum - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - end - end - - class PackageResourceZypper - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - end - end - class PatchConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1066,65 +788,6 @@ module Google end end - class RepositoryResource - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :apt, as: 'apt', class: Google::Apis::OsconfigV1beta::RepositoryResourceAptRepository, decorator: Google::Apis::OsconfigV1beta::RepositoryResourceAptRepository::Representation - - property :goo, as: 'goo', class: Google::Apis::OsconfigV1beta::RepositoryResourceGooRepository, decorator: Google::Apis::OsconfigV1beta::RepositoryResourceGooRepository::Representation - - property :yum, as: 'yum', class: Google::Apis::OsconfigV1beta::RepositoryResourceYumRepository, decorator: Google::Apis::OsconfigV1beta::RepositoryResourceYumRepository::Representation - - property :zypper, as: 'zypper', class: Google::Apis::OsconfigV1beta::RepositoryResourceZypperRepository, decorator: Google::Apis::OsconfigV1beta::RepositoryResourceZypperRepository::Representation - - end - end - - class RepositoryResourceAptRepository - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :archive_type, as: 'archiveType' - collection :components, as: 'components' - property :distribution, as: 'distribution' - property :gpg_key, as: 'gpgKey' - property :uri, as: 'uri' - end - end - - class RepositoryResourceGooRepository - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - property :url, as: 'url' - end - end - - class RepositoryResourceYumRepository - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :base_url, as: 'baseUrl' - property :display_name, as: 'displayName' - collection :gpg_keys, as: 'gpgKeys' - property :id, as: 'id' - end - end - - class RepositoryResourceZypperRepository - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :base_url, as: 'baseUrl' - property :display_name, as: 'displayName' - collection :gpg_keys, as: 'gpgKeys' - property :id, as: 'id' - end - end - - class ServiceResource - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - class SoftwareRecipe # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/playcustomapp_v1.rb b/generated/google/apis/playcustomapp_v1.rb index c028940bb..7477d53fe 100644 --- a/generated/google/apis/playcustomapp_v1.rb +++ b/generated/google/apis/playcustomapp_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/android/work/play/custom-app-api/ module PlaycustomappV1 VERSION = 'V1' - REVISION = '20200801' + REVISION = '20200912' # View and manage your Google Play Developer account AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher' diff --git a/generated/google/apis/playcustomapp_v1/service.rb b/generated/google/apis/playcustomapp_v1/service.rb index e191b8fa1..ffdd9c9b6 100644 --- a/generated/google/apis/playcustomapp_v1/service.rb +++ b/generated/google/apis/playcustomapp_v1/service.rb @@ -43,8 +43,8 @@ module Google attr_accessor :quota_user def initialize - super('https://www.googleapis.com/', '') - @batch_path = 'batch/playcustomapp/v1' + super('https://playcustomapp.googleapis.com/', '') + @batch_path = 'batch' end # Creates a new custom app. diff --git a/generated/google/apis/prod_tt_sasportal_v1alpha1.rb b/generated/google/apis/prod_tt_sasportal_v1alpha1.rb index 1cb1a0715..182fac0a0 100644 --- a/generated/google/apis/prod_tt_sasportal_v1alpha1.rb +++ b/generated/google/apis/prod_tt_sasportal_v1alpha1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/spectrum-access-system/ module ProdTtSasportalV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200821' + REVISION = '20200908' # View your email address AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email' diff --git a/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb b/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb index 8ff78d0d5..39ea3cdd9 100644 --- a/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb +++ b/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb @@ -764,6 +764,26 @@ module Google end end + # Request for MoveDeployment method. + class SasPortalMoveDeploymentRequest + include Google::Apis::Core::Hashable + + # Required. The name of the new parent resource Node or Customer to reparent the + # deployment under. + # Corresponds to the JSON property `destination` + # @return [String] + attr_accessor :destination + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @destination = args[:destination] if args.key?(:destination) + end + end + # Request for MoveDevice method. class SasPortalMoveDeviceRequest include Google::Apis::Core::Hashable diff --git a/generated/google/apis/prod_tt_sasportal_v1alpha1/representations.rb b/generated/google/apis/prod_tt_sasportal_v1alpha1/representations.rb index 2323be1fc..794d593bf 100644 --- a/generated/google/apis/prod_tt_sasportal_v1alpha1/representations.rb +++ b/generated/google/apis/prod_tt_sasportal_v1alpha1/representations.rb @@ -148,6 +148,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class SasPortalMoveDeploymentRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SasPortalMoveDeviceRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -435,6 +441,13 @@ module Google end end + class SasPortalMoveDeploymentRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :destination, as: 'destination' + end + end + class SasPortalMoveDeviceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb b/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb index ab84a066f..b784b73e1 100644 --- a/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb +++ b/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb @@ -147,6 +147,148 @@ module Google execute_or_queue_command(command, &block) end + # Moves a deployment under another node or customer. + # @param [String] name + # Required. The name of the deployment to move. + # @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalMoveDeploymentRequest] sas_portal_move_deployment_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def move_customer_deployment(name, sas_portal_move_deployment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+name}:move', options) + command.request_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalMoveDeploymentRequest::Representation + command.request_object = sas_portal_move_deployment_request_object + command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalOperation::Representation + command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalOperation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a device under a node or customer. + # @param [String] parent + # Required. The name of the parent resource. + # @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] sas_portal_device_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_customer_deployment_device(parent, sas_portal_device_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+parent}/devices', options) + command.request_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice::Representation + command.request_object = sas_portal_device_object + command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice::Representation + command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a signed device under a node or customer. + # @param [String] parent + # Required. The name of the parent resource. + # @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalCreateSignedDeviceRequest] sas_portal_create_signed_device_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_customer_deployment_device_signed(parent, sas_portal_create_signed_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+parent}/devices:createSigned', options) + command.request_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalCreateSignedDeviceRequest::Representation + command.request_object = sas_portal_create_signed_device_request_object + command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice::Representation + command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists devices under a node or customer. + # @param [String] parent + # Required. The name of the parent resource. + # @param [String] filter + # The filter expression. The filter should have one of the following formats: " + # sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the + # device. The filter is case insensitive. + # @param [Fixnum] page_size + # The maximum number of devices to return in the response. If empty or zero, all + # devices will be listed. Must be in the range [0, 1000]. + # @param [String] page_token + # A pagination token returned from a previous call to ListDevices that indicates + # where this listing should continue from. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalListDevicesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalListDevicesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_customer_deployment_devices(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha1/{+parent}/devices', options) + command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalListDevicesResponse::Representation + command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalListDevicesResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a device under a node or customer. Returned devices are unordered. # @param [String] parent # Required. The name of the parent resource. @@ -753,6 +895,201 @@ module Google execute_or_queue_command(command, &block) end + # Deletes a device. + # @param [String] name + # Required. The name of the device. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalEmpty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalEmpty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_deployment_device(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1alpha1/{+name}', options) + command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalEmpty::Representation + command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalEmpty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets details about a device. + # @param [String] name + # Required. The name of the device. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_deployment_device(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha1/{+name}', options) + command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice::Representation + command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Moves a device under another node or customer. + # @param [String] name + # Required. The name of the device to move. + # @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalMoveDeviceRequest] sas_portal_move_device_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def move_deployment_device(name, sas_portal_move_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+name}:move', options) + command.request_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalMoveDeviceRequest::Representation + command.request_object = sas_portal_move_device_request_object + command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalOperation::Representation + command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalOperation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates a device. + # @param [String] name + # Output only. The resource path name. + # @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] sas_portal_device_object + # @param [String] update_mask + # Fields to be updated. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_deployment_device(name, sas_portal_device_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1alpha1/{+name}', options) + command.request_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice::Representation + command.request_object = sas_portal_device_object + command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice::Representation + command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Signs a device. + # @param [String] name + # Output only. The resource path name. + # @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalSignDeviceRequest] sas_portal_sign_device_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalEmpty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalEmpty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def sign_deployment_device_device(name, sas_portal_sign_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+name}:signDevice', options) + command.request_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalSignDeviceRequest::Representation + command.request_object = sas_portal_sign_device_request_object + command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalEmpty::Representation + command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalEmpty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates a signed device. + # @param [String] name + # Required. The name of the device to update. + # @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalUpdateSignedDeviceRequest] sas_portal_update_signed_device_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_deployment_device_signed(name, sas_portal_update_signed_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1alpha1/{+name}:updateSigned', options) + command.request_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalUpdateSignedDeviceRequest::Representation + command.request_object = sas_portal_update_signed_device_request_object + command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice::Representation + command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Generates a secret to be used with the ValidateInstaller method # @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalGenerateSecretRequest] sas_portal_generate_secret_request_object # @param [String] fields @@ -843,6 +1180,148 @@ module Google execute_or_queue_command(command, &block) end + # Moves a deployment under another node or customer. + # @param [String] name + # Required. The name of the deployment to move. + # @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalMoveDeploymentRequest] sas_portal_move_deployment_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def move_node_deployment(name, sas_portal_move_deployment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+name}:move', options) + command.request_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalMoveDeploymentRequest::Representation + command.request_object = sas_portal_move_deployment_request_object + command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalOperation::Representation + command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalOperation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a device under a node or customer. + # @param [String] parent + # Required. The name of the parent resource. + # @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] sas_portal_device_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_node_deployment_device(parent, sas_portal_device_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+parent}/devices', options) + command.request_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice::Representation + command.request_object = sas_portal_device_object + command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice::Representation + command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a signed device under a node or customer. + # @param [String] parent + # Required. The name of the parent resource. + # @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalCreateSignedDeviceRequest] sas_portal_create_signed_device_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_node_deployment_device_signed(parent, sas_portal_create_signed_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+parent}/devices:createSigned', options) + command.request_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalCreateSignedDeviceRequest::Representation + command.request_object = sas_portal_create_signed_device_request_object + command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice::Representation + command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists devices under a node or customer. + # @param [String] parent + # Required. The name of the parent resource. + # @param [String] filter + # The filter expression. The filter should have one of the following formats: " + # sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the + # device. The filter is case insensitive. + # @param [Fixnum] page_size + # The maximum number of devices to return in the response. If empty or zero, all + # devices will be listed. Must be in the range [0, 1000]. + # @param [String] page_token + # A pagination token returned from a previous call to ListDevices that indicates + # where this listing should continue from. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalListDevicesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalListDevicesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_node_deployment_devices(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha1/{+parent}/devices', options) + command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalListDevicesResponse::Representation + command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalListDevicesResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a device under a node or customer. Returned devices are unordered. # @param [String] parent # Required. The name of the parent resource. diff --git a/generated/google/apis/remotebuildexecution_v1.rb b/generated/google/apis/remotebuildexecution_v1.rb index a299592e8..1e9690f9d 100644 --- a/generated/google/apis/remotebuildexecution_v1.rb +++ b/generated/google/apis/remotebuildexecution_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/remote-build-execution/docs/ module RemotebuildexecutionV1 VERSION = 'V1' - REVISION = '20200819' + REVISION = '20200901' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/remotebuildexecution_v1alpha.rb b/generated/google/apis/remotebuildexecution_v1alpha.rb index fcf81ee56..7a42d7a62 100644 --- a/generated/google/apis/remotebuildexecution_v1alpha.rb +++ b/generated/google/apis/remotebuildexecution_v1alpha.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/remote-build-execution/docs/ module RemotebuildexecutionV1alpha VERSION = 'V1alpha' - REVISION = '20200819' + REVISION = '20200901' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/remotebuildexecution_v2.rb b/generated/google/apis/remotebuildexecution_v2.rb index 5cbd96845..037cc37b1 100644 --- a/generated/google/apis/remotebuildexecution_v2.rb +++ b/generated/google/apis/remotebuildexecution_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/remote-build-execution/docs/ module RemotebuildexecutionV2 VERSION = 'V2' - REVISION = '20200819' + REVISION = '20200901' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/runtimeconfig_v1beta1.rb b/generated/google/apis/runtimeconfig_v1beta1.rb index 794f2d8dd..a386ec10a 100644 --- a/generated/google/apis/runtimeconfig_v1beta1.rb +++ b/generated/google/apis/runtimeconfig_v1beta1.rb @@ -28,7 +28,7 @@ module Google # @see https://cloud.google.com/deployment-manager/runtime-configurator/ module RuntimeconfigV1beta1 VERSION = 'V1beta1' - REVISION = '20200803' + REVISION = '20200831' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/runtimeconfig_v1beta1/classes.rb b/generated/google/apis/runtimeconfig_v1beta1/classes.rb index 376828acb..4269f8302 100644 --- a/generated/google/apis/runtimeconfig_v1beta1/classes.rb +++ b/generated/google/apis/runtimeconfig_v1beta1/classes.rb @@ -26,6 +26,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: @@ -87,6 +93,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) diff --git a/generated/google/apis/runtimeconfig_v1beta1/representations.rb b/generated/google/apis/runtimeconfig_v1beta1/representations.rb index 1e2c3c29d..c67ea1db3 100644 --- a/generated/google/apis/runtimeconfig_v1beta1/representations.rb +++ b/generated/google/apis/runtimeconfig_v1beta1/representations.rb @@ -133,6 +133,7 @@ module Google class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::RuntimeconfigV1beta1::Expr, decorator: Google::Apis::RuntimeconfigV1beta1::Expr::Representation collection :members, as: 'members' diff --git a/generated/google/apis/safebrowsing_v4.rb b/generated/google/apis/safebrowsing_v4.rb index 1e2c20c55..bcd94b448 100644 --- a/generated/google/apis/safebrowsing_v4.rb +++ b/generated/google/apis/safebrowsing_v4.rb @@ -29,7 +29,7 @@ module Google # @see https://developers.google.com/safe-browsing/ module SafebrowsingV4 VERSION = 'V4' - REVISION = '20200825' + REVISION = '20200901' end end end diff --git a/generated/google/apis/secretmanager_v1.rb b/generated/google/apis/secretmanager_v1.rb index d3b68dd17..b3f548b88 100644 --- a/generated/google/apis/secretmanager_v1.rb +++ b/generated/google/apis/secretmanager_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/secret-manager/ module SecretmanagerV1 VERSION = 'V1' - REVISION = '20200807' + REVISION = '20200903' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/secretmanager_v1/classes.rb b/generated/google/apis/secretmanager_v1/classes.rb index 955b04d93..6dae81bd8 100644 --- a/generated/google/apis/secretmanager_v1/classes.rb +++ b/generated/google/apis/secretmanager_v1/classes.rb @@ -145,12 +145,39 @@ module Google class Automatic include Google::Apis::Core::Hashable + # Configuration for encrypting secret payloads using customer-managed encryption + # keys (CMEK). + # Corresponds to the JSON property `customerManagedEncryption` + # @return [Google::Apis::SecretmanagerV1::CustomerManagedEncryption] + attr_accessor :customer_managed_encryption + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @customer_managed_encryption = args[:customer_managed_encryption] if args.key?(:customer_managed_encryption) + end + end + + # The replication status of a SecretVersion using automatic replication. Only + # populated if the parent Secret has an automatic replication policy. + class AutomaticStatus + include Google::Apis::Core::Hashable + + # Describes the status of customer-managed encryption. + # Corresponds to the JSON property `customerManagedEncryption` + # @return [Google::Apis::SecretmanagerV1::CustomerManagedEncryptionStatus] + attr_accessor :customer_managed_encryption + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @customer_managed_encryption = args[:customer_managed_encryption] if args.key?(:customer_managed_encryption) end end @@ -158,6 +185,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: @@ -219,12 +252,59 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) end end + # Configuration for encrypting secret payloads using customer-managed encryption + # keys (CMEK). + class CustomerManagedEncryption + include Google::Apis::Core::Hashable + + # Required. The resource name of the Cloud KMS CryptoKey used to encrypt secret + # payloads. For secrets using the UserManaged replication policy type, Cloud KMS + # CryptoKeys must reside in the same location as the replica location. For + # secrets using the Automatic replication policy type, Cloud KMS CryptoKeys must + # reside in `global`. The expected format is `projects/*/locations/*/keyRings/*/ + # cryptoKeys/*`. + # Corresponds to the JSON property `kmsKeyName` + # @return [String] + attr_accessor :kms_key_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name) + end + end + + # Describes the status of customer-managed encryption. + class CustomerManagedEncryptionStatus + include Google::Apis::Core::Hashable + + # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt + # the secret payload, in the following format: `projects/*/locations/*/keyRings/* + # /cryptoKeys/*/versions/*`. + # Corresponds to the JSON property `kmsKeyVersionName` + # @return [String] + attr_accessor :kms_key_version_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kms_key_version_name = args[:kms_key_version_name] if args.key?(:kms_key_version_name) + end + end + # Request message for SecretManagerService.DestroySecretVersion. class DestroySecretVersionRequest include Google::Apis::Core::Hashable @@ -565,6 +645,12 @@ module Google class Replica include Google::Apis::Core::Hashable + # Configuration for encrypting secret payloads using customer-managed encryption + # keys (CMEK). + # Corresponds to the JSON property `customerManagedEncryption` + # @return [Google::Apis::SecretmanagerV1::CustomerManagedEncryption] + attr_accessor :customer_managed_encryption + # The canonical IDs of the location to replicate data. For example: `"us-east1"`. # Corresponds to the JSON property `location` # @return [String] @@ -576,11 +662,38 @@ module Google # Update properties of this object def update!(**args) + @customer_managed_encryption = args[:customer_managed_encryption] if args.key?(:customer_managed_encryption) @location = args[:location] if args.key?(:location) end end - # A policy that defines the replication configuration of data. + # Describes the status of a user-managed replica for the SecretVersion. + class ReplicaStatus + include Google::Apis::Core::Hashable + + # Describes the status of customer-managed encryption. + # Corresponds to the JSON property `customerManagedEncryption` + # @return [Google::Apis::SecretmanagerV1::CustomerManagedEncryptionStatus] + attr_accessor :customer_managed_encryption + + # Output only. The canonical ID of the replica location. For example: `"us-east1" + # `. + # Corresponds to the JSON property `location` + # @return [String] + attr_accessor :location + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @customer_managed_encryption = args[:customer_managed_encryption] if args.key?(:customer_managed_encryption) + @location = args[:location] if args.key?(:location) + end + end + + # A policy that defines the replication and encryption configuration of data. class Replication include Google::Apis::Core::Hashable @@ -607,6 +720,33 @@ module Google end end + # The replication status of a SecretVersion. + class ReplicationStatus + include Google::Apis::Core::Hashable + + # The replication status of a SecretVersion using automatic replication. Only + # populated if the parent Secret has an automatic replication policy. + # Corresponds to the JSON property `automatic` + # @return [Google::Apis::SecretmanagerV1::AutomaticStatus] + attr_accessor :automatic + + # The replication status of a SecretVersion using user-managed replication. Only + # populated if the parent Secret has a user-managed replication policy. + # Corresponds to the JSON property `userManaged` + # @return [Google::Apis::SecretmanagerV1::UserManagedStatus] + attr_accessor :user_managed + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @automatic = args[:automatic] if args.key?(:automatic) + @user_managed = args[:user_managed] if args.key?(:user_managed) + end + end + # A Secret is a logical secret whose value and versions can be accessed. A # Secret is made up of zero or more SecretVersions that represent the secret # data. @@ -634,7 +774,7 @@ module Google # @return [String] attr_accessor :name - # A policy that defines the replication configuration of data. + # A policy that defines the replication and encryption configuration of data. # Corresponds to the JSON property `replication` # @return [Google::Apis::SecretmanagerV1::Replication] attr_accessor :replication @@ -695,6 +835,11 @@ module Google # @return [String] attr_accessor :name + # The replication status of a SecretVersion. + # Corresponds to the JSON property `replicationStatus` + # @return [Google::Apis::SecretmanagerV1::ReplicationStatus] + attr_accessor :replication_status + # Output only. The current state of the SecretVersion. # Corresponds to the JSON property `state` # @return [String] @@ -709,6 +854,7 @@ module Google @create_time = args[:create_time] if args.key?(:create_time) @destroy_time = args[:destroy_time] if args.key?(:destroy_time) @name = args[:name] if args.key?(:name) + @replication_status = args[:replication_status] if args.key?(:replication_status) @state = args[:state] if args.key?(:state) end end @@ -825,6 +971,26 @@ module Google @replicas = args[:replicas] if args.key?(:replicas) end end + + # The replication status of a SecretVersion using user-managed replication. Only + # populated if the parent Secret has a user-managed replication policy. + class UserManagedStatus + include Google::Apis::Core::Hashable + + # Output only. The list of replica statuses for the SecretVersion. + # Corresponds to the JSON property `replicas` + # @return [Array] + attr_accessor :replicas + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @replicas = args[:replicas] if args.key?(:replicas) + end + end end end end diff --git a/generated/google/apis/secretmanager_v1/representations.rb b/generated/google/apis/secretmanager_v1/representations.rb index 5c569c572..7ac52656b 100644 --- a/generated/google/apis/secretmanager_v1/representations.rb +++ b/generated/google/apis/secretmanager_v1/representations.rb @@ -52,12 +52,30 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class AutomaticStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Binding class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class CustomerManagedEncryption + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomerManagedEncryptionStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class DestroySecretVersionRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -124,12 +142,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ReplicaStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Replication class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class ReplicationStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Secret class Representation < Google::Apis::Core::JsonRepresentation; end @@ -172,6 +202,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class UserManagedStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class AccessSecretVersionResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -209,12 +245,23 @@ module Google class Automatic # @private class Representation < Google::Apis::Core::JsonRepresentation + property :customer_managed_encryption, as: 'customerManagedEncryption', class: Google::Apis::SecretmanagerV1::CustomerManagedEncryption, decorator: Google::Apis::SecretmanagerV1::CustomerManagedEncryption::Representation + + end + end + + class AutomaticStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :customer_managed_encryption, as: 'customerManagedEncryption', class: Google::Apis::SecretmanagerV1::CustomerManagedEncryptionStatus, decorator: Google::Apis::SecretmanagerV1::CustomerManagedEncryptionStatus::Representation + end end class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::SecretmanagerV1::Expr, decorator: Google::Apis::SecretmanagerV1::Expr::Representation collection :members, as: 'members' @@ -222,6 +269,20 @@ module Google end end + class CustomerManagedEncryption + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kms_key_name, as: 'kmsKeyName' + end + end + + class CustomerManagedEncryptionStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kms_key_version_name, as: 'kmsKeyVersionName' + end + end + class DestroySecretVersionRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -311,6 +372,17 @@ module Google class Replica # @private class Representation < Google::Apis::Core::JsonRepresentation + property :customer_managed_encryption, as: 'customerManagedEncryption', class: Google::Apis::SecretmanagerV1::CustomerManagedEncryption, decorator: Google::Apis::SecretmanagerV1::CustomerManagedEncryption::Representation + + property :location, as: 'location' + end + end + + class ReplicaStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :customer_managed_encryption, as: 'customerManagedEncryption', class: Google::Apis::SecretmanagerV1::CustomerManagedEncryptionStatus, decorator: Google::Apis::SecretmanagerV1::CustomerManagedEncryptionStatus::Representation + property :location, as: 'location' end end @@ -325,6 +397,16 @@ module Google end end + class ReplicationStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :automatic, as: 'automatic', class: Google::Apis::SecretmanagerV1::AutomaticStatus, decorator: Google::Apis::SecretmanagerV1::AutomaticStatus::Representation + + property :user_managed, as: 'userManaged', class: Google::Apis::SecretmanagerV1::UserManagedStatus, decorator: Google::Apis::SecretmanagerV1::UserManagedStatus::Representation + + end + end + class Secret # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -349,6 +431,8 @@ module Google property :create_time, as: 'createTime' property :destroy_time, as: 'destroyTime' property :name, as: 'name' + property :replication_status, as: 'replicationStatus', class: Google::Apis::SecretmanagerV1::ReplicationStatus, decorator: Google::Apis::SecretmanagerV1::ReplicationStatus::Representation + property :state, as: 'state' end end @@ -383,6 +467,14 @@ module Google end end + + class UserManagedStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :replicas, as: 'replicas', class: Google::Apis::SecretmanagerV1::ReplicaStatus, decorator: Google::Apis::SecretmanagerV1::ReplicaStatus::Representation + + end + end end end end diff --git a/generated/google/apis/secretmanager_v1beta1.rb b/generated/google/apis/secretmanager_v1beta1.rb index eebe88e81..772cda38c 100644 --- a/generated/google/apis/secretmanager_v1beta1.rb +++ b/generated/google/apis/secretmanager_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/secret-manager/ module SecretmanagerV1beta1 VERSION = 'V1beta1' - REVISION = '20200807' + REVISION = '20200831' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/secretmanager_v1beta1/classes.rb b/generated/google/apis/secretmanager_v1beta1/classes.rb index decec5fca..af8008f17 100644 --- a/generated/google/apis/secretmanager_v1beta1/classes.rb +++ b/generated/google/apis/secretmanager_v1beta1/classes.rb @@ -158,6 +158,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: @@ -219,6 +225,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) diff --git a/generated/google/apis/secretmanager_v1beta1/representations.rb b/generated/google/apis/secretmanager_v1beta1/representations.rb index afba66000..cf56def74 100644 --- a/generated/google/apis/secretmanager_v1beta1/representations.rb +++ b/generated/google/apis/secretmanager_v1beta1/representations.rb @@ -215,6 +215,7 @@ module Google class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::SecretmanagerV1beta1::Expr, decorator: Google::Apis::SecretmanagerV1beta1::Expr::Representation collection :members, as: 'members' diff --git a/generated/google/apis/servicedirectory_v1beta1.rb b/generated/google/apis/servicedirectory_v1beta1.rb index d25a0da10..2db7e7005 100644 --- a/generated/google/apis/servicedirectory_v1beta1.rb +++ b/generated/google/apis/servicedirectory_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/service-directory module ServicedirectoryV1beta1 VERSION = 'V1beta1' - REVISION = '20200803' + REVISION = '20200826' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/servicedirectory_v1beta1/classes.rb b/generated/google/apis/servicedirectory_v1beta1/classes.rb index c9788831c..bed955375 100644 --- a/generated/google/apis/servicedirectory_v1beta1/classes.rb +++ b/generated/google/apis/servicedirectory_v1beta1/classes.rb @@ -26,6 +26,12 @@ module Google class Binding include Google::Apis::Core::Hashable + # A client-specified ID for this binding. Expected to be globally unique to + # support the internal bindings-by-ID API. + # Corresponds to the JSON property `bindingId` + # @return [String] + attr_accessor :binding_id + # 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: @@ -87,6 +93,7 @@ module Google # Update properties of this object def update!(**args) + @binding_id = args[:binding_id] if args.key?(:binding_id) @condition = args[:condition] if args.key?(:condition) @members = args[:members] if args.key?(:members) @role = args[:role] if args.key?(:role) diff --git a/generated/google/apis/servicedirectory_v1beta1/representations.rb b/generated/google/apis/servicedirectory_v1beta1/representations.rb index 4155c43a9..c6080c6e7 100644 --- a/generated/google/apis/servicedirectory_v1beta1/representations.rb +++ b/generated/google/apis/servicedirectory_v1beta1/representations.rb @@ -139,6 +139,7 @@ module Google class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation + property :binding_id, as: 'bindingId' property :condition, as: 'condition', class: Google::Apis::ServicedirectoryV1beta1::Expr, decorator: Google::Apis::ServicedirectoryV1beta1::Expr::Representation collection :members, as: 'members' diff --git a/generated/google/apis/servicenetworking_v1.rb b/generated/google/apis/servicenetworking_v1.rb index 7c674337f..df10ebebb 100644 --- a/generated/google/apis/servicenetworking_v1.rb +++ b/generated/google/apis/servicenetworking_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started module ServicenetworkingV1 VERSION = 'V1' - REVISION = '20200822' + REVISION = '20200908' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/servicenetworking_v1/classes.rb b/generated/google/apis/servicenetworking_v1/classes.rb index 9ea005e1d..d5dd2856c 100644 --- a/generated/google/apis/servicenetworking_v1/classes.rb +++ b/generated/google/apis/servicenetworking_v1/classes.rb @@ -246,14 +246,6 @@ module Google # @return [Fixnum] attr_accessor :ip_prefix_length - # Optional. The private IPv6 google access type for the VMs in this subnet. For - # information about the access types that can be set using this field, see [ - # subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the Compute API - # documentation. - # Corresponds to the JSON property `privateIpv6GoogleAccess` - # @return [String] - attr_accessor :private_ipv6_google_access - # Required. The name of a [region](/compute/docs/regions-zones) for the subnet, # such `europe-west1`. # Corresponds to the JSON property `region` @@ -292,7 +284,6 @@ module Google @consumer_network = args[:consumer_network] if args.key?(:consumer_network) @description = args[:description] if args.key?(:description) @ip_prefix_length = args[:ip_prefix_length] if args.key?(:ip_prefix_length) - @private_ipv6_google_access = args[:private_ipv6_google_access] if args.key?(:private_ipv6_google_access) @region = args[:region] if args.key?(:region) @requested_address = args[:requested_address] if args.key?(:requested_address) @subnetwork = args[:subnetwork] if args.key?(:subnetwork) diff --git a/generated/google/apis/servicenetworking_v1/representations.rb b/generated/google/apis/servicenetworking_v1/representations.rb index 72209098b..f2a4a63ff 100644 --- a/generated/google/apis/servicenetworking_v1/representations.rb +++ b/generated/google/apis/servicenetworking_v1/representations.rb @@ -651,7 +651,6 @@ module Google property :consumer_network, as: 'consumerNetwork' property :description, as: 'description' property :ip_prefix_length, as: 'ipPrefixLength' - property :private_ipv6_google_access, as: 'privateIpv6GoogleAccess' property :region, as: 'region' property :requested_address, as: 'requestedAddress' property :subnetwork, as: 'subnetwork' diff --git a/generated/google/apis/speech_v1p1beta1.rb b/generated/google/apis/speech_v1p1beta1.rb index b3f487375..afeea6661 100644 --- a/generated/google/apis/speech_v1p1beta1.rb +++ b/generated/google/apis/speech_v1p1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/speech-to-text/docs/quickstart-protocol module SpeechV1p1beta1 VERSION = 'V1p1beta1' - REVISION = '20200824' + REVISION = '20200827' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/sql_v1beta4.rb b/generated/google/apis/sql_v1beta4.rb index dadd8285d..d1e347027 100644 --- a/generated/google/apis/sql_v1beta4.rb +++ b/generated/google/apis/sql_v1beta4.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/cloud-sql/ module SqlV1beta4 VERSION = 'V1beta4' - REVISION = '20200820' + REVISION = '20200828' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/storage_v1.rb b/generated/google/apis/storage_v1.rb index d82da2046..7cb269b27 100644 --- a/generated/google/apis/storage_v1.rb +++ b/generated/google/apis/storage_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/storage/docs/json_api/ module StorageV1 VERSION = 'V1' - REVISION = '20200727' + REVISION = '20200814' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/storagetransfer_v1.rb b/generated/google/apis/storagetransfer_v1.rb index 9a7558f3a..e54394c4b 100644 --- a/generated/google/apis/storagetransfer_v1.rb +++ b/generated/google/apis/storagetransfer_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/storage-transfer/docs module StoragetransferV1 VERSION = 'V1' - REVISION = '20200807' + REVISION = '20200827' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/sts_v1.rb b/generated/google/apis/sts_v1.rb new file mode 100644 index 000000000..012b26ebb --- /dev/null +++ b/generated/google/apis/sts_v1.rb @@ -0,0 +1,32 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/sts_v1/service.rb' +require 'google/apis/sts_v1/classes.rb' +require 'google/apis/sts_v1/representations.rb' + +module Google + module Apis + # Security Token Service API + # + # The Security Token Service exchanges Google or third-party credentials for a + # short-lived access token to Google Cloud resources. + # + # @see http://cloud.google.com/iam/docs/workload-identity-federation + module StsV1 + VERSION = 'V1' + REVISION = '20200908' + end + end +end diff --git a/generated/google/apis/sts_v1/classes.rb b/generated/google/apis/sts_v1/classes.rb new file mode 100644 index 000000000..dcf4e8b59 --- /dev/null +++ b/generated/google/apis/sts_v1/classes.rb @@ -0,0 +1,120 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module StsV1 + + # Request message for ExchangeToken. + class GoogleIdentityStsV1ExchangeTokenRequest + include Google::Apis::Core::Hashable + + # Required. The grant type. Must be `urn:ietf:params:oauth:grant-type:token- + # exchange`, which indicates a token exchange is requested. + # Corresponds to the JSON property `grantType` + # @return [String] + attr_accessor :grant_type + + # A set of features that Security Token Service supports, in addition to the + # standard OAuth 2.0 token exchange, formatted as a serialized JSON object of + # Options. + # Corresponds to the JSON property `options` + # @return [String] + attr_accessor :options + + # Required. An identifier for the type of requested security token. Must be `urn: + # ietf:params:oauth:token-type:access_token`. + # Corresponds to the JSON property `requestedTokenType` + # @return [String] + attr_accessor :requested_token_type + + # Required. Input subject token. You can use a Google-issued OAuth 2.0 access + # token with this field to obtain an access token with new security attributes + # applied, such as an AccessBoundary. Applying additional security attributes on + # access tokens that already contain security attributes is not allowed. + # Corresponds to the JSON property `subjectToken` + # @return [String] + attr_accessor :subject_token + + # Required. An identifier that indicates the type of the security token in the ` + # subject_token` parameter. Must be `urn:ietf:params:oauth:token-type: + # access_token`. + # Corresponds to the JSON property `subjectTokenType` + # @return [String] + attr_accessor :subject_token_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @grant_type = args[:grant_type] if args.key?(:grant_type) + @options = args[:options] if args.key?(:options) + @requested_token_type = args[:requested_token_type] if args.key?(:requested_token_type) + @subject_token = args[:subject_token] if args.key?(:subject_token) + @subject_token_type = args[:subject_token_type] if args.key?(:subject_token_type) + end + end + + # Response message for ExchangeToken. + class GoogleIdentityStsV1ExchangeTokenResponse + include Google::Apis::Core::Hashable + + # An OAuth 2.0 security token, issued by Google, in response to the token + # exchange request. + # Corresponds to the JSON property `access_token` + # @return [String] + attr_accessor :access_token + + # The expiration time of `access_token` in seconds, measured from the time of + # issuance. This field is absent when the `subject_token` in the request is a + # Google-issued, short-lived access token. In this case, the expiration time of + # the `access_token` is the same as the `subject_token`. + # Corresponds to the JSON property `expires_in` + # @return [Fixnum] + attr_accessor :expires_in + + # The token type. Always matches the value of `requested_token_type` from the + # request. + # Corresponds to the JSON property `issued_token_type` + # @return [String] + attr_accessor :issued_token_type + + # The type of `access_token`. Always has the value `Bearer`. + # Corresponds to the JSON property `token_type` + # @return [String] + attr_accessor :token_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @access_token = args[:access_token] if args.key?(:access_token) + @expires_in = args[:expires_in] if args.key?(:expires_in) + @issued_token_type = args[:issued_token_type] if args.key?(:issued_token_type) + @token_type = args[:token_type] if args.key?(:token_type) + end + end + end + end +end diff --git a/generated/google/apis/sts_v1/representations.rb b/generated/google/apis/sts_v1/representations.rb new file mode 100644 index 000000000..856fb7353 --- /dev/null +++ b/generated/google/apis/sts_v1/representations.rb @@ -0,0 +1,59 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module StsV1 + + class GoogleIdentityStsV1ExchangeTokenRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleIdentityStsV1ExchangeTokenResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleIdentityStsV1ExchangeTokenRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :grant_type, as: 'grantType' + property :options, as: 'options' + property :requested_token_type, as: 'requestedTokenType' + property :subject_token, as: 'subjectToken' + property :subject_token_type, as: 'subjectTokenType' + end + end + + class GoogleIdentityStsV1ExchangeTokenResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :access_token, as: 'access_token' + property :expires_in, as: 'expires_in' + property :issued_token_type, as: 'issued_token_type' + property :token_type, as: 'token_type' + end + end + end + end +end diff --git a/generated/google/apis/sts_v1/service.rb b/generated/google/apis/sts_v1/service.rb new file mode 100644 index 000000000..b17b2433e --- /dev/null +++ b/generated/google/apis/sts_v1/service.rb @@ -0,0 +1,90 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module StsV1 + # Security Token Service API + # + # The Security Token Service exchanges Google or third-party credentials for a + # short-lived access token to Google Cloud resources. + # + # @example + # require 'google/apis/sts_v1' + # + # Sts = Google::Apis::StsV1 # Alias the module + # service = Sts::CloudSecurityTokenService.new + # + # @see http://cloud.google.com/iam/docs/workload-identity-federation + class CloudSecurityTokenService < Google::Apis::Core::BaseService + # @return [String] + # 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. + attr_accessor :key + + # @return [String] + # 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. + attr_accessor :quota_user + + def initialize + super('https://sts.googleapis.com/', '') + @batch_path = 'batch' + end + + # Exchanges a credential for a Google OAuth 2.0 access token. + # @param [Google::Apis::StsV1::GoogleIdentityStsV1ExchangeTokenRequest] google_identity_sts_v1_exchange_token_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::StsV1::GoogleIdentityStsV1ExchangeTokenResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::StsV1::GoogleIdentityStsV1ExchangeTokenResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def token(google_identity_sts_v1_exchange_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/token', options) + command.request_representation = Google::Apis::StsV1::GoogleIdentityStsV1ExchangeTokenRequest::Representation + command.request_object = google_identity_sts_v1_exchange_token_request_object + command.response_representation = Google::Apis::StsV1::GoogleIdentityStsV1ExchangeTokenResponse::Representation + command.response_class = Google::Apis::StsV1::GoogleIdentityStsV1ExchangeTokenResponse + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/sts_v1beta.rb b/generated/google/apis/sts_v1beta.rb new file mode 100644 index 000000000..63d20bb9b --- /dev/null +++ b/generated/google/apis/sts_v1beta.rb @@ -0,0 +1,32 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/sts_v1beta/service.rb' +require 'google/apis/sts_v1beta/classes.rb' +require 'google/apis/sts_v1beta/representations.rb' + +module Google + module Apis + # Security Token Service API + # + # The Security Token Service exchanges Google or third-party credentials for a + # short-lived access token to Google Cloud resources. + # + # @see http://cloud.google.com/iam/docs/workload-identity-federation + module StsV1beta + VERSION = 'V1beta' + REVISION = '20200908' + end + end +end diff --git a/generated/google/apis/sts_v1beta/classes.rb b/generated/google/apis/sts_v1beta/classes.rb new file mode 100644 index 000000000..80a20abd6 --- /dev/null +++ b/generated/google/apis/sts_v1beta/classes.rb @@ -0,0 +1,191 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module StsV1beta + + # Request message for ExchangeToken. + class GoogleIdentityStsV1betaExchangeTokenRequest + include Google::Apis::Core::Hashable + + # The full resource name of the identity provider; for example: `https://iam. + # googleapis.com/projects/`PROJECT_ID`/workloadIdentityPools/`POOL_ID`/providers/ + # `PROVIDER_ID``. Required when exchanging an external credential for a Google + # access token. + # Corresponds to the JSON property `audience` + # @return [String] + attr_accessor :audience + + # Required. The grant type. Must be `urn:ietf:params:oauth:grant-type:token- + # exchange`, which indicates a token exchange is requested. + # Corresponds to the JSON property `grantType` + # @return [String] + attr_accessor :grant_type + + # A set of features that Security Token Service supports, in addition to the + # standard OAuth 2.0 token exchange, formatted as a serialized JSON object of + # Options. + # Corresponds to the JSON property `options` + # @return [String] + attr_accessor :options + + # Required. An identifier for the type of requested security token. Must be `urn: + # ietf:params:oauth:token-type:access_token`. + # Corresponds to the JSON property `requestedTokenType` + # @return [String] + attr_accessor :requested_token_type + + # The OAuth 2.0 scopes to include on the resulting access token, formatted as a + # list of space-delimited, case-sensitive strings. Required when exchanging an + # external credential for a Google access token. + # Corresponds to the JSON property `scope` + # @return [String] + attr_accessor :scope + + # Required. The input token. This is a either an external credential issued by a + # WorkloadIdentityPoolProvider, or a short-lived access token issued by Google. + # If the token is an OIDC JWT, it must use the JWT format defined in [RFC 7523]( + # https://tools.ietf.org/html/rfc7523), and `subject_token_type` must be `urn: + # ietf:params:oauth:token-type:jwt`. The following headers are required: - **` + # kid`**: The identifier of the signing key securing the JWT. - **`alg`**: The + # cryptographic algorithm securing the JWT. Must be `RS256`. The following + # payload fields are required. For more information, see [RFC 7523, Section 3]( + # https://tools.ietf.org/html/rfc7523#section-3). - **`iss`**: The issuer of the + # token. The issuer must provide a discovery document at `/.well-known/openid- + # configuration`, formatted according to section 4.2 of the [OIDC 1.0 Discovery + # specification](https://openid.net/specs/openid-connect-discovery-1_0.html# + # ProviderConfigurationResponse). - **`iat`**: The issue time, in seconds, since + # epoch. Must be in the past. - **`exp`**: The expiration time, in seconds, + # since epoch. Must be fewer than 48 hours after `iat`. Shorter expiration times + # are more. secure. If possible, we recommend setting an expiration time fewer + # than 6 hours. - **`sub`**: The identity asserted in the JWT. - **`aud`**: + # Configured by the mapper policy. The default value is the service account's + # unique ID. Example header: ``` ` "alg": "RS256", "kid": "us-east-11" ` ``` + # Example payload: ``` ` "iss": "https://accounts.google.com", "iat": 1517963104, + # "exp": 1517966704, "aud": "113475438248934895348", "sub": " + # 113475438248934895348", "my_claims": ` "additional_claim": "value" ` ` ``` If ` + # subject_token` is an AWS token, it must be a serialized, [signed](https://docs. + # aws.amazon.com/general/latest/gr/signing_aws_api_requests.html) request to the + # AWS [`GetCallerIdentity()`](https://docs.aws.amazon.com/STS/latest/ + # APIReference/API_GetCallerIdentity) method. Format the request as URL-encoded + # JSON, and set the `subject_token_type` parameter to `urn:ietf:params:aws:token- + # type:aws4_request`. The following parameters are required: - **`url`**: The + # URL of the AWS STS endpoint for `GetCallerIdentity()`, such as `https://sts. + # amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15`. Regional endpoints + # are also supported. - **`method`:** The HTTP request method: `POST`. - **` + # headers`**: The HTTP request headers, which must include: - **`Authorization`** + # : The request signature. - **`x-amz-date`**`: The time you will send the + # request, formatted as an [ISO8601 Basic](https://docs.aws.amazon.com/general/ + # latest/gr/sigv4_elements.html#sigv4_elements_date) string. This is typically + # set to the current time, and used to prevent replay attacks. - **`host`**: The + # hostname of the `url` field; for example, `sts.amazonaws.com`. - **`x-goog- + # cloud-target-resource`**: The full, canonical resource name of the + # WorkloadIdentityPoolProvider, with or without the HTTPS prefix. For example: `` + # ` //iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ + # https://iam.googleapis.com/projects//locations//workloadIdentityPools// + # providers/ ``` Signing this header as part of the signature is recommended to + # ensure data integrity. If you are using temporary security credentials + # provided by AWS, you must also include the header `x-amz-security-token`, with + # the value `[SESSION_TOKEN]`. The following is an example of a signed, + # serialized request: ``` ` "headers":[ `"key": "x-amz-date", "value": " + # 20200815T015049Z"`, `"key": "Authorization", "value": "AWS4-HMAC-SHA256+ + # Credential=$credential,+SignedHeaders=host;x-amz-date;x-goog-cloud-target- + # resource,+Signature=$signature"`, `"key": "x-goog-cloud-target-resource", " + # value": "//iam.googleapis.com/projects//locations//workloadIdentityPools// + # providers/"`, `"key": "host", "value": "sts.amazonaws.com"` . ], "method":" + # POST", "url":"https://sts.amazonaws.com?Action=GetCallerIdentity&Version=2011- + # 06-15" ` ``` You can also use a Google-issued OAuth 2.0 access token with this + # field to obtain an access token with new security attributes applied, such as + # an AccessBoundary. In this case, set `subject_token_type` to `urn:ietf:params: + # oauth:token-type:access_token`. Applying additional security attributes on + # access tokens that already contain security attributes is not allowed. + # Corresponds to the JSON property `subjectToken` + # @return [String] + attr_accessor :subject_token + + # Required. An identifier that indicates the type of the security token in the ` + # subject_token` parameter. Supported values are `urn:ietf:params:oauth:token- + # type:jwt`, `urn:ietf:params:aws:token-type:aws4_request` and `urn:ietf:params: + # oauth:token-type:access_token`. + # Corresponds to the JSON property `subjectTokenType` + # @return [String] + attr_accessor :subject_token_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audience = args[:audience] if args.key?(:audience) + @grant_type = args[:grant_type] if args.key?(:grant_type) + @options = args[:options] if args.key?(:options) + @requested_token_type = args[:requested_token_type] if args.key?(:requested_token_type) + @scope = args[:scope] if args.key?(:scope) + @subject_token = args[:subject_token] if args.key?(:subject_token) + @subject_token_type = args[:subject_token_type] if args.key?(:subject_token_type) + end + end + + # Response message for ExchangeToken. + class GoogleIdentityStsV1betaExchangeTokenResponse + include Google::Apis::Core::Hashable + + # An OAuth 2.0 security token, issued by Google, in response to the token + # exchange request. + # Corresponds to the JSON property `access_token` + # @return [String] + attr_accessor :access_token + + # The expiration time of `access_token`, in seconds, from the time of issuance. + # This field is absent when the `subject_token` in the request is a Google- + # issued, short-lived access token. In this case, the expiration time of the ` + # access_token` is the same as the `subject_token`. + # Corresponds to the JSON property `expires_in` + # @return [Fixnum] + attr_accessor :expires_in + + # The token type. Always matches the value of `requested_token_type` from the + # request. + # Corresponds to the JSON property `issued_token_type` + # @return [String] + attr_accessor :issued_token_type + + # The type of `access_token`. Always has the value `Bearer`. + # Corresponds to the JSON property `token_type` + # @return [String] + attr_accessor :token_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @access_token = args[:access_token] if args.key?(:access_token) + @expires_in = args[:expires_in] if args.key?(:expires_in) + @issued_token_type = args[:issued_token_type] if args.key?(:issued_token_type) + @token_type = args[:token_type] if args.key?(:token_type) + end + end + end + end +end diff --git a/generated/google/apis/sts_v1beta/representations.rb b/generated/google/apis/sts_v1beta/representations.rb new file mode 100644 index 000000000..cebb067f2 --- /dev/null +++ b/generated/google/apis/sts_v1beta/representations.rb @@ -0,0 +1,61 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module StsV1beta + + class GoogleIdentityStsV1betaExchangeTokenRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleIdentityStsV1betaExchangeTokenResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleIdentityStsV1betaExchangeTokenRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :audience, as: 'audience' + property :grant_type, as: 'grantType' + property :options, as: 'options' + property :requested_token_type, as: 'requestedTokenType' + property :scope, as: 'scope' + property :subject_token, as: 'subjectToken' + property :subject_token_type, as: 'subjectTokenType' + end + end + + class GoogleIdentityStsV1betaExchangeTokenResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :access_token, as: 'access_token' + property :expires_in, as: 'expires_in' + property :issued_token_type, as: 'issued_token_type' + property :token_type, as: 'token_type' + end + end + end + end +end diff --git a/generated/google/apis/sts_v1beta/service.rb b/generated/google/apis/sts_v1beta/service.rb new file mode 100644 index 000000000..f5349e8a5 --- /dev/null +++ b/generated/google/apis/sts_v1beta/service.rb @@ -0,0 +1,92 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module StsV1beta + # Security Token Service API + # + # The Security Token Service exchanges Google or third-party credentials for a + # short-lived access token to Google Cloud resources. + # + # @example + # require 'google/apis/sts_v1beta' + # + # Sts = Google::Apis::StsV1beta # Alias the module + # service = Sts::CloudSecurityTokenService.new + # + # @see http://cloud.google.com/iam/docs/workload-identity-federation + class CloudSecurityTokenService < Google::Apis::Core::BaseService + # @return [String] + # 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. + attr_accessor :key + + # @return [String] + # 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. + attr_accessor :quota_user + + def initialize + super('https://sts.googleapis.com/', '') + @batch_path = 'batch' + end + + # Exchanges a credential for a Google OAuth 2.0 access token. The token asserts + # an external identity within a WorkloadIdentityPool, or applies an Access + # Boundary on a Google access token. + # @param [Google::Apis::StsV1beta::GoogleIdentityStsV1betaExchangeTokenRequest] google_identity_sts_v1beta_exchange_token_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::StsV1beta::GoogleIdentityStsV1betaExchangeTokenResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::StsV1beta::GoogleIdentityStsV1betaExchangeTokenResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def token(google_identity_sts_v1beta_exchange_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta/token', options) + command.request_representation = Google::Apis::StsV1beta::GoogleIdentityStsV1betaExchangeTokenRequest::Representation + command.request_object = google_identity_sts_v1beta_exchange_token_request_object + command.response_representation = Google::Apis::StsV1beta::GoogleIdentityStsV1betaExchangeTokenResponse::Representation + command.response_class = Google::Apis::StsV1beta::GoogleIdentityStsV1betaExchangeTokenResponse + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/texttospeech_v1beta1.rb b/generated/google/apis/texttospeech_v1beta1.rb index b180825f8..fa38dd737 100644 --- a/generated/google/apis/texttospeech_v1beta1.rb +++ b/generated/google/apis/texttospeech_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/text-to-speech/ module TexttospeechV1beta1 VERSION = 'V1beta1' - REVISION = '20200814' + REVISION = '20200902' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/tpu_v1.rb b/generated/google/apis/tpu_v1.rb index 98e0dd06d..a0f7fa856 100644 --- a/generated/google/apis/tpu_v1.rb +++ b/generated/google/apis/tpu_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/tpu/ module TpuV1 VERSION = 'V1' - REVISION = '20200814' + REVISION = '20200909' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/tpu_v1/classes.rb b/generated/google/apis/tpu_v1/classes.rb index fdaa15a5b..d16f15e46 100644 --- a/generated/google/apis/tpu_v1/classes.rb +++ b/generated/google/apis/tpu_v1/classes.rb @@ -374,6 +374,11 @@ module Google # @return [String] attr_accessor :state + # Output only. The Symptoms that have occurred to the TPU Node. + # Corresponds to the JSON property `symptoms` + # @return [Array] + attr_accessor :symptoms + # The version of Tensorflow running in the Node. Required. # Corresponds to the JSON property `tensorflowVersion` # @return [String] @@ -410,6 +415,7 @@ module Google @scheduling_config = args[:scheduling_config] if args.key?(:scheduling_config) @service_account = args[:service_account] if args.key?(:service_account) @state = args[:state] if args.key?(:state) + @symptoms = args[:symptoms] if args.key?(:symptoms) @tensorflow_version = args[:tensorflow_version] if args.key?(:tensorflow_version) @use_service_networking = args[:use_service_networking] if args.key?(:use_service_networking) end @@ -647,6 +653,43 @@ module Google end end + # A Symptom instance. + class Symptom + include Google::Apis::Core::Hashable + + # Timestamp when the Symptom is created. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Detailed information of the current Symptom. + # Corresponds to the JSON property `details` + # @return [String] + attr_accessor :details + + # Type of the Symptom. + # Corresponds to the JSON property `symptomType` + # @return [String] + attr_accessor :symptom_type + + # A string used to uniquely distinguish a worker within a TPU node. + # Corresponds to the JSON property `workerId` + # @return [String] + attr_accessor :worker_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @create_time = args[:create_time] if args.key?(:create_time) + @details = args[:details] if args.key?(:details) + @symptom_type = args[:symptom_type] if args.key?(:symptom_type) + @worker_id = args[:worker_id] if args.key?(:worker_id) + end + end + # A tensorflow version that a Node can be configured with. class TensorFlowVersion include Google::Apis::Core::Hashable diff --git a/generated/google/apis/tpu_v1/representations.rb b/generated/google/apis/tpu_v1/representations.rb index 148a4513d..3aff9edb7 100644 --- a/generated/google/apis/tpu_v1/representations.rb +++ b/generated/google/apis/tpu_v1/representations.rb @@ -124,6 +124,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Symptom + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class TensorFlowVersion class Representation < Google::Apis::Core::JsonRepresentation; end @@ -231,6 +237,8 @@ module Google property :service_account, as: 'serviceAccount' property :state, as: 'state' + collection :symptoms, as: 'symptoms', class: Google::Apis::TpuV1::Symptom, decorator: Google::Apis::TpuV1::Symptom::Representation + property :tensorflow_version, as: 'tensorflowVersion' property :use_service_networking, as: 'useServiceNetworking' end @@ -297,6 +305,16 @@ module Google end end + class Symptom + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :create_time, as: 'createTime' + property :details, as: 'details' + property :symptom_type, as: 'symptomType' + property :worker_id, as: 'workerId' + end + end + class TensorFlowVersion # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/tpu_v1alpha1.rb b/generated/google/apis/tpu_v1alpha1.rb index a8ac112b8..1c7fb6541 100644 --- a/generated/google/apis/tpu_v1alpha1.rb +++ b/generated/google/apis/tpu_v1alpha1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/tpu/ module TpuV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200814' + REVISION = '20200909' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/tpu_v1alpha1/classes.rb b/generated/google/apis/tpu_v1alpha1/classes.rb index 4a7f40a6c..c70a36b86 100644 --- a/generated/google/apis/tpu_v1alpha1/classes.rb +++ b/generated/google/apis/tpu_v1alpha1/classes.rb @@ -374,6 +374,11 @@ module Google # @return [String] attr_accessor :state + # Output only. The Symptoms that have occurred to the TPU Node. + # Corresponds to the JSON property `symptoms` + # @return [Array] + attr_accessor :symptoms + # The version of Tensorflow running in the Node. Required. # Corresponds to the JSON property `tensorflowVersion` # @return [String] @@ -410,6 +415,7 @@ module Google @scheduling_config = args[:scheduling_config] if args.key?(:scheduling_config) @service_account = args[:service_account] if args.key?(:service_account) @state = args[:state] if args.key?(:state) + @symptoms = args[:symptoms] if args.key?(:symptoms) @tensorflow_version = args[:tensorflow_version] if args.key?(:tensorflow_version) @use_service_networking = args[:use_service_networking] if args.key?(:use_service_networking) end @@ -647,6 +653,43 @@ module Google end end + # A Symptom instance. + class Symptom + include Google::Apis::Core::Hashable + + # Timestamp when the Symptom is created. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Detailed information of the current Symptom. + # Corresponds to the JSON property `details` + # @return [String] + attr_accessor :details + + # Type of the Symptom. + # Corresponds to the JSON property `symptomType` + # @return [String] + attr_accessor :symptom_type + + # A string used to uniquely distinguish a worker within a TPU node. + # Corresponds to the JSON property `workerId` + # @return [String] + attr_accessor :worker_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @create_time = args[:create_time] if args.key?(:create_time) + @details = args[:details] if args.key?(:details) + @symptom_type = args[:symptom_type] if args.key?(:symptom_type) + @worker_id = args[:worker_id] if args.key?(:worker_id) + end + end + # A tensorflow version that a Node can be configured with. class TensorFlowVersion include Google::Apis::Core::Hashable diff --git a/generated/google/apis/tpu_v1alpha1/representations.rb b/generated/google/apis/tpu_v1alpha1/representations.rb index 297447d29..ce266cb8b 100644 --- a/generated/google/apis/tpu_v1alpha1/representations.rb +++ b/generated/google/apis/tpu_v1alpha1/representations.rb @@ -124,6 +124,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Symptom + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class TensorFlowVersion class Representation < Google::Apis::Core::JsonRepresentation; end @@ -231,6 +237,8 @@ module Google property :service_account, as: 'serviceAccount' property :state, as: 'state' + collection :symptoms, as: 'symptoms', class: Google::Apis::TpuV1alpha1::Symptom, decorator: Google::Apis::TpuV1alpha1::Symptom::Representation + property :tensorflow_version, as: 'tensorflowVersion' property :use_service_networking, as: 'useServiceNetworking' end @@ -297,6 +305,16 @@ module Google end end + class Symptom + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :create_time, as: 'createTime' + property :details, as: 'details' + property :symptom_type, as: 'symptomType' + property :worker_id, as: 'workerId' + end + end + class TensorFlowVersion # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/vault_v1.rb b/generated/google/apis/vault_v1.rb index b619c3411..3048cb28f 100644 --- a/generated/google/apis/vault_v1.rb +++ b/generated/google/apis/vault_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/vault module VaultV1 VERSION = 'V1' - REVISION = '20200501' + REVISION = '20200901' # Manage your eDiscovery data AUTH_EDISCOVERY = 'https://www.googleapis.com/auth/ediscovery' diff --git a/generated/google/apis/vault_v1/classes.rb b/generated/google/apis/vault_v1/classes.rb index 44697c24d..ff9245af3 100644 --- a/generated/google/apis/vault_v1/classes.rb +++ b/generated/google/apis/vault_v1/classes.rb @@ -41,23 +41,23 @@ module Google end end - # A status detailing the status of each account creation, and the - # HeldAccount, if successful. + # A status detailing the status of each account creation, and the HeldAccount, + # if successful. class AddHeldAccountResult include Google::Apis::Core::Hashable - # An account being held in a particular hold. This structure is immutable. - # This can be either a single user or a google group, depending on the corpus. + # An account being held in a particular hold. This structure is immutable. This + # can be either a single user or a google group, depending on the corpus. # Corresponds to the JSON property `account` # @return [Google::Apis::VaultV1::HeldAccount] attr_accessor :account - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). # Corresponds to the JSON property `status` # @return [Google::Apis::VaultV1::Status] attr_accessor :status @@ -77,8 +77,8 @@ module Google class AddHeldAccountsRequest include Google::Apis::Core::Hashable - # Account IDs to identify which accounts to add. Only account_ids or only - # emails should be specified, but not both. + # Account IDs to identify which accounts to add. Only account_ids or only emails + # should be specified, but not both. # Corresponds to the JSON property `accountIds` # @return [Array] attr_accessor :account_ids @@ -119,29 +119,27 @@ module Google end end - # Add an account with the permission specified. The role cannot be owner. - # If an account already has a role in the matter, it will be - # overwritten. + # Add an account with the permission specified. The role cannot be owner. If an + # account already has a role in the matter, it will be overwritten. class AddMatterPermissionsRequest include Google::Apis::Core::Hashable - # Only relevant if send_emails is true. - # True to CC requestor in the email message. - # False to not CC requestor. + # Only relevant if send_emails is true. True to CC requestor in the email + # message. False to not CC requestor. # Corresponds to the JSON property `ccMe` # @return [Boolean] attr_accessor :cc_me alias_method :cc_me?, :cc_me # Currently each matter only has one owner, and all others are collaborators. - # When an account is purged, its corresponding MatterPermission resources - # cease to exist. + # When an account is purged, its corresponding MatterPermission resources cease + # to exist. # Corresponds to the JSON property `matterPermission` # @return [Google::Apis::VaultV1::MatterPermission] attr_accessor :matter_permission - # True to send notification email to the added account. - # False to not send notification email. + # True to send notification email to the added account. False to not send + # notification email. # Corresponds to the JSON property `sendEmails` # @return [Boolean] attr_accessor :send_emails @@ -195,11 +193,9 @@ module Google class CloudStorageFile include Google::Apis::Core::Hashable - # The cloud storage bucket name of this export file. - # Can be used in cloud storage JSON/XML API, but not to list the bucket - # contents. Instead, you can - # get individual export files by object name. + # The cloud storage bucket name of this export file. Can be used in cloud + # storage JSON/XML API, but not to list the bucket contents. Instead, you can + # get individual export files by object name. # Corresponds to the JSON property `bucketName` # @return [String] attr_accessor :bucket_name @@ -209,8 +205,8 @@ module Google # @return [String] attr_accessor :md5_hash - # The cloud storage object name of this export file. - # Can be used in cloud storage JSON/XML API. + # The cloud storage object name of this export file. Can be used in cloud + # storage JSON/XML API. # Corresponds to the JSON property `objectName` # @return [String] attr_accessor :object_name @@ -293,10 +289,8 @@ module Google class DriveExportOptions include Google::Apis::Core::Hashable - # Set to true to include access level information for users - # with indirect - # access to files. + # Set to true to include access level information for users with indirect access + # to files. # Corresponds to the JSON property `includeAccessInfo` # @return [Boolean] attr_accessor :include_access_info @@ -328,9 +322,8 @@ module Google attr_accessor :include_team_drives alias_method :include_team_drives?, :include_team_drives - # Search the versions of the Drive file - # as of the reference date. These timestamps are in GMT and - # rounded down to the given date. + # Search the versions of the Drive file as of the reference date. These + # timestamps are in GMT and rounded down to the given date. # Corresponds to the JSON property `versionDate` # @return [String] attr_accessor :version_date @@ -347,13 +340,11 @@ module Google end end - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. class Empty include Google::Apis::Core::Hashable @@ -590,13 +581,12 @@ module Google end end - # An account being held in a particular hold. This structure is immutable. - # This can be either a single user or a google group, depending on the corpus. + # An account being held in a particular hold. This structure is immutable. This + # can be either a single user or a google group, depending on the corpus. class HeldAccount include Google::Apis::Core::Hashable - # The account's ID as provided by the - # Admin SDK. + # The account's ID as provided by the Admin SDK. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id @@ -749,8 +739,8 @@ module Google end end - # A organizational unit being held in a particular hold. - # This structure is immutable. + # A organizational unit being held in a particular hold. This structure is + # immutable. class HeldOrgUnit include Google::Apis::Core::Hashable @@ -775,15 +765,14 @@ module Google end end - # Represents a hold within Vault. A hold restricts purging of - # artifacts based on the combination of the query and accounts restrictions. - # A hold can be configured to either apply to an explicitly configured set - # of accounts, or can be applied to all members of an organizational unit. + # Represents a hold within Vault. A hold restricts purging of artifacts based on + # the combination of the query and accounts restrictions. A hold can be + # configured to either apply to an explicitly configured set of accounts, or can + # be applied to all members of an organizational unit. class Hold include Google::Apis::Core::Hashable - # If set, the hold applies to the enumerated accounts and org_unit must be - # empty. + # If set, the hold applies to the enumerated accounts and org_unit must be empty. # Corresponds to the JSON property `accounts` # @return [Array] attr_accessor :accounts @@ -803,8 +792,8 @@ module Google # @return [String] attr_accessor :name - # A organizational unit being held in a particular hold. - # This structure is immutable. + # A organizational unit being held in a particular hold. This structure is + # immutable. # Corresponds to the JSON property `orgUnit` # @return [Google::Apis::VaultV1::HeldOrgUnit] attr_accessor :org_unit @@ -888,8 +877,8 @@ module Google # @return [Array] attr_accessor :holds - # Page token to retrieve the next page of results in the list. - # If this is empty, then there are no more holds to list. + # Page token to retrieve the next page of results in the list. If this is empty, + # then there are no more holds to list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -934,8 +923,8 @@ module Google class ListSavedQueriesResponse include Google::Apis::Core::Hashable - # Page token to retrieve the next page of results in the list. - # If this is empty, then there are no more saved queries to list. + # Page token to retrieve the next page of results in the list. If this is empty, + # then there are no more saved queries to list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1011,8 +1000,8 @@ module Google # @return [String] attr_accessor :description - # The matter ID which is generated by the server. - # Should be blank when creating a new matter. + # The matter ID which is generated by the server. Should be blank when creating + # a new matter. # Corresponds to the JSON property `matterId` # @return [String] attr_accessor :matter_id @@ -1048,13 +1037,12 @@ module Google end # Currently each matter only has one owner, and all others are collaborators. - # When an account is purged, its corresponding MatterPermission resources - # cease to exist. + # When an account is purged, its corresponding MatterPermission resources cease + # to exist. class MatterPermission include Google::Apis::Core::Hashable - # The account ID, as provided by Admin SDK. + # The account ID, as provided by Admin SDK. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id @@ -1079,9 +1067,7 @@ module Google class OrgUnitInfo include Google::Apis::Core::Hashable - # Org unit to search, as provided by the - # Admin SDK - # Directory API. + # Org unit to search, as provided by the Admin SDK Directory API. # Corresponds to the JSON property `orgUnitId` # @return [String] attr_accessor :org_unit_id @@ -1141,10 +1127,10 @@ module Google # @return [Google::Apis::VaultV1::MailOptions] attr_accessor :mail_options - # The search method to use. This field is similar to the search_method field - # but is introduced to support shared drives. It supports all - # search method types. In case the search_method is TEAM_DRIVE the response - # of this field will be SHARED_DRIVE only. + # The search method to use. This field is similar to the search_method field but + # is introduced to support shared drives. It supports all search method types. + # In case the search_method is TEAM_DRIVE the response of this field will be + # SHARED_DRIVE only. # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -1175,18 +1161,13 @@ module Google # @return [Google::Apis::VaultV1::TeamDriveInfo] attr_accessor :team_drive_info - # The corpus-specific - # search - # operators used to generate search results. + # The corpus-specific search operators used to generate search results. # Corresponds to the JSON property `terms` # @return [String] attr_accessor :terms - # The time zone name. - # It should be an IANA TZ name, such as "America/Los_Angeles". - # For more information, see - # Time - # Zone. + # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles" + # . For more information, see Time Zone. # Corresponds to the JSON property `timeZone` # @return [String] attr_accessor :time_zone @@ -1239,8 +1220,8 @@ module Google class RemoveHeldAccountsResponse include Google::Apis::Core::Hashable - # A list of statuses for deleted accounts. Results have the - # same order as the request. + # A list of statuses for deleted accounts. Results have the same order as the + # request. # Corresponds to the JSON property `statuses` # @return [Array] attr_accessor :statuses @@ -1310,8 +1291,7 @@ module Google class SavedQuery include Google::Apis::Core::Hashable - # Output only. The server generated timestamp at which saved query was - # created. + # Output only. The server generated timestamp at which saved query was created. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time @@ -1321,9 +1301,8 @@ module Google # @return [String] attr_accessor :display_name - # Output only. The matter ID of the associated matter. - # The server does not look at this field during create and always uses matter - # id in the URL. + # Output only. The matter ID of the associated matter. The server does not look + # at this field during create and always uses matter id in the URL. # Corresponds to the JSON property `matterId` # @return [String] attr_accessor :matter_id @@ -1356,8 +1335,7 @@ module Google class SharedDriveInfo include Google::Apis::Core::Hashable - # List of Shared drive IDs, as provided by Drive API. + # List of Shared drive IDs, as provided by Drive API. # Corresponds to the JSON property `sharedDriveIds` # @return [Array] attr_accessor :shared_drive_ids @@ -1372,12 +1350,12 @@ module Google end end - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). class Status include Google::Apis::Core::Hashable @@ -1386,15 +1364,15 @@ module Google # @return [Fixnum] attr_accessor :code - # A list of messages that carry the error details. There is a common set of + # A list of messages that carry the error details. There is a common set of # message types for APIs to use. # Corresponds to the JSON property `details` # @return [Array>] attr_accessor :details - # A developer-facing error message, which should be in English. Any - # user-facing error message should be localized and sent in the - # google.rpc.Status.details field, or localized by the client. + # A developer-facing error message, which should be in English. Any user-facing + # error message should be localized and sent in the google.rpc.Status.details + # field, or localized by the client. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -1415,8 +1393,7 @@ module Google class TeamDriveInfo include Google::Apis::Core::Hashable - # List of Team Drive IDs, as provided by Drive API. + # List of Team Drive IDs, as provided by Drive API. # Corresponds to the JSON property `teamDriveIds` # @return [Array] attr_accessor :team_drive_ids diff --git a/generated/google/apis/vault_v1/service.rb b/generated/google/apis/vault_v1/service.rb index 56d646616..f4fa97305 100644 --- a/generated/google/apis/vault_v1/service.rb +++ b/generated/google/apis/vault_v1/service.rb @@ -113,9 +113,9 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new matter with the given name and description. The initial state - # is open, and the owner is the method caller. Returns the created matter - # with default view. + # Creates a new matter with the given name and description. The initial state is + # open, and the owner is the method caller. Returns the created matter with + # default view. # @param [Google::Apis::VaultV1::Matter] matter_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -210,8 +210,7 @@ module Google # Lists matters the user has access to. # @param [Fixnum] page_size - # The number of matters to return in the response. - # Default and maximum are 100. + # The number of matters to return in the response. Default and maximum are 100. # @param [String] page_token # The pagination token as returned in the response. # @param [String] state @@ -348,9 +347,8 @@ module Google execute_or_queue_command(command, &block) end - # Updates the specified matter. - # This updates only the name and description of the matter, identified by - # matter ID. Changes to any other fields are ignored. + # Updates the specified matter. This updates only the name and description of + # the matter, identified by matter ID. Changes to any other fields are ignored. # Returns the default view of the matter. # @param [String] matter_id # The matter ID. @@ -659,16 +657,16 @@ module Google execute_or_queue_command(command, &block) end - # Lists holds within a matter. An empty page token in ListHoldsResponse - # denotes no more holds to list. + # Lists holds within a matter. An empty page token in ListHoldsResponse denotes + # no more holds to list. # @param [String] matter_id # The matter ID. # @param [Fixnum] page_size # The number of holds to return in the response, between 0 and 100 inclusive. # Leaving this empty, or as 0, is the same as page_size = 100. # @param [String] page_token - # The pagination token as returned in the response. - # An empty token means start from the beginning. + # The pagination token as returned in the response. An empty token means start + # from the beginning. # @param [String] view # Specifies which parts of the Hold to return. # @param [String] fields @@ -701,9 +699,9 @@ module Google execute_or_queue_command(command, &block) end - # Removes HeldAccounts from a hold. Returns a list of statuses in the same - # order as the request. If this request leaves the hold with no held - # accounts, the hold will not apply to any accounts. + # Removes HeldAccounts from a hold. Returns a list of statuses in the same order + # as the request. If this request leaves the hold with no held accounts, the + # hold will not apply to any accounts. # @param [String] matter_id # The matter ID. # @param [String] hold_id @@ -739,9 +737,9 @@ module Google execute_or_queue_command(command, &block) end - # Updates the OU and/or query parameters of a hold. You cannot add accounts - # to a hold that covers an OU, nor can you add OUs to a hold that covers - # individual accounts. Accounts listed in the hold will be ignored. + # Updates the OU and/or query parameters of a hold. You cannot add accounts to a + # hold that covers an OU, nor can you add OUs to a hold that covers individual + # accounts. Accounts listed in the hold will be ignored. # @param [String] matter_id # The matter ID. # @param [String] hold_id @@ -777,9 +775,9 @@ module Google execute_or_queue_command(command, &block) end - # Adds a HeldAccount to a hold. Accounts can only be added to a hold that - # has no held_org_unit set. Attempting to add an account to an OU-based - # hold will result in an error. + # Adds a HeldAccount to a hold. Accounts can only be added to a hold that has no + # held_org_unit set. Attempting to add an account to an OU-based hold will + # result in an error. # @param [String] matter_id # The matter ID. # @param [String] hold_id @@ -815,8 +813,8 @@ module Google execute_or_queue_command(command, &block) end - # Removes a HeldAccount from a hold. If this request leaves the hold with - # no held accounts, the hold will not apply to any accounts. + # Removes a HeldAccount from a hold. If this request leaves the hold with no + # held accounts, the hold will not apply to any accounts. # @param [String] matter_id # The matter ID. # @param [String] hold_id @@ -852,10 +850,8 @@ module Google execute_or_queue_command(command, &block) end - # Lists HeldAccounts for a hold. This will only list individually specified - # held accounts. If the hold is on an OU, then use - # Admin SDK - # to enumerate its members. + # Lists HeldAccounts for a hold. This will only list individually specified held + # accounts. If the hold is on an OU, then use Admin SDK to enumerate its members. # @param [String] matter_id # The matter ID. # @param [String] hold_id @@ -890,8 +886,7 @@ module Google # Creates a saved query. # @param [String] matter_id - # The matter ID of the parent matter for which the saved query is to be - # created. + # The matter ID of the parent matter for which the saved query is to be created. # @param [Google::Apis::VaultV1::SavedQuery] saved_query_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -924,8 +919,7 @@ module Google # Deletes a saved query by Id. # @param [String] matter_id - # The matter ID of the parent matter for which the saved query is to be - # deleted. + # The matter ID of the parent matter for which the saved query is to be deleted. # @param [String] saved_query_id # ID of the saved query to be deleted. # @param [String] fields @@ -998,8 +992,8 @@ module Google # @param [Fixnum] page_size # The maximum number of saved queries to return. # @param [String] page_token - # The pagination token as returned in the previous response. - # An empty token means start from the beginning. + # The pagination token as returned in the previous response. An empty token + # means start from the beginning. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1029,10 +1023,10 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a long-running operation. This method indicates that the client is - # no longer interested in the operation result. It does not cancel the - # operation. If the server doesn't support this method, it returns - # `google.rpc.Code.UNIMPLEMENTED`. + # Deletes a long-running operation. This method indicates that the client is no + # longer interested in the operation result. It does not cancel the operation. + # If the server doesn't support this method, it returns `google.rpc.Code. + # UNIMPLEMENTED`. # @param [String] name # The name of the operation resource to be deleted. # @param [String] fields diff --git a/generated/google/apis/verifiedaccess_v1.rb b/generated/google/apis/verifiedaccess_v1.rb index 713e74095..5a315714b 100644 --- a/generated/google/apis/verifiedaccess_v1.rb +++ b/generated/google/apis/verifiedaccess_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/chrome/verified-access module VerifiedaccessV1 VERSION = 'V1' - REVISION = '20200512' + REVISION = '20200828' # Verify your enterprise credentials AUTH_VERIFIEDACCESS = 'https://www.googleapis.com/auth/verifiedaccess' diff --git a/generated/google/apis/verifiedaccess_v1/classes.rb b/generated/google/apis/verifiedaccess_v1/classes.rb index 765a36056..be780601d 100644 --- a/generated/google/apis/verifiedaccess_v1/classes.rb +++ b/generated/google/apis/verifiedaccess_v1/classes.rb @@ -47,13 +47,11 @@ module Google end end - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. class Empty include Google::Apis::Core::Hashable @@ -102,12 +100,11 @@ module Google # @return [Google::Apis::VerifiedaccessV1::SignedData] attr_accessor :challenge_response - # Service can optionally provide identity information about the device - # or user associated with the key. - # For an EMK, this value is the enrolled domain. - # For an EUK, this value is the user's email address. - # If present, this value will be checked against contents - # of the response, and verification will fail if there is no match. + # Service can optionally provide identity information about the device or user + # associated with the key. For an EMK, this value is the enrolled domain. For an + # EUK, this value is the user's email address. If present, this value will be + # checked against contents of the response, and verification will fail if there + # is no match. # Corresponds to the JSON property `expectedIdentity` # @return [String] attr_accessor :expected_identity @@ -127,32 +124,28 @@ module Google class VerifyChallengeResponseResult include Google::Apis::Core::Hashable - # Device enrollment id is returned in this field (for the machine response - # only). + # Device enrollment id is returned in this field (for the machine response only). # Corresponds to the JSON property `deviceEnrollmentId` # @return [String] attr_accessor :device_enrollment_id - # Device permanent id is returned in this field (for the machine response - # only). + # Device permanent id is returned in this field (for the machine response only). # Corresponds to the JSON property `devicePermanentId` # @return [String] attr_accessor :device_permanent_id - # Certificate Signing Request (in the SPKAC format, base64 encoded) is - # returned in this field. This field will be set only if device has included - # CSR in its challenge response. - # (the option to include CSR is now available for both user and machine - # responses) + # Certificate Signing Request (in the SPKAC format, base64 encoded) is returned + # in this field. This field will be set only if device has included CSR in its + # challenge response. (the option to include CSR is now available for both user + # and machine responses) # Corresponds to the JSON property `signedPublicKeyAndChallenge` # @return [String] attr_accessor :signed_public_key_and_challenge - # For EMCert check, device permanent id is returned here. - # For EUCert check, signed_public_key_and_challenge [base64 encoded] - # is returned if present, otherwise empty string is returned. - # This field is deprecated, please use device_permanent_id or - # signed_public_key_and_challenge fields. + # For EMCert check, device permanent id is returned here. For EUCert check, + # signed_public_key_and_challenge [base64 encoded] is returned if present, + # otherwise empty string is returned. This field is deprecated, please use + # device_permanent_id or signed_public_key_and_challenge fields. # Corresponds to the JSON property `verificationOutput` # @return [String] attr_accessor :verification_output diff --git a/generated/google/apis/videointelligence_v1.rb b/generated/google/apis/videointelligence_v1.rb index 93f068a12..3aa472267 100644 --- a/generated/google/apis/videointelligence_v1.rb +++ b/generated/google/apis/videointelligence_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/video-intelligence/docs/ module VideointelligenceV1 VERSION = 'V1' - REVISION = '20200810' + REVISION = '20200831' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/videointelligence_v1/service.rb b/generated/google/apis/videointelligence_v1/service.rb index c85012bd9..d7664c30f 100644 --- a/generated/google/apis/videointelligence_v1/service.rb +++ b/generated/google/apis/videointelligence_v1/service.rb @@ -150,6 +150,37 @@ module Google execute_or_queue_command(command, &block) end + # Gets the latest state of a long-running operation. Clients can use this method + # to poll the operation result at intervals as recommended by the API service. + # @param [String] name + # The name of the operation resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::VideointelligenceV1::GoogleLongrunningOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::VideointelligenceV1::GoogleLongrunningOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_corpora_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::VideointelligenceV1::GoogleLongrunningOperation::Representation + command.response_class = Google::Apis::VideointelligenceV1::GoogleLongrunningOperation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Gets the latest state of a long-running operation. Clients can use this method # to poll the operation result at intervals as recommended by the API service. # @param [String] name diff --git a/generated/google/apis/videointelligence_v1beta2.rb b/generated/google/apis/videointelligence_v1beta2.rb index 1be2e0bf9..b80222e7e 100644 --- a/generated/google/apis/videointelligence_v1beta2.rb +++ b/generated/google/apis/videointelligence_v1beta2.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/video-intelligence/docs/ module VideointelligenceV1beta2 VERSION = 'V1beta2' - REVISION = '20200810' + REVISION = '20200824' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/videointelligence_v1p1beta1.rb b/generated/google/apis/videointelligence_v1p1beta1.rb index 984991fd2..462717ab2 100644 --- a/generated/google/apis/videointelligence_v1p1beta1.rb +++ b/generated/google/apis/videointelligence_v1p1beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/video-intelligence/docs/ module VideointelligenceV1p1beta1 VERSION = 'V1p1beta1' - REVISION = '20200810' + REVISION = '20200824' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/videointelligence_v1p2beta1.rb b/generated/google/apis/videointelligence_v1p2beta1.rb index 5e773dfa6..d89abbe0c 100644 --- a/generated/google/apis/videointelligence_v1p2beta1.rb +++ b/generated/google/apis/videointelligence_v1p2beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/video-intelligence/docs/ module VideointelligenceV1p2beta1 VERSION = 'V1p2beta1' - REVISION = '20200810' + REVISION = '20200824' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/videointelligence_v1p3beta1.rb b/generated/google/apis/videointelligence_v1p3beta1.rb index 47db9346e..f3595b8d5 100644 --- a/generated/google/apis/videointelligence_v1p3beta1.rb +++ b/generated/google/apis/videointelligence_v1p3beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/video-intelligence/docs/ module VideointelligenceV1p3beta1 VERSION = 'V1p3beta1' - REVISION = '20200810' + REVISION = '20200824' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/vision_v1.rb b/generated/google/apis/vision_v1.rb index 41a9cdfed..09b2cfd24 100644 --- a/generated/google/apis/vision_v1.rb +++ b/generated/google/apis/vision_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/vision/ module VisionV1 VERSION = 'V1' - REVISION = '20200801' + REVISION = '20200828' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/vision_v1p1beta1.rb b/generated/google/apis/vision_v1p1beta1.rb index 48ae5b171..d0658f24d 100644 --- a/generated/google/apis/vision_v1p1beta1.rb +++ b/generated/google/apis/vision_v1p1beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/vision/ module VisionV1p1beta1 VERSION = 'V1p1beta1' - REVISION = '20200801' + REVISION = '20200828' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/vision_v1p2beta1.rb b/generated/google/apis/vision_v1p2beta1.rb index 5f57d2d38..f88242521 100644 --- a/generated/google/apis/vision_v1p2beta1.rb +++ b/generated/google/apis/vision_v1p2beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/vision/ module VisionV1p2beta1 VERSION = 'V1p2beta1' - REVISION = '20200801' + REVISION = '20200828' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/workflowexecutions_v1beta.rb b/generated/google/apis/workflowexecutions_v1beta.rb new file mode 100644 index 000000000..d3c289ad6 --- /dev/null +++ b/generated/google/apis/workflowexecutions_v1beta.rb @@ -0,0 +1,34 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/workflowexecutions_v1beta/service.rb' +require 'google/apis/workflowexecutions_v1beta/classes.rb' +require 'google/apis/workflowexecutions_v1beta/representations.rb' + +module Google + module Apis + # Workflow Executions API + # + # Manages user-provided workflows. + # + # @see https://cloud.google.com/workflows + module WorkflowexecutionsV1beta + VERSION = 'V1beta' + REVISION = '20200901' + + # View and manage your data across Google Cloud Platform services + AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' + end + end +end diff --git a/generated/google/apis/workflowexecutions_v1beta/classes.rb b/generated/google/apis/workflowexecutions_v1beta/classes.rb new file mode 100644 index 000000000..3a5324f1a --- /dev/null +++ b/generated/google/apis/workflowexecutions_v1beta/classes.rb @@ -0,0 +1,155 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module WorkflowexecutionsV1beta + + # Request for the CancelExecution method. + class CancelExecutionRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Error describes why the execution was abnormally terminated. + class Error + include Google::Apis::Core::Hashable + + # Human readable error context, helpful for debugging purposes. + # Corresponds to the JSON property `context` + # @return [String] + attr_accessor :context + + # Error payload returned by the execution, represented as a JSON string. + # Corresponds to the JSON property `payload` + # @return [String] + attr_accessor :payload + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @context = args[:context] if args.key?(:context) + @payload = args[:payload] if args.key?(:payload) + end + end + + # A running instance of a [Workflow](/workflows/docs/reference/rest/v1beta/ + # projects.locations.workflows). + class Execution + include Google::Apis::Core::Hashable + + # Input parameters of the execution represented as a JSON string. The size limit + # is 32KB. + # Corresponds to the JSON property `argument` + # @return [String] + attr_accessor :argument + + # Output only. Marks the end of execution, successful or not. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Error describes why the execution was abnormally terminated. + # Corresponds to the JSON property `error` + # @return [Google::Apis::WorkflowexecutionsV1beta::Error] + attr_accessor :error + + # Output only. The resource name of the execution. Format: projects/`project`/ + # locations/`location`/workflows/`workflow`/executions/`execution` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. Output of the execution represented as a JSON string. The value + # can only be present if the execution's state is `SUCCEEDED`. + # Corresponds to the JSON property `result` + # @return [String] + attr_accessor :result + + # Output only. Marks the beginning of execution. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # Output only. Current state of the execution. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # Output only. Revision of the workflow this execution is using. + # Corresponds to the JSON property `workflowRevisionId` + # @return [String] + attr_accessor :workflow_revision_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @argument = args[:argument] if args.key?(:argument) + @end_time = args[:end_time] if args.key?(:end_time) + @error = args[:error] if args.key?(:error) + @name = args[:name] if args.key?(:name) + @result = args[:result] if args.key?(:result) + @start_time = args[:start_time] if args.key?(:start_time) + @state = args[:state] if args.key?(:state) + @workflow_revision_id = args[:workflow_revision_id] if args.key?(:workflow_revision_id) + end + end + + # Response for the ListExecutions method. + class ListExecutionsResponse + include Google::Apis::Core::Hashable + + # The executions which match the request. + # Corresponds to the JSON property `executions` + # @return [Array] + attr_accessor :executions + + # A token, which can be sent as `page_token` to retrieve the next page. If this + # field is omitted, there are no subsequent pages. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @executions = args[:executions] if args.key?(:executions) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + end + end +end diff --git a/generated/google/apis/workflowexecutions_v1beta/representations.rb b/generated/google/apis/workflowexecutions_v1beta/representations.rb new file mode 100644 index 000000000..2f2535b2e --- /dev/null +++ b/generated/google/apis/workflowexecutions_v1beta/representations.rb @@ -0,0 +1,88 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module WorkflowexecutionsV1beta + + class CancelExecutionRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Error + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Execution + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListExecutionsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CancelExecutionRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class Error + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :context, as: 'context' + property :payload, as: 'payload' + end + end + + class Execution + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :argument, as: 'argument' + property :end_time, as: 'endTime' + property :error, as: 'error', class: Google::Apis::WorkflowexecutionsV1beta::Error, decorator: Google::Apis::WorkflowexecutionsV1beta::Error::Representation + + property :name, as: 'name' + property :result, as: 'result' + property :start_time, as: 'startTime' + property :state, as: 'state' + property :workflow_revision_id, as: 'workflowRevisionId' + end + end + + class ListExecutionsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :executions, as: 'executions', class: Google::Apis::WorkflowexecutionsV1beta::Execution, decorator: Google::Apis::WorkflowexecutionsV1beta::Execution::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + end + end +end diff --git a/generated/google/apis/workflowexecutions_v1beta/service.rb b/generated/google/apis/workflowexecutions_v1beta/service.rb new file mode 100644 index 000000000..1f74ccbcf --- /dev/null +++ b/generated/google/apis/workflowexecutions_v1beta/service.rb @@ -0,0 +1,211 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module WorkflowexecutionsV1beta + # Workflow Executions API + # + # Manages user-provided workflows. + # + # @example + # require 'google/apis/workflowexecutions_v1beta' + # + # Workflowexecutions = Google::Apis::WorkflowexecutionsV1beta # Alias the module + # service = Workflowexecutions::WorkflowExecutionsService.new + # + # @see https://cloud.google.com/workflows + class WorkflowExecutionsService < Google::Apis::Core::BaseService + # @return [String] + # 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. + attr_accessor :key + + # @return [String] + # 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. + attr_accessor :quota_user + + def initialize + super('https://workflowexecutions.googleapis.com/', '') + @batch_path = 'batch' + end + + # Cancels an execution of the given name. + # @param [String] name + # Required. Name of the execution to be cancelled. Format: projects/`project`/ + # locations/`location`/workflows/`workflow`/executions/`execution` + # @param [Google::Apis::WorkflowexecutionsV1beta::CancelExecutionRequest] cancel_execution_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::WorkflowexecutionsV1beta::Execution] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::WorkflowexecutionsV1beta::Execution] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def cancel_execution(name, cancel_execution_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta/{+name}:cancel', options) + command.request_representation = Google::Apis::WorkflowexecutionsV1beta::CancelExecutionRequest::Representation + command.request_object = cancel_execution_request_object + command.response_representation = Google::Apis::WorkflowexecutionsV1beta::Execution::Representation + command.response_class = Google::Apis::WorkflowexecutionsV1beta::Execution + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new execution using the latest revision of the given workflow. + # @param [String] parent + # Required. Name of the workflow for which an execution should be created. + # Format: projects/`project`/locations/`location`/workflows/`workflow` The + # latest revision of the workflow will be used. + # @param [Google::Apis::WorkflowexecutionsV1beta::Execution] execution_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::WorkflowexecutionsV1beta::Execution] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::WorkflowexecutionsV1beta::Execution] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_workflow_execution(parent, execution_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta/{+parent}/executions', options) + command.request_representation = Google::Apis::WorkflowexecutionsV1beta::Execution::Representation + command.request_object = execution_object + command.response_representation = Google::Apis::WorkflowexecutionsV1beta::Execution::Representation + command.response_class = Google::Apis::WorkflowexecutionsV1beta::Execution + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns an execution of the given name. + # @param [String] name + # Required. Name of the execution to be retrieved. Format: projects/`project`/ + # locations/`location`/workflows/`workflow`/executions/`execution` + # @param [String] view + # Optional. A view defining which fields should be filled in the returned + # execution. The API will default to the FULL view. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::WorkflowexecutionsV1beta::Execution] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::WorkflowexecutionsV1beta::Execution] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_workflow_execution(name, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::WorkflowexecutionsV1beta::Execution::Representation + command.response_class = Google::Apis::WorkflowexecutionsV1beta::Execution + command.params['name'] = name unless name.nil? + command.query['view'] = view unless view.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns a list of executions which belong to the workflow with the given name. + # The method returns executions of all workflow revisions. Returned executions + # are ordered by their start time (newest first). + # @param [String] parent + # Required. Name of the workflow for which the executions should be listed. + # Format: projects/`project`/locations/`location`/workflows/`workflow` + # @param [Fixnum] page_size + # Maximum number of executions to return per call. Max supported value depends + # on the selected Execution view: it's 10000 for BASIC and 100 for FULL. The + # default value used if the field is not specified is 100, regardless of the + # selected view. Values greater than the max value will be coerced down to it. + # @param [String] page_token + # A page token, received from a previous `ListExecutions` call. Provide this to + # retrieve the subsequent page. When paginating, all other parameters provided + # to `ListExecutions` must match the call that provided the page token. + # @param [String] view + # Optional. A view defining which fields should be filled in the returned + # executions. The API will default to the BASIC view. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::WorkflowexecutionsV1beta::ListExecutionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::WorkflowexecutionsV1beta::ListExecutionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_workflow_executions(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+parent}/executions', options) + command.response_representation = Google::Apis::WorkflowexecutionsV1beta::ListExecutionsResponse::Representation + command.response_class = Google::Apis::WorkflowexecutionsV1beta::ListExecutionsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['view'] = view unless view.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/youtube_partner_v1.rb b/generated/google/apis/youtube_partner_v1.rb index ba06f9990..4cb50abce 100644 --- a/generated/google/apis/youtube_partner_v1.rb +++ b/generated/google/apis/youtube_partner_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://devsite.googleplex.com/youtube/partner/docs/v1/ module YoutubePartnerV1 VERSION = 'V1' - REVISION = '20200827' + REVISION = '20200914' # View and manage your assets and associated content on YouTube AUTH_YOUTUBEPARTNER = 'https://www.googleapis.com/auth/youtubepartner' diff --git a/generated/google/apis/youtube_v3.rb b/generated/google/apis/youtube_v3.rb index 44441c5df..4911d5f9a 100644 --- a/generated/google/apis/youtube_v3.rb +++ b/generated/google/apis/youtube_v3.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/youtube/ module YoutubeV3 VERSION = 'V3' - REVISION = '20200823' + REVISION = '20200909' # Manage your YouTube account AUTH_YOUTUBE = 'https://www.googleapis.com/auth/youtube' diff --git a/generated/google/apis/youtube_v3/service.rb b/generated/google/apis/youtube_v3/service.rb index bb35df79f..2661a78f5 100644 --- a/generated/google/apis/youtube_v3/service.rb +++ b/generated/google/apis/youtube_v3/service.rb @@ -1361,6 +1361,84 @@ module Google execute_or_queue_command(command, &block) end + # Retrieves all infocards for a given video. + # @param [Array, String] part + # The properties to return. + # @param [String] on_behalf_of_content_owner + # Content owner of the video. + # @param [String] video_id + # Encrypted id of the video. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::YoutubeV3::InfocardListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::YoutubeV3::InfocardListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_infocards(part, on_behalf_of_content_owner: nil, video_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/v3/infocards', options) + command.response_representation = Google::Apis::YoutubeV3::InfocardListResponse::Representation + command.response_class = Google::Apis::YoutubeV3::InfocardListResponse + command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? + command.query['part'] = part unless part.nil? + command.query['videoId'] = video_id unless video_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates infocards for a given video. Note: * If the card id is not provided, a + # new card will be created. * If the card id is provided, that card will be + # updated. * Existing cards will be discarded if they're not included in the + # request. + # @param [Array, String] part + # The properties to update. + # @param [Google::Apis::YoutubeV3::InfoCards] info_cards_object + # @param [String] on_behalf_of_content_owner + # Content owner of the video. + # @param [String] video_id + # Encrypted id of the video. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::YoutubeV3::InfoCards] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::YoutubeV3::InfoCards] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_infocard(part, info_cards_object = nil, on_behalf_of_content_owner: nil, video_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'youtube/v3/infocards', options) + command.request_representation = Google::Apis::YoutubeV3::InfoCards::Representation + command.request_object = info_cards_object + command.response_representation = Google::Apis::YoutubeV3::InfoCards::Representation + command.response_class = Google::Apis::YoutubeV3::InfoCards + command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? + command.query['part'] = part unless part.nil? + command.query['videoId'] = video_id unless video_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Bind a broadcast to a stream. # @param [String] id # Broadcast to bind to the stream @@ -4041,84 +4119,6 @@ module Google command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - - # Updates infocards for a given video. Note: * If the card id is not provided, a - # new card will be created. * If the card id is provided, that card will be - # updated. * Existing cards will be discarded if they're not included in the - # request. - # @param [Array, String] part - # The properties to update. - # @param [Google::Apis::YoutubeV3::InfoCards] info_cards_object - # @param [String] on_behalf_of_content_owner - # Content owner of the video. - # @param [String] video_id - # Encrypted id of the video. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # 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. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::YoutubeV3::InfoCards] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::YoutubeV3::InfoCards] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def infocards_youtube_v3(part, info_cards_object = nil, on_behalf_of_content_owner: nil, video_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'youtube/v3/infocards', options) - command.request_representation = Google::Apis::YoutubeV3::InfoCards::Representation - command.request_object = info_cards_object - command.response_representation = Google::Apis::YoutubeV3::InfoCards::Representation - command.response_class = Google::Apis::YoutubeV3::InfoCards - command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? - command.query['part'] = part unless part.nil? - command.query['videoId'] = video_id unless video_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves all infocards for a given video. - # @param [Array, String] part - # The properties to return. - # @param [String] on_behalf_of_content_owner - # Content owner of the video. - # @param [String] video_id - # Encrypted id of the video. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # 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. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::YoutubeV3::InfocardListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::YoutubeV3::InfocardListResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_youtube_v3_infocards(part, on_behalf_of_content_owner: nil, video_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'youtube/v3/infocards', options) - command.response_representation = Google::Apis::YoutubeV3::InfocardListResponse::Representation - command.response_class = Google::Apis::YoutubeV3::InfocardListResponse - command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? - command.query['part'] = part unless part.nil? - command.query['videoId'] = video_id unless video_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end protected