From 2ebdf418138be15ae0f4888d8c418d63936d5feb Mon Sep 17 00:00:00 2001 From: Google APIs Date: Tue, 4 Aug 2020 00:38:33 +0000 Subject: [PATCH] Autogenerated update (2020-08-04) Update: - abusiveexperiencereport_v1 - adexchangebuyer2_v2beta1 - adexperiencereport_v1 - admob_v1 - androiddeviceprovisioning_v1 - androidpublisher_v3 - billingbudgets_v1beta1 - blogger_v2 - blogger_v3 - customsearch_v1 - domainsrdap_v1 - factchecktools_v1alpha1 - firebasehosting_v1 - firebasehosting_v1beta1 - gmailpostmastertools_v1beta1 - language_v1 - language_v1beta1 - language_v1beta2 - libraryagent_v1 - managedidentities_v1 - managedidentities_v1alpha1 - managedidentities_v1beta1 - playcustomapp_v1 - prod_tt_sasportal_v1alpha1 - realtimebidding_v1 - sasportal_v1alpha1 - securitycenter_v1 - securitycenter_v1beta1 - securitycenter_v1p1alpha1 - securitycenter_v1p1beta1 - serviceconsumermanagement_v1 - serviceconsumermanagement_v1beta1 - servicenetworking_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - toolresults_v1beta3 - translate_v3 - translate_v3beta1 - websecurityscanner_v1 - websecurityscanner_v1alpha - websecurityscanner_v1beta - youtube_analytics_v2 - youtube_partner_v1 - youtube_v3 - youtubereporting_v1 --- api_names_out.yaml | 172 + .../google/apis/abusiveexperiencereport_v1.rb | 2 +- .../abusiveexperiencereport_v1/classes.rb | 21 +- .../abusiveexperiencereport_v1/service.rb | 5 +- .../google/apis/adexchangebuyer2_v2beta1.rb | 2 +- .../apis/adexchangebuyer2_v2beta1/classes.rb | 1176 +++--- .../apis/adexchangebuyer2_v2beta1/service.rb | 1098 +++--- .../google/apis/adexperiencereport_v1.rb | 2 +- .../apis/adexperiencereport_v1/classes.rb | 29 +- .../apis/adexperiencereport_v1/service.rb | 5 +- generated/google/apis/admob_v1.rb | 2 +- generated/google/apis/admob_v1/classes.rb | 409 +-- generated/google/apis/admob_v1/service.rb | 24 +- .../apis/androiddeviceprovisioning_v1.rb | 2 +- .../androiddeviceprovisioning_v1/classes.rb | 413 +-- .../androiddeviceprovisioning_v1/service.rb | 116 +- generated/google/apis/androidpublisher_v3.rb | 2 +- .../apis/androidpublisher_v3/classes.rb | 623 ++-- .../apis/androidpublisher_v3/service.rb | 278 +- .../google/apis/billingbudgets_v1beta1.rb | 2 +- .../apis/billingbudgets_v1beta1/classes.rb | 215 +- .../apis/billingbudgets_v1beta1/service.rb | 63 +- generated/google/apis/blogger_v2.rb | 5 +- generated/google/apis/blogger_v2/classes.rb | 3 +- generated/google/apis/blogger_v2/service.rb | 3 +- generated/google/apis/blogger_v3.rb | 5 +- generated/google/apis/blogger_v3/classes.rb | 3 +- generated/google/apis/blogger_v3/service.rb | 3 +- generated/google/apis/customsearch_v1.rb | 2 +- .../google/apis/customsearch_v1/classes.rb | 795 ++-- .../google/apis/customsearch_v1/service.rb | 525 +-- generated/google/apis/datafusion_v1.rb | 43 + .../google/apis/datafusion_v1/classes.rb | 1154 ++++++ .../apis/datafusion_v1/representations.rb | 390 ++ .../google/apis/datafusion_v1/service.rb | 680 ++++ generated/google/apis/domainsrdap_v1.rb | 2 +- .../google/apis/domainsrdap_v1/classes.rb | 111 +- .../google/apis/domainsrdap_v1/service.rb | 32 +- .../google/apis/factchecktools_v1alpha1.rb | 2 +- .../apis/factchecktools_v1alpha1/classes.rb | 102 +- .../apis/factchecktools_v1alpha1/service.rb | 63 +- generated/google/apis/firebasehosting_v1.rb | 2 +- .../google/apis/firebasehosting_v1/classes.rb | 76 +- .../google/apis/firebasehosting_v1/service.rb | 41 +- .../google/apis/firebasehosting_v1beta1.rb | 2 +- .../apis/firebasehosting_v1beta1/classes.rb | 325 +- .../apis/firebasehosting_v1beta1/service.rb | 257 +- .../apis/gmailpostmastertools_v1beta1.rb | 2 +- .../gmailpostmastertools_v1beta1/classes.rb | 79 +- .../gmailpostmastertools_v1beta1/service.rb | 74 +- generated/google/apis/language_v1.rb | 2 +- generated/google/apis/language_v1/classes.rb | 204 +- generated/google/apis/language_v1/service.rb | 8 +- generated/google/apis/language_v1beta1.rb | 2 +- .../google/apis/language_v1beta1/classes.rb | 168 +- .../google/apis/language_v1beta1/service.rb | 4 +- generated/google/apis/language_v1beta2.rb | 2 +- .../google/apis/language_v1beta2/classes.rb | 207 +- .../google/apis/language_v1beta2/service.rb | 8 +- generated/google/apis/libraryagent_v1.rb | 2 +- .../google/apis/libraryagent_v1/classes.rb | 26 +- .../google/apis/libraryagent_v1/service.rb | 29 +- generated/google/apis/managedidentities_v1.rb | 2 +- .../apis/managedidentities_v1/classes.rb | 778 ++-- .../apis/managedidentities_v1/service.rb | 177 +- .../google/apis/managedidentities_v1alpha1.rb | 2 +- .../managedidentities_v1alpha1/classes.rb | 793 ++-- .../managedidentities_v1alpha1/service.rb | 200 +- .../google/apis/managedidentities_v1beta1.rb | 2 +- .../apis/managedidentities_v1beta1/classes.rb | 788 ++-- .../apis/managedidentities_v1beta1/service.rb | 172 +- generated/google/apis/playcustomapp_v1.rb | 2 +- .../google/apis/playcustomapp_v1/classes.rb | 4 +- .../google/apis/prod_tt_sasportal_v1alpha1.rb | 2 +- .../prod_tt_sasportal_v1alpha1/classes.rb | 268 +- .../prod_tt_sasportal_v1alpha1/service.rb | 87 +- generated/google/apis/realtimebidding_v1.rb | 2 +- .../google/apis/realtimebidding_v1/classes.rb | 489 +-- .../google/apis/realtimebidding_v1/service.rb | 233 +- generated/google/apis/sasportal_v1alpha1.rb | 2 +- .../google/apis/sasportal_v1alpha1/classes.rb | 268 +- .../google/apis/sasportal_v1alpha1/service.rb | 87 +- generated/google/apis/securitycenter_v1.rb | 2 +- .../google/apis/securitycenter_v1/classes.rb | 1400 +++---- .../google/apis/securitycenter_v1/service.rb | 582 ++- .../google/apis/securitycenter_v1beta1.rb | 2 +- .../apis/securitycenter_v1beta1/classes.rb | 1267 +++---- .../apis/securitycenter_v1beta1/service.rb | 362 +- .../google/apis/securitycenter_v1p1alpha1.rb | 2 +- .../apis/securitycenter_v1p1alpha1/classes.rb | 384 +- .../apis/securitycenter_v1p1alpha1/service.rb | 46 +- .../google/apis/securitycenter_v1p1beta1.rb | 2 +- .../apis/securitycenter_v1p1beta1/classes.rb | 1336 +++---- .../apis/securitycenter_v1p1beta1/service.rb | 577 ++- .../apis/serviceconsumermanagement_v1.rb | 2 +- .../serviceconsumermanagement_v1/classes.rb | 2932 ++++++--------- .../serviceconsumermanagement_v1/service.rb | 249 +- .../apis/serviceconsumermanagement_v1beta1.rb | 2 +- .../classes.rb | 2911 ++++++--------- .../service.rb | 118 +- generated/google/apis/servicenetworking_v1.rb | 2 +- .../apis/servicenetworking_v1/classes.rb | 2877 ++++++--------- .../apis/servicenetworking_v1/service.rb | 208 +- .../google/apis/servicenetworking_v1beta.rb | 2 +- .../apis/servicenetworking_v1beta/classes.rb | 2749 ++++++-------- .../apis/servicenetworking_v1beta/service.rb | 115 +- generated/google/apis/serviceusage_v1.rb | 2 +- .../google/apis/serviceusage_v1/classes.rb | 2963 ++++++--------- .../google/apis/serviceusage_v1/service.rb | 143 +- generated/google/apis/serviceusage_v1beta1.rb | 2 +- .../apis/serviceusage_v1beta1/classes.rb | 3221 +++++++---------- .../apis/serviceusage_v1beta1/service.rb | 292 +- generated/google/apis/toolresults_v1beta3.rb | 2 +- .../apis/toolresults_v1beta3/classes.rb | 1596 ++++---- .../apis/toolresults_v1beta3/service.rb | 580 ++- generated/google/apis/translate_v3.rb | 2 +- generated/google/apis/translate_v3/service.rb | 15 +- generated/google/apis/translate_v3beta1.rb | 2 +- .../google/apis/translate_v3beta1/service.rb | 15 +- .../google/apis/websecurityscanner_v1.rb | 2 +- .../apis/websecurityscanner_v1/classes.rb | 166 +- .../apis/websecurityscanner_v1/service.rb | 111 +- .../google/apis/websecurityscanner_v1alpha.rb | 2 +- .../websecurityscanner_v1alpha/classes.rb | 118 +- .../websecurityscanner_v1alpha/service.rb | 111 +- .../google/apis/websecurityscanner_v1beta.rb | 2 +- .../apis/websecurityscanner_v1beta/classes.rb | 169 +- .../apis/websecurityscanner_v1beta/service.rb | 111 +- generated/google/apis/youtube_analytics_v2.rb | 2 +- .../apis/youtube_analytics_v2/classes.rb | 181 +- .../apis/youtube_analytics_v2/service.rb | 232 +- generated/google/apis/youtube_partner_v1.rb | 2 +- .../google/apis/youtube_partner_v1/service.rb | 4 +- generated/google/apis/youtube_v3.rb | 2 +- generated/google/apis/youtube_v3/classes.rb | 2112 +++++------ generated/google/apis/youtube_v3/service.rb | 2259 +++++------- generated/google/apis/youtubereporting_v1.rb | 2 +- .../apis/youtubereporting_v1/classes.rb | 49 +- .../apis/youtubereporting_v1/service.rb | 83 +- 139 files changed, 20858 insertions(+), 26288 deletions(-) create mode 100644 generated/google/apis/datafusion_v1.rb create mode 100644 generated/google/apis/datafusion_v1/classes.rb create mode 100644 generated/google/apis/datafusion_v1/representations.rb create mode 100644 generated/google/apis/datafusion_v1/service.rb diff --git a/api_names_out.yaml b/api_names_out.yaml index c3ffb9540..bef706309 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -58718,6 +58718,178 @@ "/dataflow:v1b3/fields": fields "/dataflow:v1b3/key": key "/dataflow:v1b3/quotaUser": quota_user +"/datafusion:v1/Accelerator": accelerator +"/datafusion:v1/Accelerator/acceleratorType": accelerator_type +"/datafusion:v1/AuditConfig": audit_config +"/datafusion:v1/AuditConfig/auditLogConfigs": audit_log_configs +"/datafusion:v1/AuditConfig/auditLogConfigs/audit_log_config": audit_log_config +"/datafusion:v1/AuditConfig/service": service +"/datafusion:v1/AuditLogConfig": audit_log_config +"/datafusion:v1/AuditLogConfig/exemptedMembers": exempted_members +"/datafusion:v1/AuditLogConfig/exemptedMembers/exempted_member": exempted_member +"/datafusion:v1/AuditLogConfig/logType": log_type +"/datafusion:v1/Binding": binding +"/datafusion:v1/Binding/condition": condition +"/datafusion:v1/Binding/members": members +"/datafusion:v1/Binding/members/member": member +"/datafusion:v1/Binding/role": role +"/datafusion:v1/CancelOperationRequest": cancel_operation_request +"/datafusion:v1/Empty": empty +"/datafusion:v1/Expr": expr +"/datafusion:v1/Expr/description": description +"/datafusion:v1/Expr/expression": expression +"/datafusion:v1/Expr/location": location +"/datafusion:v1/Expr/title": title +"/datafusion:v1/Instance": instance +"/datafusion:v1/Instance/accelerators": accelerators +"/datafusion:v1/Instance/accelerators/accelerator": accelerator +"/datafusion:v1/Instance/apiEndpoint": api_endpoint +"/datafusion:v1/Instance/availableVersion": available_version +"/datafusion:v1/Instance/availableVersion/available_version": available_version +"/datafusion:v1/Instance/createTime": create_time +"/datafusion:v1/Instance/description": description +"/datafusion:v1/Instance/displayName": display_name +"/datafusion:v1/Instance/enableStackdriverLogging": enable_stackdriver_logging +"/datafusion:v1/Instance/enableStackdriverMonitoring": enable_stackdriver_monitoring +"/datafusion:v1/Instance/gcsBucket": gcs_bucket +"/datafusion:v1/Instance/labels": labels +"/datafusion:v1/Instance/labels/label": label +"/datafusion:v1/Instance/name": name +"/datafusion:v1/Instance/networkConfig": network_config +"/datafusion:v1/Instance/options": options +"/datafusion:v1/Instance/options/option": option +"/datafusion:v1/Instance/privateInstance": private_instance +"/datafusion:v1/Instance/serviceAccount": service_account +"/datafusion:v1/Instance/serviceEndpoint": service_endpoint +"/datafusion:v1/Instance/state": state +"/datafusion:v1/Instance/stateMessage": state_message +"/datafusion:v1/Instance/type": type +"/datafusion:v1/Instance/updateTime": update_time +"/datafusion:v1/Instance/version": version +"/datafusion:v1/Instance/zone": zone +"/datafusion:v1/ListAvailableVersionsResponse": list_available_versions_response +"/datafusion:v1/ListAvailableVersionsResponse/availableVersions": available_versions +"/datafusion:v1/ListAvailableVersionsResponse/availableVersions/available_version": available_version +"/datafusion:v1/ListAvailableVersionsResponse/nextPageToken": next_page_token +"/datafusion:v1/ListInstancesResponse": list_instances_response +"/datafusion:v1/ListInstancesResponse/instances": instances +"/datafusion:v1/ListInstancesResponse/instances/instance": instance +"/datafusion:v1/ListInstancesResponse/nextPageToken": next_page_token +"/datafusion:v1/ListInstancesResponse/unreachable": unreachable +"/datafusion:v1/ListInstancesResponse/unreachable/unreachable": unreachable +"/datafusion:v1/ListLocationsResponse": list_locations_response +"/datafusion:v1/ListLocationsResponse/locations": locations +"/datafusion:v1/ListLocationsResponse/locations/location": location +"/datafusion:v1/ListLocationsResponse/nextPageToken": next_page_token +"/datafusion:v1/ListOperationsResponse": list_operations_response +"/datafusion:v1/ListOperationsResponse/nextPageToken": next_page_token +"/datafusion:v1/ListOperationsResponse/operations": operations +"/datafusion:v1/ListOperationsResponse/operations/operation": operation +"/datafusion:v1/Location": location +"/datafusion:v1/Location/displayName": display_name +"/datafusion:v1/Location/labels": labels +"/datafusion:v1/Location/labels/label": label +"/datafusion:v1/Location/locationId": location_id +"/datafusion:v1/Location/metadata": metadata +"/datafusion:v1/Location/metadata/metadatum": metadatum +"/datafusion:v1/Location/name": name +"/datafusion:v1/NetworkConfig": network_config +"/datafusion:v1/NetworkConfig/ipAllocation": ip_allocation +"/datafusion:v1/NetworkConfig/network": network +"/datafusion:v1/Operation": operation +"/datafusion:v1/Operation/done": done +"/datafusion:v1/Operation/error": error +"/datafusion:v1/Operation/metadata": metadata +"/datafusion:v1/Operation/metadata/metadatum": metadatum +"/datafusion:v1/Operation/name": name +"/datafusion:v1/Operation/response": response +"/datafusion:v1/Operation/response/response": response +"/datafusion:v1/OperationMetadata": operation_metadata +"/datafusion:v1/OperationMetadata/apiVersion": api_version +"/datafusion:v1/OperationMetadata/createTime": create_time +"/datafusion:v1/OperationMetadata/endTime": end_time +"/datafusion:v1/OperationMetadata/requestedCancellation": requested_cancellation +"/datafusion:v1/OperationMetadata/statusDetail": status_detail +"/datafusion:v1/OperationMetadata/target": target +"/datafusion:v1/OperationMetadata/verb": verb +"/datafusion:v1/Policy": policy +"/datafusion:v1/Policy/auditConfigs": audit_configs +"/datafusion:v1/Policy/auditConfigs/audit_config": audit_config +"/datafusion:v1/Policy/bindings": bindings +"/datafusion:v1/Policy/bindings/binding": binding +"/datafusion:v1/Policy/etag": etag +"/datafusion:v1/Policy/version": version +"/datafusion:v1/RestartInstanceRequest": restart_instance_request +"/datafusion:v1/SetIamPolicyRequest": set_iam_policy_request +"/datafusion:v1/SetIamPolicyRequest/policy": policy +"/datafusion:v1/SetIamPolicyRequest/updateMask": update_mask +"/datafusion:v1/Status": status +"/datafusion:v1/Status/code": code +"/datafusion:v1/Status/details": details +"/datafusion:v1/Status/details/detail": detail +"/datafusion:v1/Status/details/detail/detail": detail +"/datafusion:v1/Status/message": message +"/datafusion:v1/TestIamPermissionsRequest": test_iam_permissions_request +"/datafusion:v1/TestIamPermissionsRequest/permissions": permissions +"/datafusion:v1/TestIamPermissionsRequest/permissions/permission": permission +"/datafusion:v1/TestIamPermissionsResponse": test_iam_permissions_response +"/datafusion:v1/TestIamPermissionsResponse/permissions": permissions +"/datafusion:v1/TestIamPermissionsResponse/permissions/permission": permission +"/datafusion:v1/Version": version +"/datafusion:v1/Version/defaultVersion": default_version +"/datafusion:v1/Version/versionNumber": version_number +"/datafusion:v1/datafusion.projects.locations.get": get_project_location +"/datafusion:v1/datafusion.projects.locations.get/name": name +"/datafusion:v1/datafusion.projects.locations.instances.create": create_project_location_instance +"/datafusion:v1/datafusion.projects.locations.instances.create/instanceId": instance_id +"/datafusion:v1/datafusion.projects.locations.instances.create/parent": parent +"/datafusion:v1/datafusion.projects.locations.instances.delete": delete_project_location_instance +"/datafusion:v1/datafusion.projects.locations.instances.delete/name": name +"/datafusion:v1/datafusion.projects.locations.instances.get": get_project_location_instance +"/datafusion:v1/datafusion.projects.locations.instances.get/name": name +"/datafusion:v1/datafusion.projects.locations.instances.getIamPolicy": get_project_location_instance_iam_policy +"/datafusion:v1/datafusion.projects.locations.instances.getIamPolicy/options.requestedPolicyVersion": options_requested_policy_version +"/datafusion:v1/datafusion.projects.locations.instances.getIamPolicy/resource": resource +"/datafusion:v1/datafusion.projects.locations.instances.list": list_project_location_instances +"/datafusion:v1/datafusion.projects.locations.instances.list/filter": filter +"/datafusion:v1/datafusion.projects.locations.instances.list/orderBy": order_by +"/datafusion:v1/datafusion.projects.locations.instances.list/pageSize": page_size +"/datafusion:v1/datafusion.projects.locations.instances.list/pageToken": page_token +"/datafusion:v1/datafusion.projects.locations.instances.list/parent": parent +"/datafusion:v1/datafusion.projects.locations.instances.patch": patch_project_location_instance +"/datafusion:v1/datafusion.projects.locations.instances.patch/name": name +"/datafusion:v1/datafusion.projects.locations.instances.patch/updateMask": update_mask +"/datafusion:v1/datafusion.projects.locations.instances.restart": restart_instance +"/datafusion:v1/datafusion.projects.locations.instances.restart/name": name +"/datafusion:v1/datafusion.projects.locations.instances.setIamPolicy": set_instance_iam_policy +"/datafusion:v1/datafusion.projects.locations.instances.setIamPolicy/resource": resource +"/datafusion:v1/datafusion.projects.locations.instances.testIamPermissions": test_instance_iam_permissions +"/datafusion:v1/datafusion.projects.locations.instances.testIamPermissions/resource": resource +"/datafusion:v1/datafusion.projects.locations.list": list_project_locations +"/datafusion:v1/datafusion.projects.locations.list/filter": filter +"/datafusion:v1/datafusion.projects.locations.list/includeUnrevealedLocations": include_unrevealed_locations +"/datafusion:v1/datafusion.projects.locations.list/name": name +"/datafusion:v1/datafusion.projects.locations.list/pageSize": page_size +"/datafusion:v1/datafusion.projects.locations.list/pageToken": page_token +"/datafusion:v1/datafusion.projects.locations.operations.cancel": cancel_operation +"/datafusion:v1/datafusion.projects.locations.operations.cancel/name": name +"/datafusion:v1/datafusion.projects.locations.operations.delete": delete_project_location_operation +"/datafusion:v1/datafusion.projects.locations.operations.delete/name": name +"/datafusion:v1/datafusion.projects.locations.operations.get": get_project_location_operation +"/datafusion:v1/datafusion.projects.locations.operations.get/name": name +"/datafusion:v1/datafusion.projects.locations.operations.list": list_project_location_operations +"/datafusion:v1/datafusion.projects.locations.operations.list/filter": filter +"/datafusion:v1/datafusion.projects.locations.operations.list/name": name +"/datafusion:v1/datafusion.projects.locations.operations.list/pageSize": page_size +"/datafusion:v1/datafusion.projects.locations.operations.list/pageToken": page_token +"/datafusion:v1/datafusion.projects.locations.versions.list": list_project_location_versions +"/datafusion:v1/datafusion.projects.locations.versions.list/latestPatchOnly": latest_patch_only +"/datafusion:v1/datafusion.projects.locations.versions.list/pageSize": page_size +"/datafusion:v1/datafusion.projects.locations.versions.list/pageToken": page_token +"/datafusion:v1/datafusion.projects.locations.versions.list/parent": parent +"/datafusion:v1/fields": fields +"/datafusion:v1/key": key +"/datafusion:v1/quotaUser": quota_user "/datafusion:v1beta1/Accelerator": accelerator "/datafusion:v1beta1/Accelerator/acceleratorType": accelerator_type "/datafusion:v1beta1/AuditConfig": audit_config diff --git a/generated/google/apis/abusiveexperiencereport_v1.rb b/generated/google/apis/abusiveexperiencereport_v1.rb index 35f94168b..cc033d390 100644 --- a/generated/google/apis/abusiveexperiencereport_v1.rb +++ b/generated/google/apis/abusiveexperiencereport_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/abusive-experience-report/ module AbusiveexperiencereportV1 VERSION = 'V1' - REVISION = '20200210' + REVISION = '20200803' end end end diff --git a/generated/google/apis/abusiveexperiencereport_v1/classes.rb b/generated/google/apis/abusiveexperiencereport_v1/classes.rb index 34fc462cf..b2a60e4ce 100644 --- a/generated/google/apis/abusiveexperiencereport_v1/classes.rb +++ b/generated/google/apis/abusiveexperiencereport_v1/classes.rb @@ -31,18 +31,15 @@ module Google # @return [String] attr_accessor :abusive_status - # The time at which - # [enforcement](https://support.google.com/webtools/answer/7538608) against - # the site began or will begin. - # Not set when the - # filter_status + # The time at which [enforcement](https://support.google.com/webtools/answer/ + # 7538608) against the site began or will begin. Not set when the filter_status # is OFF. # Corresponds to the JSON property `enforcementTime` # @return [String] attr_accessor :enforcement_time - # The site's [enforcement - # status](https://support.google.com/webtools/answer/7538608). + # The site's [enforcement status](https://support.google.com/webtools/answer/ + # 7538608). # Corresponds to the JSON property `filterStatus` # @return [String] attr_accessor :filter_status @@ -52,12 +49,10 @@ module Google # @return [String] attr_accessor :last_change_time - # A link to the full Abusive Experience Report for the site. - # Not set in - # ViolatingSitesResponse. - # Note that you must complete the [Search Console verification - # process](https://support.google.com/webmasters/answer/9008080) for the site - # before you can access the full report. + # A link to the full Abusive Experience Report for the site. Not set in + # ViolatingSitesResponse. Note that you must complete the [Search Console + # verification process](https://support.google.com/webmasters/answer/9008080) + # for the site before you can access the full report. # Corresponds to the JSON property `reportUrl` # @return [String] attr_accessor :report_url diff --git a/generated/google/apis/abusiveexperiencereport_v1/service.rb b/generated/google/apis/abusiveexperiencereport_v1/service.rb index 73e493d85..121f8fd0b 100644 --- a/generated/google/apis/abusiveexperiencereport_v1/service.rb +++ b/generated/google/apis/abusiveexperiencereport_v1/service.rb @@ -50,9 +50,8 @@ module Google # Gets a site's Abusive Experience Report summary. # @param [String] name - # Required. The name of the site whose summary to get, e.g. - # `sites/http%3A%2F%2Fwww.google.com%2F`. - # Format: `sites/`site`` + # Required. The name of the site whose summary to get, e.g. `sites/http%3A%2F% + # 2Fwww.google.com%2F`. Format: `sites/`site`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/adexchangebuyer2_v2beta1.rb b/generated/google/apis/adexchangebuyer2_v2beta1.rb index 41418f71d..8de77ddbf 100644 --- a/generated/google/apis/adexchangebuyer2_v2beta1.rb +++ b/generated/google/apis/adexchangebuyer2_v2beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://developers.google.com/authorized-buyers/apis/reference/rest/ module Adexchangebuyer2V2beta1 VERSION = 'V2beta1' - REVISION = '20200520' + REVISION = '20200803' # Manage your Ad Exchange buyer account configuration AUTH_ADEXCHANGE_BUYER = 'https://www.googleapis.com/auth/adexchange.buyer' diff --git a/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb b/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb index b43b0a231..cd564f716 100644 --- a/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +++ b/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb @@ -22,34 +22,33 @@ module Google module Apis module Adexchangebuyer2V2beta1 - # An absolute date range, specified by its start date and end date. - # The supported range of dates begins 30 days before today and ends today. - # Validity checked upon filter set creation. If a filter set with an absolute - # date range is run at a later date more than 30 days after start_date, it will - # fail. + # An absolute date range, specified by its start date and end date. The + # supported range of dates begins 30 days before today and ends today. Validity + # checked upon filter set creation. If a filter set with an absolute date range + # is run at a later date more than 30 days after start_date, it will fail. class AbsoluteDateRange include Google::Apis::Core::Hashable # 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::Adexchangebuyer2V2beta1::Date] attr_accessor :end_date # 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::Adexchangebuyer2V2beta1::Date] attr_accessor :start_date @@ -88,8 +87,8 @@ module Google class AdSize include Google::Apis::Core::Hashable - # The height of the ad slot in pixels. - # This field will be present only when size type is `PIXEL`. + # The height of the ad slot in pixels. This field will be present only when size + # type is `PIXEL`. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height @@ -99,8 +98,8 @@ module Google # @return [String] attr_accessor :size_type - # The width of the ad slot in pixels. - # This field will be present only when size type is `PIXEL`. + # The width of the ad slot in pixels. This field will be present only when size + # type is `PIXEL`. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width @@ -121,30 +120,25 @@ module Google class AdTechnologyProviders include Google::Apis::Core::Hashable - # The detected ad technology provider IDs for this creative. - # See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for - # mapping of provider ID to provided name, a privacy policy URL, and a list - # of domains which can be attributed to the provider. - # If the creative contains provider IDs that are outside of those listed in - # the `BidRequest.adslot.consented_providers_settings.consented_providers` - # field on the (Google bid - # protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/ - # realtime-bidding-proto] - # and the - # `BidRequest.user.ext.consented_providers_settings.consented_providers` - # field on the (OpenRTB - # protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/ - # openrtb-adx-proto], - # and a bid is submitted with that creative for an impression that will - # serve to an EEA user, the bid will be filtered before the auction. + # The detected ad technology provider IDs for this creative. See https://storage. + # googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID + # to provided name, a privacy policy URL, and a list of domains which can be + # attributed to the provider. If the creative contains provider IDs that are + # outside of those listed in the `BidRequest.adslot.consented_providers_settings. + # consented_providers` field on the (Google bid protocol)[https://developers. + # google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the ` + # BidRequest.user.ext.consented_providers_settings.consented_providers` field on + # the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/ + # downloads/openrtb-adx-proto], and a bid is submitted with that creative for an + # impression that will serve to an EEA user, the bid will be filtered before the + # auction. # Corresponds to the JSON property `detectedProviderIds` # @return [Array] attr_accessor :detected_provider_ids - # Whether the creative contains an unidentified ad technology provider. - # If true for a given creative, any bid submitted with that creative for an - # impression that will serve to an EEA user will be filtered before the - # auction. + # Whether the creative contains an unidentified ad technology provider. If true + # for a given creative, any bid submitted with that creative for an impression + # that will serve to an EEA user will be filtered before the auction. # Corresponds to the JSON property `hasUnidentifiedProvider` # @return [Boolean] attr_accessor :has_unidentified_provider @@ -237,44 +231,44 @@ module Google end end - # The set of metrics that are measured in numbers of bids, representing how - # many bids with the specified dimension values were considered eligible at - # each stage of the bidding funnel; + # The set of metrics that are measured in numbers of bids, representing how many + # bids with the specified dimension values were considered eligible at each + # stage of the bidding funnel; class BidMetricsRow include Google::Apis::Core::Hashable - # A metric value, with an expected value and a variance; represents a count - # that may be either exact or estimated (i.e. when sampled). + # A metric value, with an expected value and a variance; represents a count that + # may be either exact or estimated (i.e. when sampled). # Corresponds to the JSON property `bids` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :bids - # A metric value, with an expected value and a variance; represents a count - # that may be either exact or estimated (i.e. when sampled). + # A metric value, with an expected value and a variance; represents a count that + # may be either exact or estimated (i.e. when sampled). # Corresponds to the JSON property `bidsInAuction` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :bids_in_auction - # A metric value, with an expected value and a variance; represents a count - # that may be either exact or estimated (i.e. when sampled). + # A metric value, with an expected value and a variance; represents a count that + # may be either exact or estimated (i.e. when sampled). # Corresponds to the JSON property `billedImpressions` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :billed_impressions - # A metric value, with an expected value and a variance; represents a count - # that may be either exact or estimated (i.e. when sampled). + # A metric value, with an expected value and a variance; represents a count that + # may be either exact or estimated (i.e. when sampled). # Corresponds to the JSON property `impressionsWon` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :impressions_won - # A metric value, with an expected value and a variance; represents a count - # that may be either exact or estimated (i.e. when sampled). + # A metric value, with an expected value and a variance; represents a count that + # may be either exact or estimated (i.e. when sampled). # Corresponds to the JSON property `measurableImpressions` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :measurable_impressions - # A metric value, with an expected value and a variance; represents a count - # that may be either exact or estimated (i.e. when sampled). + # A metric value, with an expected value and a variance; represents a count that + # may be either exact or estimated (i.e. when sampled). # Corresponds to the JSON property `reachedQueries` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :reached_queries @@ -285,8 +279,8 @@ module Google # @return [Google::Apis::Adexchangebuyer2V2beta1::RowDimensions] attr_accessor :row_dimensions - # A metric value, with an expected value and a variance; represents a count - # that may be either exact or estimated (i.e. when sampled). + # A metric value, with an expected value and a variance; represents a count that + # may be either exact or estimated (i.e. when sampled). # Corresponds to the JSON property `viewableImpressions` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :viewable_impressions @@ -313,8 +307,8 @@ module Google class BidResponseWithoutBidsStatusRow include Google::Apis::Core::Hashable - # A metric value, with an expected value and a variance; represents a count - # that may be either exact or estimated (i.e. when sampled). + # A metric value, with an expected value and a variance; represents a count that + # may be either exact or estimated (i.e. when sampled). # Corresponds to the JSON property `impressionCount` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :impression_count @@ -369,16 +363,14 @@ module Google class CalloutStatusRow include Google::Apis::Core::Hashable - # The ID of the callout status. - # See - # [callout-status-codes](https://developers.google.com/authorized-buyers/rtb/ - # downloads/callout-status-codes). + # The ID of the callout status. See [callout-status-codes](https://developers. + # google.com/authorized-buyers/rtb/downloads/callout-status-codes). # Corresponds to the JSON property `calloutStatusId` # @return [Fixnum] attr_accessor :callout_status_id - # A metric value, with an expected value and a variance; represents a count - # that may be either exact or estimated (i.e. when sampled). + # A metric value, with an expected value and a variance; represents a count that + # may be either exact or estimated (i.e. when sampled). # Corresponds to the JSON property `impressionCount` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :impression_count @@ -414,7 +406,7 @@ module Google end end - # A client resource represents a client buyer—an agency, a brand, or an + # A client resource represents a client buyer—an agency, a brand, or an # advertiser customer of the sponsor buyer. Users associated with the client # buyer have restricted access to the Marketplace and certain other sections of # the Authorized Buyers UI based on the role granted to the client buyer. All @@ -422,68 +414,58 @@ module Google class Client include Google::Apis::Core::Hashable - # The globally-unique numerical ID of the client. - # The value of this field is ignored in create and update operations. + # The globally-unique numerical ID of the client. The value of this field is + # ignored in create and update operations. # Corresponds to the JSON property `clientAccountId` # @return [Fixnum] attr_accessor :client_account_id - # Name used to represent this client to publishers. - # You may have multiple clients that map to the same entity, - # but for each client the combination of `clientName` and entity - # must be unique. - # You can specify this field as empty. + # Name used to represent this client to publishers. You may have multiple + # clients that map to the same entity, but for each client the combination of ` + # clientName` and entity must be unique. You can specify this field as empty. # Corresponds to the JSON property `clientName` # @return [String] attr_accessor :client_name - # Numerical identifier of the client entity. - # The entity can be an advertiser, a brand, or an agency. - # This identifier is unique among all the entities with the same type. - # The value of this field is ignored if the entity type is not provided. - # A list of all known advertisers with their identifiers is available in the - # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/ - # advertisers.txt) - # file. - # A list of all known brands with their identifiers is available in the - # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt) - # file. - # A list of all known agencies with their identifiers is available in the - # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies. - # txt) - # file. + # Numerical identifier of the client entity. The entity can be an advertiser, a + # brand, or an agency. This identifier is unique among all the entities with the + # same type. The value of this field is ignored if the entity type is not + # provided. A list of all known advertisers with their identifiers is available + # in the [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/ + # advertisers.txt) file. A list of all known brands with their identifiers is + # available in the [brands.txt](https://storage.googleapis.com/adx-rtb- + # dictionaries/brands.txt) file. A list of all known agencies with their + # identifiers is available in the [agencies.txt](https://storage.googleapis.com/ + # adx-rtb-dictionaries/agencies.txt) file. # Corresponds to the JSON property `entityId` # @return [Fixnum] attr_accessor :entity_id - # The name of the entity. This field is automatically fetched based on - # the type and ID. - # The value of this field is ignored in create and update operations. + # The name of the entity. This field is automatically fetched based on the type + # and ID. The value of this field is ignored in create and update operations. # Corresponds to the JSON property `entityName` # @return [String] attr_accessor :entity_name - # An optional field for specifying the type of the client entity: - # `ADVERTISER`, `BRAND`, or `AGENCY`. + # An optional field for specifying the type of the client entity: `ADVERTISER`, ` + # BRAND`, or `AGENCY`. # Corresponds to the JSON property `entityType` # @return [String] attr_accessor :entity_type - # Optional arbitrary unique identifier of this client buyer from the - # standpoint of its Ad Exchange sponsor buyer. - # This field can be used to associate a client buyer with the identifier - # in the namespace of its sponsor buyer, lookup client buyers by that - # identifier and verify whether an Ad Exchange counterpart of a given client - # buyer already exists. - # If present, must be unique among all the client buyers for its - # Ad Exchange sponsor buyer. + # Optional arbitrary unique identifier of this client buyer from the standpoint + # of its Ad Exchange sponsor buyer. This field can be used to associate a client + # buyer with the identifier in the namespace of its sponsor buyer, lookup client + # buyers by that identifier and verify whether an Ad Exchange counterpart of a + # given client buyer already exists. If present, must be unique among all the + # client buyers for its Ad Exchange sponsor buyer. # Corresponds to the JSON property `partnerClientId` # @return [String] attr_accessor :partner_client_id # The role which is assigned to the client buyer. Each role implies a set of - # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`, - # `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`. + # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`, ` + # CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role @@ -517,28 +499,24 @@ module Google end end - # A client user is created under a client buyer and has restricted access to - # the Marketplace and certain other sections of the Authorized Buyers UI based - # on the role granted to the associated client buyer. - # The only way a new client user can be created is via accepting an - # email invitation - # (see the - # accounts.clients.invitations.create - # method). - # All fields are required unless otherwise specified. + # A client user is created under a client buyer and has restricted access to the + # Marketplace and certain other sections of the Authorized Buyers UI based on + # the role granted to the associated client buyer. The only way a new client + # user can be created is via accepting an email invitation (see the accounts. + # clients.invitations.create method). All fields are required unless otherwise + # specified. class ClientUser include Google::Apis::Core::Hashable - # Numerical account ID of the client buyer - # with which the user is associated; the - # buyer must be a client of the current sponsor buyer. - # The value of this field is ignored in an update operation. + # Numerical account ID of the client buyer with which the user is associated; + # the buyer must be a client of the current sponsor buyer. The value of this + # field is ignored in an update operation. # Corresponds to the JSON property `clientAccountId` # @return [Fixnum] attr_accessor :client_account_id - # User's email address. The value of this field - # is ignored in an update operation. + # User's email address. The value of this field is ignored in an update + # operation. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email @@ -548,8 +526,7 @@ module Google # @return [String] attr_accessor :status - # The unique numerical ID of the client user - # that has accepted an invitation. + # The unique numerical ID of the client user that has accepted an invitation. # The value of this field is ignored in an update operation. # Corresponds to the JSON property `userId` # @return [Fixnum] @@ -568,27 +545,25 @@ module Google end end - # An invitation for a new client user to get access to the Authorized Buyers - # UI. All fields are required unless otherwise specified. + # An invitation for a new client user to get access to the Authorized Buyers UI. + # All fields are required unless otherwise specified. class ClientUserInvitation include Google::Apis::Core::Hashable - # Numerical account ID of the client buyer - # that the invited user is associated with. - # The value of this field is ignored in create operations. + # Numerical account ID of the client buyer that the invited user is associated + # with. The value of this field is ignored in create operations. # Corresponds to the JSON property `clientAccountId` # @return [Fixnum] attr_accessor :client_account_id - # The email address to which the invitation is sent. Email - # addresses should be unique among all client users under each sponsor - # buyer. + # The email address to which the invitation is sent. Email addresses should be + # unique among all client users under each sponsor buyer. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email - # The unique numerical ID of the invitation that is sent to the user. - # The value of this field is ignored in create operations. + # The unique numerical ID of the invitation that is sent to the user. The value + # of this field is ignored in create operations. # Corresponds to the JSON property `invitationId` # @return [Fixnum] attr_accessor :invitation_id @@ -678,10 +653,8 @@ module Google class Creative include Google::Apis::Core::Hashable - # The account that this creative belongs to. - # Can be used to filter the response of the - # creatives.list - # method. + # The account that this creative belongs to. Can be used to filter the response + # of the creatives.list method. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id @@ -711,10 +684,8 @@ module Google # @return [String] attr_accessor :api_update_time - # All attributes for the ads that may be shown from this creative. - # Can be used to filter the response of the - # creatives.list - # method. + # All attributes for the ads that may be shown from this creative. Can be used + # to filter the response of the creatives.list method. # Corresponds to the JSON property `attributes` # @return [Array] attr_accessor :attributes @@ -729,22 +700,17 @@ module Google # @return [Array] attr_accessor :corrections - # The buyer-defined creative ID of this creative. - # Can be used to filter the response of the - # creatives.list - # method. + # The buyer-defined creative ID of this creative. Can be used to filter the + # response of the creatives.list method. # Corresponds to the JSON property `creativeId` # @return [String] attr_accessor :creative_id - # Output only. The top-level deals status of this creative. - # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in - # serving_restrictions will also exist. Note - # that this may be nuanced with other contextual restrictions, in which case, - # it may be preferable to read from serving_restrictions directly. - # Can be used to filter the response of the - # creatives.list - # method. + # Output only. The top-level deals status of this creative. If disapproved, an + # entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will + # also exist. Note that this may be nuanced with other contextual restrictions, + # in which case, it may be preferable to read from serving_restrictions directly. + # Can be used to filter the response of the creatives.list method. # Corresponds to the JSON property `dealsStatus` # @return [String] attr_accessor :deals_status @@ -764,24 +730,23 @@ module Google # @return [Array] attr_accessor :detected_domains - # Output only. The detected languages for this creative. The order is - # arbitrary. The codes are 2 or 5 characters and are documented at - # https://developers.google.com/adwords/api/docs/appendix/languagecodes. + # Output only. The detected languages for this creative. The order is arbitrary. + # The codes are 2 or 5 characters and are documented at https://developers. + # google.com/adwords/api/docs/appendix/languagecodes. # Corresponds to the JSON property `detectedLanguages` # @return [Array] attr_accessor :detected_languages - # Output only. Detected product categories, if any. - # See the ad-product-categories.txt file in the technical documentation - # for a list of IDs. + # Output only. Detected product categories, if any. See the ad-product- + # categories.txt file in the technical documentation for a list of IDs. # Corresponds to the JSON property `detectedProductCategories` # @return [Array] attr_accessor :detected_product_categories - # Output only. Detected sensitive categories, if any. - # See the ad-sensitive-categories.txt file in the technical documentation for - # a list of IDs. You should use these IDs along with the - # excluded-sensitive-category field in the bid request to filter your bids. + # Output only. Detected sensitive categories, if any. See the ad-sensitive- + # categories.txt file in the technical documentation for a list of IDs. You + # should use these IDs along with the excluded-sensitive-category field in the + # bid request to filter your bids. # Corresponds to the JSON property `detectedSensitiveCategories` # @return [Array] attr_accessor :detected_sensitive_categories @@ -801,14 +766,12 @@ module Google # @return [Google::Apis::Adexchangebuyer2V2beta1::NativeContent] attr_accessor :native - # Output only. The top-level open auction status of this creative. - # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in - # serving_restrictions will also exist. Note - # that this may be nuanced with other contextual restrictions, in which case, - # it may be preferable to read from serving_restrictions directly. - # Can be used to filter the response of the - # creatives.list - # method. + # Output only. The top-level open auction status of this creative. If + # disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in + # serving_restrictions will also exist. Note that this may be nuanced with other + # contextual restrictions, in which case, it may be preferable to read from + # serving_restrictions directly. Can be used to filter the response of the + # creatives.list method. # Corresponds to the JSON property `openAuctionStatus` # @return [String] attr_accessor :open_auction_status @@ -818,17 +781,15 @@ module Google # @return [Array] attr_accessor :restricted_categories - # Output only. The granular status of this ad in specific contexts. - # A context here relates to where something ultimately serves (for example, - # a physical location, a platform, an HTTPS vs HTTP request, or the type - # of auction). + # Output only. The granular status of this ad in specific contexts. A context + # here relates to where something ultimately serves (for example, a physical + # location, a platform, an HTTPS vs HTTP request, or the type of auction). # Corresponds to the JSON property `servingRestrictions` # @return [Array] attr_accessor :serving_restrictions - # All vendor IDs for the ads that may be shown from this creative. - # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt - # for possible values. + # All vendor IDs for the ads that may be shown from this creative. See https:// + # storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. # Corresponds to the JSON property `vendorIds` # @return [Array] attr_accessor :vendor_ids @@ -910,8 +871,8 @@ module Google end # Represents creative restrictions associated to Programmatic Guaranteed/ - # Preferred Deal in Ad Manager. - # This doesn't apply to Private Auction and AdX Preferred Deals. + # Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX + # Preferred Deals. class CreativeRestrictions include Google::Apis::Core::Hashable @@ -946,10 +907,10 @@ module Google class CreativeSize include Google::Apis::Core::Hashable - # What formats are allowed by the publisher. - # If this repeated field is empty then all formats are allowed. - # For example, if this field contains AllowedFormatType.AUDIO then the - # publisher only allows an audio ad (without any video). + # What formats are allowed by the publisher. If this repeated field is empty + # then all formats are allowed. For example, if this field contains + # AllowedFormatType.AUDIO then the publisher only allows an audio ad (without + # any video). # Corresponds to the JSON property `allowedFormats` # @return [Array] attr_accessor :allowed_formats @@ -965,14 +926,14 @@ module Google # @return [String] attr_accessor :creative_size_type - # Output only. The native template for this creative. It will have a value - # only if creative_size_type = CreativeSizeType.NATIVE. + # Output only. The native template for this creative. It will have a value only + # if creative_size_type = CreativeSizeType.NATIVE. # Corresponds to the JSON property `nativeTemplate` # @return [String] attr_accessor :native_template - # Message depicting the size of the creative. The units of width and - # height depend on the type of the targeting. + # Message depicting the size of the creative. The units of width and height + # depend on the type of the targeting. # Corresponds to the JSON property `size` # @return [Google::Apis::Adexchangebuyer2V2beta1::Size] attr_accessor :size @@ -1030,16 +991,14 @@ module Google class CreativeStatusRow include Google::Apis::Core::Hashable - # A metric value, with an expected value and a variance; represents a count - # that may be either exact or estimated (i.e. when sampled). + # A metric value, with an expected value and a variance; represents a count that + # may be either exact or estimated (i.e. when sampled). # Corresponds to the JSON property `bidCount` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :bid_count - # The ID of the creative status. - # See - # [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/ - # downloads/creative-status-codes). + # The ID of the creative status. See [creative-status-codes](https://developers. + # google.com/authorized-buyers/rtb/downloads/creative-status-codes). # Corresponds to the JSON property `creativeStatusId` # @return [Fixnum] attr_accessor :creative_status_id @@ -1090,30 +1049,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 @@ -1130,8 +1088,8 @@ module Google end end - # Daypart targeting message that specifies if the ad can be shown - # only during certain parts of a day/week. + # Daypart targeting message that specifies if the ad can be shown only during + # certain parts of a day/week. class DayPart include Google::Apis::Core::Hashable @@ -1140,15 +1098,15 @@ module Google # @return [String] attr_accessor :day_of_week - # 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 `endTime` # @return [Google::Apis::Adexchangebuyer2V2beta1::TimeOfDay] attr_accessor :end_time - # 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 `startTime` # @return [Google::Apis::Adexchangebuyer2V2beta1::TimeOfDay] @@ -1191,24 +1149,23 @@ module Google end end - # A deal represents a segment of inventory for displaying ads on. - # A proposal can contain multiple deals. A deal contains the terms and - # targeting information that is used for serving. + # A deal represents a segment of inventory for displaying ads on. A proposal can + # contain multiple deals. A deal contains the terms and targeting information + # that is used for serving. class Deal include Google::Apis::Core::Hashable - # Proposed flight end time of the deal. - # This will generally be stored in a granularity of a second. - # A value is not required for Private Auction deals or Preferred Deals. + # Proposed flight end time of the deal. This will generally be stored in a + # granularity of a second. A value is not required for Private Auction deals or + # Preferred Deals. # Corresponds to the JSON property `availableEndTime` # @return [String] attr_accessor :available_end_time - # Optional proposed flight start time of the deal. - # This will generally be stored in the granularity of one second since deal - # serving starts at seconds boundary. Any time specified with more - # granularity (e.g., in milliseconds) will be truncated towards the start of - # time in seconds. + # Optional proposed flight start time of the deal. This will generally be stored + # in the granularity of one second since deal serving starts at seconds boundary. + # Any time specified with more granularity (e.g., in milliseconds) will be + # truncated towards the start of time in seconds. # Corresponds to the JSON property `availableStartTime` # @return [String] attr_accessor :available_start_time @@ -1218,19 +1175,18 @@ module Google # @return [Google::Apis::Adexchangebuyer2V2beta1::PrivateData] attr_accessor :buyer_private_data - # The product ID from which this deal was created. - # Note: This field may be set only when creating the resource. Modifying - # this field while updating the resource will result in an error. + # The product ID from which this deal was created. Note: This field may be set + # only when creating the resource. Modifying this field while updating the + # resource will result in an error. # Corresponds to the JSON property `createProductId` # @return [String] attr_accessor :create_product_id - # Optional revision number of the product that the deal was created from. - # If present on create, and the server `product_revision` has advanced sinced - # the passed-in `create_product_revision`, an `ABORTED` error will be - # returned. - # Note: This field may be set only when creating the resource. Modifying - # this field while updating the resource will result in an error. + # Optional revision number of the product that the deal was created from. If + # present on create, and the server `product_revision` has advanced sinced the + # passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: + # This field may be set only when creating the resource. Modifying this field + # while updating the resource will result in an error. # Corresponds to the JSON property `createProductRevision` # @return [Fixnum] attr_accessor :create_product_revision @@ -1246,8 +1202,8 @@ module Google attr_accessor :creative_pre_approval_policy # Represents creative restrictions associated to Programmatic Guaranteed/ - # Preferred Deal in Ad Manager. - # This doesn't apply to Private Auction and AdX Preferred Deals. + # Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX + # Preferred Deals. # Corresponds to the JSON property `creativeRestrictions` # @return [Google::Apis::Adexchangebuyer2V2beta1::CreativeRestrictions] attr_accessor :creative_restrictions @@ -1267,9 +1223,9 @@ module Google # @return [Google::Apis::Adexchangebuyer2V2beta1::DealServingMetadata] attr_accessor :deal_serving_metadata - # The deal terms specify the details of a Product/deal. They specify things - # like price per buyer, the type of pricing model (e.g., fixed price, auction) - # and expected impressions from the publisher. + # The deal terms specify the details of a Product/deal. They specify things like + # price per buyer, the type of pricing model (e.g., fixed price, auction) and + # expected impressions from the publisher. # Corresponds to the JSON property `dealTerms` # @return [Google::Apis::Adexchangebuyer2V2beta1::DealTerms] attr_accessor :deal_terms @@ -1295,16 +1251,15 @@ module Google # @return [String] attr_accessor :external_deal_id - # Output only. True, if the buyside inventory setup is complete for this - # deal. + # Output only. True, if the buyside inventory setup is complete for this deal. # Corresponds to the JSON property `isSetupComplete` # @return [Boolean] attr_accessor :is_setup_complete alias_method :is_setup_complete?, :is_setup_complete - # Output only. Specifies the creative source for programmatic deals. - # PUBLISHER means creative is provided by seller and ADVERTISER means - # creative is provided by buyer. + # Output only. Specifies the creative source for programmatic deals. PUBLISHER + # means creative is provided by seller and ADVERTISER means creative is provided + # by buyer. # Corresponds to the JSON property `programmaticCreativeSource` # @return [String] attr_accessor :programmatic_creative_source @@ -1319,24 +1274,23 @@ module Google # @return [Array] attr_accessor :seller_contacts - # The syndication product associated with the deal. - # Note: This field may be set only when creating the resource. Modifying - # this field while updating the resource will result in an error. + # The syndication product associated with the deal. Note: This field may be set + # only when creating the resource. Modifying this field while updating the + # resource will result in an error. # Corresponds to the JSON property `syndicationProduct` # @return [String] attr_accessor :syndication_product # Targeting represents different criteria that can be used by advertisers to # target ad inventory. For example, they can choose to target ad requests only - # if the user is in the US. - # Multiple types of targeting are always applied as a logical AND, unless noted - # otherwise. + # if the user is in the US. Multiple types of targeting are always applied as a + # logical AND, unless noted otherwise. # Corresponds to the JSON property `targeting` # @return [Google::Apis::Adexchangebuyer2V2beta1::MarketplaceTargeting] attr_accessor :targeting - # The shared targeting visible to buyers and sellers. Each shared - # targeting entity is AND'd together. + # The shared targeting visible to buyers and sellers. Each shared targeting + # entity is AND'd together. # Corresponds to the JSON property `targetingCriterion` # @return [Array] attr_accessor :targeting_criterion @@ -1385,9 +1339,8 @@ module Google end end - # Tracks which parties (if any) have paused a deal. - # The deal is considered paused if either hasBuyerPaused or - # hasSellPaused is true. + # Tracks which parties (if any) have paused a deal. The deal is considered + # paused if either hasBuyerPaused or hasSellPaused is true. class DealPauseStatus include Google::Apis::Core::Hashable @@ -1436,9 +1389,8 @@ module Google class DealServingMetadata include Google::Apis::Core::Hashable - # Tracks which parties (if any) have paused a deal. - # The deal is considered paused if either hasBuyerPaused or - # hasSellPaused is true. + # Tracks which parties (if any) have paused a deal. The deal is considered + # paused if either hasBuyerPaused or hasSellPaused is true. # Corresponds to the JSON property `dealPauseStatus` # @return [Google::Apis::Adexchangebuyer2V2beta1::DealPauseStatus] attr_accessor :deal_pause_status @@ -1453,9 +1405,9 @@ module Google end end - # The deal terms specify the details of a Product/deal. They specify things - # like price per buyer, the type of pricing model (e.g., fixed price, auction) - # and expected impressions from the publisher. + # The deal terms specify the details of a Product/deal. They specify things like + # price per buyer, the type of pricing model (e.g., fixed price, auction) and + # expected impressions from the publisher. class DealTerms include Google::Apis::Core::Hashable @@ -1474,8 +1426,8 @@ module Google # @return [Google::Apis::Adexchangebuyer2V2beta1::Price] attr_accessor :estimated_gross_spend - # Non-binding estimate of the impressions served per day. - # Can be set by buyer or seller. + # Non-binding estimate of the impressions served per day. Can be set by buyer or + # seller. # Corresponds to the JSON property `estimatedImpressionsPerDay` # @return [Fixnum] attr_accessor :estimated_impressions_per_day @@ -1485,22 +1437,22 @@ module Google # @return [Google::Apis::Adexchangebuyer2V2beta1::GuaranteedFixedPriceTerms] attr_accessor :guaranteed_fixed_price_terms - # Terms for Private Auctions. Note that Private Auctions can be created only - # by the seller, but they can be returned in a get or list request. + # Terms for Private Auctions. Note that Private Auctions can be created only by + # the seller, but they can be returned in a get or list request. # Corresponds to the JSON property `nonGuaranteedAuctionTerms` # @return [Google::Apis::Adexchangebuyer2V2beta1::NonGuaranteedAuctionTerms] attr_accessor :non_guaranteed_auction_terms - # Terms for Preferred Deals. Note that Preferred Deals cannot be created via - # the API at this time, but can be returned in a get or list request. + # Terms for Preferred Deals. Note that Preferred Deals cannot be created via the + # API at this time, but can be returned in a get or list request. # Corresponds to the JSON property `nonGuaranteedFixedPriceTerms` # @return [Google::Apis::Adexchangebuyer2V2beta1::NonGuaranteedFixedPriceTerms] attr_accessor :non_guaranteed_fixed_price_terms - # The time zone name. For deals with Cost Per Day billing, defines the - # time zone used to mark the boundaries of a day. It should be an - # IANA TZ name, such as "America/Los_Angeles". For more information, - # see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. + # The time zone name. For deals with Cost Per Day billing, defines the time zone + # used to mark the boundaries of a day. It should be an IANA TZ name, such as " + # America/Los_Angeles". For more information, see https://en.wikipedia.org/wiki/ + # List_of_tz_database_time_zones. # Corresponds to the JSON property `sellerTimeZone` # @return [String] attr_accessor :seller_time_zone @@ -1578,13 +1530,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 @@ -1597,43 +1547,39 @@ module Google end end - # A set of filters that is applied to a request for data. - # Within a filter set, an AND operation is performed across the filters - # represented by each field. An OR operation is performed across the filters - # represented by the multiple values of a repeated field, e.g., - # "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR - # seller_network_id=56)". + # A set of filters that is applied to a request for data. Within a filter set, + # an AND operation is performed across the filters represented by each field. An + # OR operation is performed across the filters represented by the multiple + # values of a repeated field, e.g., "format=VIDEO AND deal_id=12 AND ( + # seller_network_id=34 OR seller_network_id=56)". class FilterSet include Google::Apis::Core::Hashable - # An absolute date range, specified by its start date and end date. - # The supported range of dates begins 30 days before today and ends today. - # Validity checked upon filter set creation. If a filter set with an absolute - # date range is run at a later date more than 30 days after start_date, it will - # fail. + # An absolute date range, specified by its start date and end date. The + # supported range of dates begins 30 days before today and ends today. Validity + # checked upon filter set creation. If a filter set with an absolute date range + # is run at a later date more than 30 days after start_date, it will fail. # Corresponds to the JSON property `absoluteDateRange` # @return [Google::Apis::Adexchangebuyer2V2beta1::AbsoluteDateRange] attr_accessor :absolute_date_range - # The set of dimensions along which to break down the response; may be empty. - # If multiple dimensions are requested, the breakdown is along the Cartesian + # The set of dimensions along which to break down the response; may be empty. If + # multiple dimensions are requested, the breakdown is along the Cartesian # product of the requested dimensions. # Corresponds to the JSON property `breakdownDimensions` # @return [Array] attr_accessor :breakdown_dimensions # The ID of the creative on which to filter; optional. This field may be set - # only for a filter set that accesses account-level troubleshooting data, - # i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` - # pattern. + # only for a filter set that accesses account-level troubleshooting data, i.e., + # one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. # Corresponds to the JSON property `creativeId` # @return [String] attr_accessor :creative_id - # The ID of the deal on which to filter; optional. This field may be set - # only for a filter set that accesses account-level troubleshooting data, - # i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` - # pattern. + # The ID of the deal on which to filter; optional. This field may be set only + # for a filter set that accesses account-level troubleshooting data, i.e., one + # whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. # Corresponds to the JSON property `dealId` # @return [Fixnum] attr_accessor :deal_id @@ -1648,21 +1594,18 @@ module Google # @return [String] attr_accessor :format - # Creative formats bidded on or allowed to bid on, can be empty. Although - # this field is a list, it can only be populated with a single item. A - # HTTP 400 bad request error will be returned in the response if you specify - # multiple items. + # Creative formats bidded on or allowed to bid on, can be empty. Although this + # field is a list, it can only be populated with a single item. A HTTP 400 bad + # request error will be returned in the response if you specify multiple items. # Corresponds to the JSON property `formats` # @return [Array] attr_accessor :formats # A user-defined name of the filter set. Filter set names must be unique - # globally and match one of the patterns: - # - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting - # data) - # - `bidders/*/accounts/*/filterSets/*` (for accessing account-level - # troubleshooting data) - # This field is required in create operations. + # globally and match one of the patterns: - `bidders/*/filterSets/*` (for + # accessing bidder-level troubleshooting data) - `bidders/*/accounts/*/ + # filterSets/*` (for accessing account-level troubleshooting data) This field is + # required in create operations. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1674,39 +1617,34 @@ module Google # @return [Array] attr_accessor :platforms - # For Open Bidding partners only. - # The list of publisher identifiers on which to filter; may be empty. - # The filters represented by multiple publisher identifiers are ORed - # together. + # For Open Bidding partners only. The list of publisher identifiers on which to + # filter; may be empty. The filters represented by multiple publisher + # identifiers are ORed together. # Corresponds to the JSON property `publisherIdentifiers` # @return [Array] attr_accessor :publisher_identifiers - # An open-ended realtime time range specified by the start timestamp. - # For filter sets that specify a realtime time range RTB metrics continue to - # be aggregated throughout the lifetime of the filter set. + # An open-ended realtime time range specified by the start timestamp. For filter + # sets that specify a realtime time range RTB metrics continue to be aggregated + # throughout the lifetime of the filter set. # Corresponds to the JSON property `realtimeTimeRange` # @return [Google::Apis::Adexchangebuyer2V2beta1::RealtimeTimeRange] attr_accessor :realtime_time_range - # A relative date range, specified by an offset and a duration. - # The supported range of dates begins 30 days before today and ends today, - # i.e., the limits for these values are: - # offset_days >= 0 - # duration_days >= 1 - # offset_days + duration_days <= 30 + # A relative date range, specified by an offset and a duration. The supported + # range of dates begins 30 days before today and ends today, i.e., the limits + # for these values are: offset_days >= 0 duration_days >= 1 offset_days + + # duration_days <= 30 # Corresponds to the JSON property `relativeDateRange` # @return [Google::Apis::Adexchangebuyer2V2beta1::RelativeDateRange] attr_accessor :relative_date_range - # For Authorized Buyers only. - # The list of IDs of the seller (publisher) networks on which to filter; - # may be empty. The filters represented by multiple seller network IDs are - # ORed together (i.e., if non-empty, results must match any one of the - # publisher networks). See - # [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/ - # downloads/seller-network-ids) - # file for the set of existing seller network IDs. + # For Authorized Buyers only. The list of IDs of the seller (publisher) networks + # on which to filter; may be empty. The filters represented by multiple seller + # network IDs are ORed together (i.e., if non-empty, results must match any one + # of the publisher networks). See [seller-network-ids](https://developers.google. + # com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of + # existing seller network IDs. # Corresponds to the JSON property `sellerNetworkIds` # @return [Array] attr_accessor :seller_network_ids @@ -1745,8 +1683,8 @@ module Google class FilteredBidCreativeRow include Google::Apis::Core::Hashable - # A metric value, with an expected value and a variance; represents a count - # that may be either exact or estimated (i.e. when sampled). + # A metric value, with an expected value and a variance; represents a count that + # may be either exact or estimated (i.e. when sampled). # Corresponds to the JSON property `bidCount` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :bid_count @@ -1780,14 +1718,14 @@ module Google class FilteredBidDetailRow include Google::Apis::Core::Hashable - # A metric value, with an expected value and a variance; represents a count - # that may be either exact or estimated (i.e. when sampled). + # A metric value, with an expected value and a variance; represents a count that + # may be either exact or estimated (i.e. when sampled). # Corresponds to the JSON property `bidCount` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :bid_count - # The ID of the detail. The associated value can be looked up in the - # dictionary file corresponding to the DetailType in the response message. + # The ID of the detail. The associated value can be looked up in the dictionary + # file corresponding to the DetailType in the response message. # Corresponds to the JSON property `detailId` # @return [Fixnum] attr_accessor :detail_id @@ -1811,12 +1749,11 @@ module Google end # Represents a list of targeted and excluded mobile application IDs that - # publishers own. - # Mobile application IDs are from App Store and Google Play Store. - # Android App ID, for example, com.google.android.apps.maps, can be found in - # Google Play Store URL. - # iOS App ID (which is a number) can be found at the end of iTunes store URL. - # First party mobile applications is either included or excluded. + # publishers own. Mobile application IDs are from App Store and Google Play + # Store. Android App ID, for example, com.google.android.apps.maps, can be found + # in Google Play Store URL. iOS App ID (which is a number) can be found at the + # end of iTunes store URL. First party mobile applications is either included or + # excluded. class FirstPartyMobileApplicationTargeting include Google::Apis::Core::Hashable @@ -1857,8 +1794,8 @@ module Google # @return [Fixnum] attr_accessor :num_time_units - # The time unit. Along with num_time_units defines the amount of time over - # which impressions per user are counted and capped. + # The time unit. Along with num_time_units defines the amount of time over which + # impressions per user are counted and capped. # Corresponds to the JSON property `timeUnitType` # @return [String] attr_accessor :time_unit_type @@ -1884,8 +1821,8 @@ module Google # @return [Array] attr_accessor :fixed_prices - # Guaranteed impressions as a percentage. This is the percentage - # of guaranteed looks that the buyer is guaranteeing to buy. + # Guaranteed impressions as a percentage. This is the percentage of guaranteed + # looks that the buyer is guaranteeing to buy. # Corresponds to the JSON property `guaranteedImpressions` # @return [Fixnum] attr_accessor :guaranteed_impressions @@ -1944,8 +1881,8 @@ module Google end end - # An image resource. You may provide a larger image than was requested, - # so long as the aspect ratio is preserved. + # An image resource. You may provide a larger image than was requested, so long + # as the aspect ratio is preserved. class Image include Google::Apis::Core::Hashable @@ -1982,26 +1919,26 @@ module Google class ImpressionMetricsRow include Google::Apis::Core::Hashable - # A metric value, with an expected value and a variance; represents a count - # that may be either exact or estimated (i.e. when sampled). + # A metric value, with an expected value and a variance; represents a count that + # may be either exact or estimated (i.e. when sampled). # Corresponds to the JSON property `availableImpressions` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :available_impressions - # A metric value, with an expected value and a variance; represents a count - # that may be either exact or estimated (i.e. when sampled). + # A metric value, with an expected value and a variance; represents a count that + # may be either exact or estimated (i.e. when sampled). # Corresponds to the JSON property `bidRequests` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :bid_requests - # A metric value, with an expected value and a variance; represents a count - # that may be either exact or estimated (i.e. when sampled). + # A metric value, with an expected value and a variance; represents a count that + # may be either exact or estimated (i.e. when sampled). # Corresponds to the JSON property `inventoryMatches` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :inventory_matches - # A metric value, with an expected value and a variance; represents a count - # that may be either exact or estimated (i.e. when sampled). + # A metric value, with an expected value and a variance; represents a count that + # may be either exact or estimated (i.e. when sampled). # Corresponds to the JSON property `responsesWithBids` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :responses_with_bids @@ -2012,8 +1949,8 @@ module Google # @return [Google::Apis::Adexchangebuyer2V2beta1::RowDimensions] attr_accessor :row_dimensions - # A metric value, with an expected value and a variance; represents a count - # that may be either exact or estimated (i.e. when sampled). + # A metric value, with an expected value and a variance; represents a count that + # may be either exact or estimated (i.e. when sampled). # Corresponds to the JSON property `successfulResponses` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :successful_responses @@ -2033,10 +1970,10 @@ module Google end end - # Represents the size of an ad unit that can be targeted on an ad - # request. It only applies to Private Auction, AdX Preferred Deals and - # Auction Packages. This targeting does not apply to Programmatic Guaranteed - # and Preferred Deals in Ad Manager. + # Represents the size of an ad unit that can be targeted on an ad request. It + # only applies to Private Auction, AdX Preferred Deals and Auction Packages. + # This targeting does not apply to Programmatic Guaranteed and Preferred Deals + # in Ad Manager. class InventorySizeTargeting include Google::Apis::Core::Hashable @@ -2070,11 +2007,9 @@ module Google # @return [Array] attr_accessor :bid_metrics_rows - # A token to retrieve the next page of results. - # Pass this value in the - # ListBidMetricsRequest.pageToken - # field in the subsequent call to the bidMetrics.list - # method to retrieve the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # ListBidMetricsRequest.pageToken field in the subsequent call to the bidMetrics. + # list method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2100,11 +2035,9 @@ module Google # @return [Array] attr_accessor :callout_status_rows - # A token to retrieve the next page of results. - # Pass this value in the - # ListBidResponseErrorsRequest.pageToken - # field in the subsequent call to the bidResponseErrors.list - # method to retrieve the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # ListBidResponseErrorsRequest.pageToken field in the subsequent call to the + # bidResponseErrors.list method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2120,22 +2053,19 @@ module Google end end - # Response message for listing all reasons that bid responses were considered - # to have no applicable bids. + # Response message for listing all reasons that bid responses were considered to + # have no applicable bids. class ListBidResponsesWithoutBidsResponse include Google::Apis::Core::Hashable - # List of rows, with counts of bid responses without bids aggregated by - # status. + # List of rows, with counts of bid responses without bids aggregated by status. # Corresponds to the JSON property `bidResponseWithoutBidsStatusRows` # @return [Array] attr_accessor :bid_response_without_bids_status_rows - # A token to retrieve the next page of results. - # Pass this value in the - # ListBidResponsesWithoutBidsRequest.pageToken - # field in the subsequent call to the bidResponsesWithoutBids.list - # method to retrieve the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # ListBidResponsesWithoutBidsRequest.pageToken field in the subsequent call to + # the bidResponsesWithoutBids.list method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2160,13 +2090,9 @@ module Google # @return [Array] attr_accessor :invitations - # A token to retrieve the next page of results. - # Pass this value in the - # ListClientUserInvitationsRequest.pageToken - # field in the subsequent call to the - # clients.invitations.list - # method to retrieve the next - # page of results. + # A token to retrieve the next page of results. Pass this value in the + # ListClientUserInvitationsRequest.pageToken field in the subsequent call to the + # clients.invitations.list method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2186,13 +2112,9 @@ module Google class ListClientUsersResponse include Google::Apis::Core::Hashable - # A token to retrieve the next page of results. - # Pass this value in the - # ListClientUsersRequest.pageToken - # field in the subsequent call to the - # clients.invitations.list - # method to retrieve the next - # page of results. + # A token to retrieve the next page of results. Pass this value in the + # ListClientUsersRequest.pageToken field in the subsequent call to the clients. + # invitations.list method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2222,12 +2144,9 @@ module Google # @return [Array] attr_accessor :clients - # A token to retrieve the next page of results. - # Pass this value in the - # ListClientsRequest.pageToken - # field in the subsequent call to the - # accounts.clients.list - # method to retrieve the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # ListClientsRequest.pageToken field in the subsequent call to the accounts. + # clients.list method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2248,17 +2167,16 @@ module Google class ListCreativeStatusBreakdownByCreativeResponse include Google::Apis::Core::Hashable - # List of rows, with counts of bids with a given creative status aggregated - # by creative. + # List of rows, with counts of bids with a given creative status aggregated by + # creative. # Corresponds to the JSON property `filteredBidCreativeRows` # @return [Array] attr_accessor :filtered_bid_creative_rows - # A token to retrieve the next page of results. - # Pass this value in the - # ListCreativeStatusBreakdownByCreativeRequest.pageToken - # field in the subsequent call to the filteredBids.creatives.list - # method to retrieve the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # ListCreativeStatusBreakdownByCreativeRequest.pageToken field in the subsequent + # call to the filteredBids.creatives.list method to retrieve the next page of + # results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2284,17 +2202,16 @@ module Google # @return [String] attr_accessor :detail_type - # List of rows, with counts of bids with a given creative status aggregated - # by detail. + # List of rows, with counts of bids with a given creative status aggregated by + # detail. # Corresponds to the JSON property `filteredBidDetailRows` # @return [Array] attr_accessor :filtered_bid_detail_rows - # A token to retrieve the next page of results. - # Pass this value in the - # ListCreativeStatusBreakdownByDetailRequest.pageToken - # field in the subsequent call to the filteredBids.details.list - # method to retrieve the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # ListCreativeStatusBreakdownByDetailRequest.pageToken field in the subsequent + # call to the filteredBids.details.list method to retrieve the next page of + # results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2320,11 +2237,9 @@ module Google # @return [Array] attr_accessor :creatives - # A token to retrieve the next page of results. - # Pass this value in the - # ListCreativesRequest.page_token - # field in the subsequent call to `ListCreatives` method to retrieve the next - # page of results. + # A token to retrieve the next page of results. Pass this value in the + # ListCreativesRequest.page_token field in the subsequent call to `ListCreatives` + # method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2349,11 +2264,9 @@ module Google # @return [Array] attr_accessor :associations - # A token to retrieve the next page of results. - # Pass this value in the - # ListDealAssociationsRequest.page_token - # field in the subsequent call to 'ListDealAssociation' method to retrieve - # the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # ListDealAssociationsRequest.page_token field in the subsequent call to ' + # ListDealAssociation' method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2378,12 +2291,9 @@ module Google # @return [Array] attr_accessor :filter_sets - # A token to retrieve the next page of results. - # Pass this value in the - # ListFilterSetsRequest.pageToken - # field in the subsequent call to the - # accounts.filterSets.list - # method to retrieve the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # ListFilterSetsRequest.pageToken field in the subsequent call to the accounts. + # filterSets.list method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2410,11 +2320,9 @@ module Google # @return [Array] attr_accessor :callout_status_rows - # A token to retrieve the next page of results. - # Pass this value in the - # ListFilteredBidRequestsRequest.pageToken - # field in the subsequent call to the filteredBidRequests.list - # method to retrieve the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # ListFilteredBidRequestsRequest.pageToken field in the subsequent call to the + # filteredBidRequests.list method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2435,17 +2343,15 @@ module Google class ListFilteredBidsResponse include Google::Apis::Core::Hashable - # List of rows, with counts of filtered bids aggregated by filtering reason - # (i.e. creative status). + # List of rows, with counts of filtered bids aggregated by filtering reason (i.e. + # creative status). # Corresponds to the JSON property `creativeStatusRows` # @return [Array] attr_accessor :creative_status_rows - # A token to retrieve the next page of results. - # Pass this value in the - # ListFilteredBidsRequest.pageToken - # field in the subsequent call to the filteredBids.list - # method to retrieve the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # ListFilteredBidsRequest.pageToken field in the subsequent call to the + # filteredBids.list method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2471,11 +2377,9 @@ module Google # @return [Array] attr_accessor :impression_metrics_rows - # A token to retrieve the next page of results. - # Pass this value in the - # ListImpressionMetricsRequest.pageToken - # field in the subsequent call to the impressionMetrics.list - # method to retrieve the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # ListImpressionMetricsRequest.pageToken field in the subsequent call to the + # impressionMetrics.list method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2501,11 +2405,9 @@ module Google # @return [Array] attr_accessor :creative_status_rows - # A token to retrieve the next page of results. - # Pass this value in the - # ListLosingBidsRequest.pageToken - # field in the subsequent call to the losingBids.list - # method to retrieve the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # ListLosingBidsRequest.pageToken field in the subsequent call to the losingBids. + # list method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2526,11 +2428,9 @@ module Google class ListNonBillableWinningBidsResponse include Google::Apis::Core::Hashable - # A token to retrieve the next page of results. - # Pass this value in the - # ListNonBillableWinningBidsRequest.pageToken - # field in the subsequent call to the nonBillableWinningBids.list - # method to retrieve the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # ListNonBillableWinningBidsRequest.pageToken field in the subsequent call to + # the nonBillableWinningBids.list method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2630,10 +2530,8 @@ module Google class LocationContext include Google::Apis::Core::Hashable - # IDs representing the geo location for this context. - # Please refer to the - # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table. - # csv) + # IDs representing the geo location for this context. Please refer to the [geo- + # table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) # file for different geo criteria IDs. # Corresponds to the JSON property `geoCriteriaIds` # @return [Array] @@ -2651,9 +2549,8 @@ module Google # Targeting represents different criteria that can be used by advertisers to # target ad inventory. For example, they can choose to target ad requests only - # if the user is in the US. - # Multiple types of targeting are always applied as a logical AND, unless noted - # otherwise. + # if the user is in the US. Multiple types of targeting are always applied as a + # logical AND, unless noted otherwise. class MarketplaceTargeting include Google::Apis::Core::Hashable @@ -2663,17 +2560,17 @@ module Google # @return [Google::Apis::Adexchangebuyer2V2beta1::CriteriaTargeting] attr_accessor :geo_targeting - # Represents the size of an ad unit that can be targeted on an ad - # request. It only applies to Private Auction, AdX Preferred Deals and - # Auction Packages. This targeting does not apply to Programmatic Guaranteed - # and Preferred Deals in Ad Manager. + # Represents the size of an ad unit that can be targeted on an ad request. It + # only applies to Private Auction, AdX Preferred Deals and Auction Packages. + # This targeting does not apply to Programmatic Guaranteed and Preferred Deals + # in Ad Manager. # Corresponds to the JSON property `inventorySizeTargeting` # @return [Google::Apis::Adexchangebuyer2V2beta1::InventorySizeTargeting] attr_accessor :inventory_size_targeting # Represents targeting about where the ads can appear, e.g., certain sites or - # mobile applications. - # Different placement targeting types will be logically OR'ed. + # mobile applications. Different placement targeting types will be logically OR' + # ed. # Corresponds to the JSON property `placementTargeting` # @return [Google::Apis::Adexchangebuyer2V2beta1::PlacementTargeting] attr_accessor :placement_targeting @@ -2702,8 +2599,8 @@ module Google end end - # A metric value, with an expected value and a variance; represents a count - # that may be either exact or estimated (i.e. when sampled). + # A metric value, with an expected value and a variance; represents a count that + # may be either exact or estimated (i.e. when sampled). class MetricValue include Google::Apis::Core::Hashable @@ -2712,13 +2609,12 @@ module Google # @return [Fixnum] attr_accessor :value - # The variance (i.e. square of the standard deviation) of the metric value. - # If value is exact, variance is 0. - # Can be used to calculate margin of error as a percentage of value, using - # the following formula, where Z is the standard constant that depends on the - # desired size of the confidence interval (e.g. for 90% confidence interval, - # use Z = 1.645): - # marginOfError = 100 * Z * sqrt(variance) / value + # The variance (i.e. square of the standard deviation) of the metric value. If + # value is exact, variance is 0. Can be used to calculate margin of error as a + # percentage of value, using the following formula, where Z is the standard + # constant that depends on the desired size of the confidence interval (e.g. for + # 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt( + # variance) / value # Corresponds to the JSON property `variance` # @return [Fixnum] attr_accessor :variance @@ -2739,12 +2635,11 @@ module Google include Google::Apis::Core::Hashable # Represents a list of targeted and excluded mobile application IDs that - # publishers own. - # Mobile application IDs are from App Store and Google Play Store. - # Android App ID, for example, com.google.android.apps.maps, can be found in - # Google Play Store URL. - # iOS App ID (which is a number) can be found at the end of iTunes store URL. - # First party mobile applications is either included or excluded. + # publishers own. Mobile application IDs are from App Store and Google Play + # Store. Android App ID, for example, com.google.android.apps.maps, can be found + # in Google Play Store URL. iOS App ID (which is a number) can be found at the + # end of iTunes store URL. First party mobile applications is either included or + # excluded. # Corresponds to the JSON property `firstPartyTargeting` # @return [Google::Apis::Adexchangebuyer2V2beta1::FirstPartyMobileApplicationTargeting] attr_accessor :first_party_targeting @@ -2768,18 +2663,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 @@ -2805,8 +2699,8 @@ module Google # @return [String] attr_accessor :advertiser_name - # An image resource. You may provide a larger image than was requested, - # so long as the aspect ratio is preserved. + # An image resource. You may provide a larger image than was requested, so long + # as the aspect ratio is preserved. # Corresponds to the JSON property `appIcon` # @return [Google::Apis::Adexchangebuyer2V2beta1::Image] attr_accessor :app_icon @@ -2836,14 +2730,14 @@ module Google # @return [String] attr_accessor :headline - # An image resource. You may provide a larger image than was requested, - # so long as the aspect ratio is preserved. + # An image resource. You may provide a larger image than was requested, so long + # as the aspect ratio is preserved. # Corresponds to the JSON property `image` # @return [Google::Apis::Adexchangebuyer2V2beta1::Image] attr_accessor :image - # An image resource. You may provide a larger image than was requested, - # so long as the aspect ratio is preserved. + # An image resource. You may provide a larger image than was requested, so long + # as the aspect ratio is preserved. # Corresponds to the JSON property `logo` # @return [Google::Apis::Adexchangebuyer2V2beta1::Image] attr_accessor :logo @@ -2895,8 +2789,8 @@ module Google class NonBillableWinningBidStatusRow include Google::Apis::Core::Hashable - # A metric value, with an expected value and a variance; represents a count - # that may be either exact or estimated (i.e. when sampled). + # A metric value, with an expected value and a variance; represents a count that + # may be either exact or estimated (i.e. when sampled). # Corresponds to the JSON property `bidCount` # @return [Google::Apis::Adexchangebuyer2V2beta1::MetricValue] attr_accessor :bid_count @@ -2924,13 +2818,13 @@ module Google end end - # Terms for Private Auctions. Note that Private Auctions can be created only - # by the seller, but they can be returned in a get or list request. + # Terms for Private Auctions. Note that Private Auctions can be created only by + # the seller, but they can be returned in a get or list request. class NonGuaranteedAuctionTerms include Google::Apis::Core::Hashable - # True if open auction buyers are allowed to compete with invited buyers - # in this private auction. + # True if open auction buyers are allowed to compete with invited buyers in this + # private auction. # Corresponds to the JSON property `autoOptimizePrivateAuction` # @return [Boolean] attr_accessor :auto_optimize_private_auction @@ -2952,8 +2846,8 @@ module Google end end - # Terms for Preferred Deals. Note that Preferred Deals cannot be created via - # the API at this time, but can be returned in a get or list request. + # Terms for Preferred Deals. Note that Preferred Deals cannot be created via the + # API at this time, but can be returned in a get or list request. class NonGuaranteedFixedPriceTerms include Google::Apis::Core::Hashable @@ -2986,10 +2880,9 @@ module Google # @return [String] attr_accessor :creator_role - # The actual note to attach. - # (max-length: 1024 unicode code units) - # Note: This field may be set only when creating the resource. Modifying - # this field while updating the resource will result in an error. + # The actual note to attach. (max-length: 1024 unicode code units) Note: This + # field may be set only when creating the resource. Modifying this field while + # updating the resource will result in an error. # Corresponds to the JSON property `note` # @return [String] attr_accessor :note @@ -3049,9 +2942,8 @@ module Google class PauseProposalRequest include Google::Apis::Core::Hashable - # The reason why the proposal is being paused. - # This human readable message will be displayed in the seller's UI. - # (Max length: 1000 unicode code units.) + # The reason why the proposal is being paused. This human readable message will + # be displayed in the seller's UI. (Max length: 1000 unicode code units.) # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -3067,8 +2959,8 @@ module Google end # Represents targeting about where the ads can appear, e.g., certain sites or - # mobile applications. - # Different placement targeting types will be logically OR'ed. + # mobile applications. Different placement targeting types will be logically OR' + # ed. class PlacementTargeting include Google::Apis::Core::Hashable @@ -3077,11 +2969,9 @@ module Google # @return [Google::Apis::Adexchangebuyer2V2beta1::MobileApplicationTargeting] attr_accessor :mobile_application_targeting - # Represents a list of targeted and excluded URLs (e.g., google.com). - # For Private Auction and AdX Preferred Deals, URLs are either included or - # excluded. - # For Programmatic Guaranteed and Preferred Deals, this doesn't - # apply. + # Represents a list of targeted and excluded URLs (e.g., google.com). For + # Private Auction and AdX Preferred Deals, URLs are either included or excluded. + # For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # Corresponds to the JSON property `urlTargeting` # @return [Google::Apis::Adexchangebuyer2V2beta1::UrlTargeting] attr_accessor :url_targeting @@ -3141,17 +3031,17 @@ module Google end end - # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in - # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for - # a particular buyer or buyer/advertiser pair, we look for the most specific + # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a + # product can become 0 or 1 deals. To check if there is a PricePerBuyer for a + # particular buyer or buyer/advertiser pair, we look for the most specific # matching rule - we first look for a rule matching the buyer and advertiser, # next a rule with the buyer but an empty advertiser list, and otherwise look # for a matching rule where no buyer is set. class PricePerBuyer include Google::Apis::Core::Hashable - # The list of advertisers for this price when associated with this buyer. - # If empty, all advertisers with this buyer pay this price. + # The list of advertisers for this price when associated with this buyer. If + # empty, all advertisers with this buyer pay this price. # Corresponds to the JSON property `advertiserIds` # @return [Array] attr_accessor :advertiser_ids @@ -3200,22 +3090,21 @@ module Google end # Note: this resource requires whitelisting for access. Please contact your - # account manager for access to Marketplace resources. - # A product is a segment of inventory that a seller wishes to sell. It is - # associated with certain terms and targeting information which helps the buyer - # know more about the inventory. + # account manager for access to Marketplace resources. A product is a segment of + # inventory that a seller wishes to sell. It is associated with certain terms + # and targeting information which helps the buyer know more about the inventory. class Product include Google::Apis::Core::Hashable - # The proposed end time for the deal. The field will be truncated to the - # order of seconds during serving. + # The proposed end time for the deal. The field will be truncated to the order + # of seconds during serving. # Corresponds to the JSON property `availableEndTime` # @return [String] attr_accessor :available_end_time # Inventory availability dates. The start time will be truncated to seconds - # during serving. Thus, a field specified as 3:23:34.456 (HH:mm:ss.SSS) will - # be truncated to 3:23:34 when serving. + # during serving. Thus, a field specified as 3:23:34.456 (HH:mm:ss.SSS) will be + # truncated to 3:23:34 when serving. # Corresponds to the JSON property `availableStartTime` # @return [String] attr_accessor :available_start_time @@ -3236,9 +3125,9 @@ module Google attr_accessor :display_name # If the creator has already signed off on the product, then the buyer can - # finalize the deal by accepting the product as is. When copying to a - # proposal, if any of the terms are changed, then auto_finalize is - # automatically set to false. + # finalize the deal by accepting the product as is. When copying to a proposal, + # if any of the terms are changed, then auto_finalize is automatically set to + # false. # Corresponds to the JSON property `hasCreatorSignedOff` # @return [Boolean] attr_accessor :has_creator_signed_off @@ -3254,14 +3143,14 @@ module Google # @return [Fixnum] attr_accessor :product_revision - # An ID which can be used by the Publisher Profile API to get more - # information about the seller that created this product. + # An ID which can be used by the Publisher Profile API to get more information + # about the seller that created this product. # Corresponds to the JSON property `publisherProfileId` # @return [String] attr_accessor :publisher_profile_id - # Represents a seller of inventory. Each seller is identified by a unique - # Ad Manager account ID. + # Represents a seller of inventory. Each seller is identified by a unique Ad + # Manager account ID. # Corresponds to the JSON property `seller` # @return [Google::Apis::Adexchangebuyer2V2beta1::Seller] attr_accessor :seller @@ -3278,9 +3167,9 @@ module Google # @return [Array] attr_accessor :targeting_criterion - # The deal terms specify the details of a Product/deal. They specify things - # like price per buyer, the type of pricing model (e.g., fixed price, auction) - # and expected impressions from the publisher. + # The deal terms specify the details of a Product/deal. They specify things like + # price per buyer, the type of pricing model (e.g., fixed price, auction) and + # expected impressions from the publisher. # Corresponds to the JSON property `terms` # @return [Google::Apis::Adexchangebuyer2V2beta1::DealTerms] attr_accessor :terms @@ -3321,12 +3210,10 @@ module Google end # Note: this resource requires whitelisting for access. Please contact your - # account manager for access to Marketplace resources. - # Represents a proposal in the Marketplace. A proposal is the unit of - # negotiation between a seller and a buyer and contains deals which - # are served. - # Note: you can not update, create, or otherwise modify Private - # Auction or Preferred Deals deals through the API. + # account manager for access to Marketplace resources. Represents a proposal in + # the Marketplace. A proposal is the unit of negotiation between a seller and a + # buyer and contains deals which are served. Note: you can not update, create, + # or otherwise modify Private Auction or Preferred Deals deals through the API. # Fields are updatable unless noted otherwise. class Proposal include Google::Apis::Core::Hashable @@ -3353,8 +3240,8 @@ module Google # @return [Google::Apis::Adexchangebuyer2V2beta1::PrivateData] attr_accessor :buyer_private_data - # The deals associated with this proposal. For Private Auction proposals - # (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. + # The deals associated with this proposal. For Private Auction proposals (whose + # deals have NonGuaranteedAuctionTerms), there will only be one deal. # Corresponds to the JSON property `deals` # @return [Array] attr_accessor :deals @@ -3393,8 +3280,7 @@ module Google # @return [String] attr_accessor :originator_role - # Output only. Private auction ID if this proposal is a private auction - # proposal. + # Output only. Private auction ID if this proposal is a private auction proposal. # Corresponds to the JSON property `privateAuctionId` # @return [String] attr_accessor :private_auction_id @@ -3404,13 +3290,12 @@ module Google # @return [String] attr_accessor :proposal_id - # Output only. The revision number for the proposal. - # Each update to the proposal or the deal causes the proposal revision number - # to auto-increment. The buyer keeps track of the last revision number they - # know of and pass it in when making an update. If the head revision number - # on the server has since incremented, then an ABORTED error is returned - # during the update operation to let the buyer know that a subsequent update - # was made. + # Output only. The revision number for the proposal. Each update to the proposal + # or the deal causes the proposal revision number to auto-increment. The buyer + # keeps track of the last revision number they know of and pass it in when + # making an update. If the head revision number on the server has since + # incremented, then an ABORTED error is returned during the update operation to + # let the buyer know that a subsequent update was made. # Corresponds to the JSON property `proposalRevision` # @return [Fixnum] attr_accessor :proposal_revision @@ -3420,8 +3305,8 @@ module Google # @return [String] attr_accessor :proposal_state - # Represents a seller of inventory. Each seller is identified by a unique - # Ad Manager account ID. + # Represents a seller of inventory. Each seller is identified by a unique Ad + # Manager account ID. # Corresponds to the JSON property `seller` # @return [Google::Apis::Adexchangebuyer2V2beta1::Seller] attr_accessor :seller @@ -3464,11 +3349,10 @@ module Google end # Note: this resource requires whitelisting for access. Please contact your - # account manager for access to Marketplace resources. - # Represents a publisher profile - # (https://support.google.com/admanager/answer/6035806?hl=en) in Marketplace. - # All fields are read only. All string fields are free-form text entered by the - # publisher unless noted otherwise. + # account manager for access to Marketplace resources. Represents a publisher + # profile (https://support.google.com/admanager/answer/6035806?hl=en) in + # Marketplace. All fields are read only. All string fields are free-form text + # entered by the publisher unless noted otherwise. class PublisherProfile include Google::Apis::Core::Hashable @@ -3477,15 +3361,15 @@ module Google # @return [String] attr_accessor :audience_description - # Statement explaining what's unique about publisher's business, and why - # buyers should partner with the publisher. + # Statement explaining what's unique about publisher's business, and why buyers + # should partner with the publisher. # Corresponds to the JSON property `buyerPitchStatement` # @return [String] attr_accessor :buyer_pitch_statement - # Contact information for direct reservation deals. This is free text entered - # by the publisher and may include information like names, phone numbers and - # email addresses. + # Contact information for direct reservation deals. This is free text entered by + # the publisher and may include information like names, phone numbers and email + # addresses. # Corresponds to the JSON property `directDealsContact` # @return [String] attr_accessor :direct_deals_contact @@ -3495,10 +3379,10 @@ module Google # @return [String] attr_accessor :display_name - # The list of domains represented in this publisher profile. Empty if this is - # a parent profile. These are top private domains, meaning that these will - # not contain a string like "photos.google.co.uk/123", but will instead - # contain "google.co.uk". + # The list of domains represented in this publisher profile. Empty if this is a + # parent profile. These are top private domains, meaning that these will not + # contain a string like "photos.google.co.uk/123", but will instead contain " + # google.co.uk". # Corresponds to the JSON property `domains` # @return [Array] attr_accessor :domains @@ -3511,17 +3395,17 @@ module Google # Indicates if this profile is the parent profile of the seller. A parent # profile represents all the inventory from the seller, as opposed to child # profile that is created to brand a portion of inventory. One seller should - # have only one parent publisher profile, and can have multiple child - # profiles. Publisher profiles for the same seller will have same value of - # field google.ads.adexchange.buyer.v2beta1.PublisherProfile.seller. - # See https://support.google.com/admanager/answer/6035806?hl=en for details. + # have only one parent publisher profile, and can have multiple child profiles. + # Publisher profiles for the same seller will have same value of field google. + # ads.adexchange.buyer.v2beta1.PublisherProfile.seller. See https://support. + # google.com/admanager/answer/6035806?hl=en for details. # Corresponds to the JSON property `isParent` # @return [Boolean] attr_accessor :is_parent alias_method :is_parent?, :is_parent - # A Google public URL to the logo for this publisher profile. The logo is - # stored as a PNG, JPG, or GIF image. + # A Google public URL to the logo for this publisher profile. The logo is stored + # as a PNG, JPG, or GIF image. # Corresponds to the JSON property `logoUrl` # @return [String] attr_accessor :logo_url @@ -3536,9 +3420,9 @@ module Google # @return [String] attr_accessor :overview - # Contact information for programmatic deals. This is free text entered by - # the publisher and may include information like names, phone numbers and - # email addresses. + # Contact information for programmatic deals. This is free text entered by the + # publisher and may include information like names, phone numbers and email + # addresses. # Corresponds to the JSON property `programmaticDealsContact` # @return [String] attr_accessor :programmatic_deals_contact @@ -3558,14 +3442,14 @@ module Google # @return [String] attr_accessor :sample_page_url - # Represents a seller of inventory. Each seller is identified by a unique - # Ad Manager account ID. + # Represents a seller of inventory. Each seller is identified by a unique Ad + # Manager account ID. # Corresponds to the JSON property `seller` # @return [Google::Apis::Adexchangebuyer2V2beta1::Seller] attr_accessor :seller - # Up to three key metrics and rankings. Max 100 characters each. - # For example "#1 Mobile News Site for 20 Straight Months". + # Up to three key metrics and rankings. Max 100 characters each. For example "#1 + # Mobile News Site for 20 Straight Months". # Corresponds to the JSON property `topHeadlines` # @return [Array] attr_accessor :top_headlines @@ -3595,9 +3479,9 @@ module Google end end - # An open-ended realtime time range specified by the start timestamp. - # For filter sets that specify a realtime time range RTB metrics continue to - # be aggregated throughout the lifetime of the filter set. + # An open-ended realtime time range specified by the start timestamp. For filter + # sets that specify a realtime time range RTB metrics continue to be aggregated + # throughout the lifetime of the filter set. class RealtimeTimeRange include Google::Apis::Core::Hashable @@ -3616,12 +3500,10 @@ module Google end end - # A relative date range, specified by an offset and a duration. - # The supported range of dates begins 30 days before today and ends today, - # i.e., the limits for these values are: - # offset_days >= 0 - # duration_days >= 1 - # offset_days + duration_days <= 30 + # A relative date range, specified by an offset and a duration. The supported + # range of dates begins 30 days before today and ends today, i.e., the limits + # for these values are: offset_days >= 0 duration_days >= 1 offset_days + + # duration_days <= 30 class RelativeDateRange include Google::Apis::Core::Hashable @@ -3631,8 +3513,8 @@ module Google # @return [Fixnum] attr_accessor :duration_days - # The end date of the filter set, specified as the number of days before - # today, e.g., for a range where the last date is today: 0. + # The end date of the filter set, specified as the number of days before today, + # e.g., for a range where the last date is today: 0. # Corresponds to the JSON property `offsetDays` # @return [Fixnum] attr_accessor :offset_days @@ -3667,8 +3549,7 @@ module Google end end - # Request message to resume (unpause) serving for an already-finalized - # proposal. + # Request message to resume (unpause) serving for an already-finalized proposal. class ResumeProposalRequest include Google::Apis::Core::Hashable @@ -3686,11 +3567,10 @@ module Google class RowDimensions include Google::Apis::Core::Hashable - # The publisher identifier for this row, if a breakdown by - # [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/ - # authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets# - # FilterSet.BreakdownDimension) - # was requested. + # The publisher identifier for this row, if a breakdown by [BreakdownDimension. + # PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/ + # reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet. + # BreakdownDimension) was requested. # Corresponds to the JSON property `publisherIdentifier` # @return [String] attr_accessor :publisher_identifier @@ -3730,13 +3610,13 @@ module Google end end - # Represents a seller of inventory. Each seller is identified by a unique - # Ad Manager account ID. + # Represents a seller of inventory. Each seller is identified by a unique Ad + # Manager account ID. class Seller include Google::Apis::Core::Hashable - # The unique ID for the seller. The seller fills in this field. - # The seller account ID is then available to buyer in the product. + # The unique ID for the seller. The seller fills in this field. The seller + # account ID is then available to buyer in the product. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id @@ -3806,10 +3686,10 @@ module Google end end - # Output only. A representation of the status of an ad in a - # specific context. A context here relates to where something ultimately serves - # (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, - # or the type of auction). + # Output only. A representation of the status of an ad in a specific context. A + # context here relates to where something ultimately serves (for example, a user + # or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction) + # . class ServingRestriction include Google::Apis::Core::Hashable @@ -3823,14 +3703,9 @@ module Google # @return [Google::Apis::Adexchangebuyer2V2beta1::Disapproval] attr_accessor :disapproval - # Any disapprovals bound to this restriction. - # Only present if status=DISAPPROVED. - # Can be used to filter the response of the - # creatives.list - # method. - # Deprecated; please use - # disapproval - # field instead. + # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. + # Can be used to filter the response of the creatives.list method. Deprecated; + # please use disapproval field instead. # Corresponds to the JSON property `disapprovalReasons` # @return [Array] attr_accessor :disapproval_reasons @@ -3854,8 +3729,8 @@ module Google end end - # Message depicting the size of the creative. The units of width and - # height depend on the type of the targeting. + # Message depicting the size of the creative. The units of width and height + # depend on the type of the targeting. class Size include Google::Apis::Core::Hashable @@ -3893,14 +3768,13 @@ module Google end end - # Advertisers can target different attributes of an ad slot. For example, - # they can choose to show ads only if the user is in the U.S. Such - # targeting criteria can be specified as part of Shared Targeting. + # Advertisers can target different attributes of an ad slot. For example, they + # can choose to show ads only if the user is in the U.S. Such targeting criteria + # can be specified as part of Shared Targeting. class TargetingCriteria include Google::Apis::Core::Hashable - # The list of values to exclude from targeting. Each value is AND'd - # together. + # The list of values to exclude from targeting. Each value is AND'd together. # Corresponds to the JSON property `exclusions` # @return [Array] attr_accessor :exclusions @@ -3911,11 +3785,10 @@ module Google # @return [Array] attr_accessor :inclusions - # The key representing the shared targeting criterion. - # Targeting criteria defined by Google ad servers will begin with GOOG_. - # Third parties may define their own keys. - # A list of permissible keys along with the acceptable values will be - # provided as part of the external documentation. + # The key representing the shared targeting criterion. Targeting criteria + # defined by Google ad servers will begin with GOOG_. Third parties may define + # their own keys. A list of permissible keys along with the acceptable values + # will be provided as part of the external documentation. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key @@ -4029,14 +3902,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 @@ -4070,11 +3943,9 @@ module Google end end - # Represents a list of targeted and excluded URLs (e.g., google.com). - # For Private Auction and AdX Preferred Deals, URLs are either included or - # excluded. - # For Programmatic Guaranteed and Preferred Deals, this doesn't - # apply. + # Represents a list of targeted and excluded URLs (e.g., google.com). For + # Private Auction and AdX Preferred Deals, URLs are either included or excluded. + # For Programmatic Guaranteed and Preferred Deals, this doesn't apply. class UrlTargeting include Google::Apis::Core::Hashable @@ -4108,8 +3979,8 @@ module Google # @return [String] attr_accessor :video_url - # The contents of a VAST document for a video ad. - # This document should conform to the VAST 2.0 or 3.0 standard. + # The contents of a VAST document for a video ad. This document should conform + # to the VAST 2.0 or 3.0 standard. # Corresponds to the JSON property `videoVastXml` # @return [String] attr_accessor :video_vast_xml @@ -4129,15 +4000,15 @@ module Google class VideoTargeting include Google::Apis::Core::Hashable - # A list of video positions to be excluded. - # Position types can either be included or excluded (XOR). + # A list of video positions to be excluded. Position types can either be + # included or excluded (XOR). # Corresponds to the JSON property `excludedPositionTypes` # @return [Array] attr_accessor :excluded_position_types - # A list of video positions to be included. - # When the included list is present, the excluded list must be empty. - # When the excluded list is present, the included list must be empty. + # A list of video positions to be included. When the included list is present, + # the excluded list must be empty. When the excluded list is present, the + # included list must be empty. # Corresponds to the JSON property `targetedPositionTypes` # @return [Array] attr_accessor :targeted_position_types @@ -4157,11 +4028,10 @@ module Google class WatchCreativeRequest include Google::Apis::Core::Hashable - # The Pub/Sub topic to publish notifications to. - # This topic must already exist and must give permission to - # ad-exchange-buyside-reports@google.com to write to the topic. - # This should be the full resource name in - # "projects/`project_id`/topics/`topic_id`" format. + # The Pub/Sub topic to publish notifications to. This topic must already exist + # and must give permission to ad-exchange-buyside-reports@google.com to write to + # the topic. This should be the full resource name in "projects/`project_id`/ + # topics/`topic_id`" format. # Corresponds to the JSON property `topic` # @return [String] attr_accessor :topic diff --git a/generated/google/apis/adexchangebuyer2_v2beta1/service.rb b/generated/google/apis/adexchangebuyer2_v2beta1/service.rb index 5dd2eb56e..932d2e676 100644 --- a/generated/google/apis/adexchangebuyer2_v2beta1/service.rb +++ b/generated/google/apis/adexchangebuyer2_v2beta1/service.rb @@ -51,8 +51,8 @@ module Google # Creates a new client buyer. # @param [Fixnum] account_id - # Unique numerical account ID for the buyer of which the client buyer - # is a customer; the sponsor buyer to create a client for. (required) + # Unique numerical account ID for the buyer of which the client buyer is a + # customer; the sponsor buyer to create a client for. (required) # @param [Google::Apis::Adexchangebuyer2V2beta1::Client] client_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -120,19 +120,16 @@ module Google # @param [Fixnum] account_id # Unique numerical account ID of the sponsor buyer to list the clients for. # @param [Fixnum] page_size - # Requested page size. The server may return fewer clients than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer clients than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListClientsResponse.nextPageToken - # returned from the previous call to the - # accounts.clients.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListClientsResponse.nextPageToken returned from the + # previous call to the accounts.clients.list method. # @param [String] partner_client_id # Optional unique identifier (from the standpoint of an Ad Exchange sponsor - # buyer partner) of the client to return. - # If specified, at most one client will be returned in the response. + # buyer partner) of the client to return. If specified, at most one client will + # be returned in the response. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -165,8 +162,8 @@ module Google # Updates an existing client buyer. # @param [Fixnum] account_id - # Unique numerical account ID for the buyer of which the client buyer - # is a customer; the sponsor buyer to update a client for. (required) + # Unique numerical account ID for the buyer of which the client buyer is a + # customer; the sponsor buyer to update a client for. (required) # @param [Fixnum] client_account_id # Unique numerical account ID of the client to update. (required) # @param [Google::Apis::Adexchangebuyer2V2beta1::Client] client_object @@ -200,13 +197,13 @@ module Google execute_or_queue_command(command, &block) end - # Creates and sends out an email invitation to access - # an Ad Exchange client buyer account. + # Creates and sends out an email invitation to access an Ad Exchange client + # buyer account. # @param [Fixnum] account_id # Numerical account ID of the client's sponsor buyer. (required) # @param [Fixnum] client_account_id - # Numerical account ID of the client buyer that the user - # should be associated with. (required) + # Numerical account ID of the client buyer that the user should be associated + # with. (required) # @param [Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation] client_user_invitation_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -242,8 +239,8 @@ module Google # @param [Fixnum] account_id # Numerical account ID of the client's sponsor buyer. (required) # @param [Fixnum] client_account_id - # Numerical account ID of the client buyer that the user invitation - # to be retrieved is associated with. (required) + # Numerical account ID of the client buyer that the user invitation to be + # retrieved is associated with. (required) # @param [Fixnum] invitation_id # Numerical identifier of the user invitation to retrieve. (required) # @param [String] fields @@ -275,27 +272,21 @@ module Google execute_or_queue_command(command, &block) end - # Lists all the client users invitations for a client - # with a given account ID. + # Lists all the client users invitations for a client with a given account ID. # @param [Fixnum] account_id # Numerical account ID of the client's sponsor buyer. (required) # @param [String] client_account_id - # Numerical account ID of the client buyer to list invitations for. - # (required) - # You must either specify a string representation of a - # numerical account identifier or the `-` character - # to list all the invitations for all the clients - # of a given sponsor buyer. + # Numerical account ID of the client buyer to list invitations for. (required) + # You must either specify a string representation of a numerical account + # identifier or the `-` character to list all the invitations for all the + # clients of a given sponsor buyer. # @param [Fixnum] page_size - # Requested page size. Server may return fewer clients than requested. - # If unspecified, server will pick an appropriate default. + # Requested page size. Server may return fewer clients than requested. If + # unspecified, server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListClientUserInvitationsResponse.nextPageToken - # returned from the previous call to the - # clients.invitations.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListClientUserInvitationsResponse.nextPageToken returned + # from the previous call to the clients.invitations.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -330,8 +321,8 @@ module Google # @param [Fixnum] account_id # Numerical account ID of the client's sponsor buyer. (required) # @param [Fixnum] client_account_id - # Numerical account ID of the client buyer - # that the user to be retrieved is associated with. (required) + # Numerical account ID of the client buyer that the user to be retrieved is + # associated with. (required) # @param [Fixnum] user_id # Numerical identifier of the user to retrieve. (required) # @param [String] fields @@ -363,27 +354,22 @@ module Google execute_or_queue_command(command, &block) end - # Lists all the known client users for a specified - # sponsor buyer account ID. + # Lists all the known client users for a specified sponsor buyer account ID. # @param [Fixnum] account_id - # Numerical account ID of the sponsor buyer of the client to list users for. - # (required) + # Numerical account ID of the sponsor buyer of the client to list users for. ( + # required) # @param [String] client_account_id - # The account ID of the client buyer to list users for. (required) - # You must specify either a string representation of a - # numerical account identifier or the `-` character - # to list all the client users for all the clients - # of a given sponsor buyer. + # The account ID of the client buyer to list users for. (required) You must + # specify either a string representation of a numerical account identifier or + # the `-` character to list all the client users for all the clients of a given + # sponsor buyer. # @param [Fixnum] page_size - # Requested page size. The server may return fewer clients than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer clients than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListClientUsersResponse.nextPageToken - # returned from the previous call to the - # accounts.clients.users.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListClientUsersResponse.nextPageToken returned from the + # previous call to the accounts.clients.users.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -414,13 +400,12 @@ module Google execute_or_queue_command(command, &block) end - # Updates an existing client user. - # Only the user status can be changed on update. + # Updates an existing client user. Only the user status can be changed on update. # @param [Fixnum] account_id # Numerical account ID of the client's sponsor buyer. (required) # @param [Fixnum] client_account_id - # Numerical account ID of the client buyer that the user to be retrieved - # is associated with. (required) + # Numerical account ID of the client buyer that the user to be retrieved is + # associated with. (required) # @param [Fixnum] user_id # Numerical identifier of the user to retrieve. (required) # @param [Google::Apis::Adexchangebuyer2V2beta1::ClientUser] client_user_object @@ -457,10 +442,8 @@ module Google # Creates a creative. # @param [String] account_id - # The account that this creative belongs to. - # Can be used to filter the response of the - # creatives.list - # method. + # The account that this creative belongs to. Can be used to filter the response + # of the creatives.list method. # @param [Google::Apis::Adexchangebuyer2V2beta1::Creative] creative_object # @param [String] duplicate_id_mode # Indicates if multiple creatives can share an ID or not. Default is @@ -530,35 +513,26 @@ module Google # Lists creatives. # @param [String] account_id - # The account to list the creatives from. - # Specify "-" to list all creatives the current user has access to. + # The account to list the creatives from. Specify "-" to list all creatives the + # current user has access to. # @param [Fixnum] page_size - # Requested page size. The server may return fewer creatives than requested - # (due to timeout constraint) even if more are available via another call. - # If unspecified, server will pick an appropriate default. - # Acceptable values are 1 to 1000, inclusive. + # Requested page size. The server may return fewer creatives than requested (due + # to timeout constraint) even if more are available via another call. If + # unspecified, server will pick an appropriate default. Acceptable values are 1 + # to 1000, inclusive. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListCreativesResponse.next_page_token - # returned from the previous call to 'ListCreatives' method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListCreativesResponse.next_page_token returned from the + # previous call to 'ListCreatives' method. # @param [String] query - # An optional query string to filter creatives. If no filter is specified, - # all active creatives will be returned. - #

Supported queries are: - #

    - #
  • accountId=account_id_string - #
  • creativeId=creative_id_string - #
  • dealsStatus: `approved, conditionally_approved, disapproved, - # not_checked` - #
  • openAuctionStatus: `approved, conditionally_approved, disapproved, - # not_checked` - #
  • attribute: `a numeric attribute from the list of attributes` - #
  • disapprovalReason: `a reason from - # DisapprovalReason` - #
- # Example: 'accountId=12345 AND (dealsStatus:disapproved AND - # disapprovalReason:unacceptable_content) OR attribute:47' + # An optional query string to filter creatives. If no filter is specified, all + # active creatives will be returned. Supported queries are: - accountId=* + # account_id_string* - creativeId=*creative_id_string* - dealsStatus: `approved, + # conditionally_approved, disapproved, not_checked` - openAuctionStatus: ` + # approved, conditionally_approved, disapproved, not_checked` - attribute: `a + # numeric attribute from the list of attributes` - disapprovalReason: `a reason + # from DisapprovalReason` Example: 'accountId=12345 AND (dealsStatus:disapproved + # AND disapprovalReason:unacceptable_content) OR attribute:47' # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -594,8 +568,8 @@ module Google # @param [String] account_id # The account of the creative to stop notifications for. # @param [String] creative_id - # The creative ID of the creative to stop notifications for. - # Specify "-" to specify stopping account level notifications. + # The creative ID of the creative to stop notifications for. Specify "-" to + # specify stopping account level notifications. # @param [Google::Apis::Adexchangebuyer2V2beta1::StopWatchingCreativeRequest] stop_watching_creative_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -629,15 +603,11 @@ module Google # Updates a creative. # @param [String] account_id - # The account that this creative belongs to. - # Can be used to filter the response of the - # creatives.list - # method. + # The account that this creative belongs to. Can be used to filter the response + # of the creatives.list method. # @param [String] creative_id - # The buyer-defined creative ID of this creative. - # Can be used to filter the response of the - # creatives.list - # method. + # The buyer-defined creative ID of this creative. Can be used to filter the + # response of the creatives.list method. # @param [Google::Apis::Adexchangebuyer2V2beta1::Creative] creative_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -669,15 +639,14 @@ module Google execute_or_queue_command(command, &block) end - # Watches a creative. Will result in push notifications being sent to the - # topic when the creative changes status. + # Watches a creative. Will result in push notifications being sent to the topic + # when the creative changes status. # @param [String] account_id # The account of the creative to watch. # @param [String] creative_id - # The creative ID to watch for status changes. - # Specify "-" to watch all creatives under the above account. - # If both creative-level and account-level notifications are - # sent, only a single notification will be sent to the + # The creative ID to watch for status changes. Specify "-" to watch all + # creatives under the above account. If both creative-level and account-level + # notifications are sent, only a single notification will be sent to the # creative-level notification topic. # @param [Google::Apis::Adexchangebuyer2V2beta1::WatchCreativeRequest] watch_creative_request_object # @param [String] fields @@ -748,33 +717,25 @@ module Google # List all creative-deal associations. # @param [String] account_id - # The account to list the associations from. - # Specify "-" to list all creatives the current user has access to. + # The account to list the associations from. Specify "-" to list all creatives + # the current user has access to. # @param [String] creative_id - # The creative ID to list the associations from. - # Specify "-" to list all creatives under the above account. + # The creative ID to list the associations from. Specify "-" to list all + # creatives under the above account. # @param [Fixnum] page_size - # Requested page size. Server may return fewer associations than requested. - # If unspecified, server will pick an appropriate default. + # Requested page size. Server may return fewer associations than requested. If + # unspecified, server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListDealAssociationsResponse.next_page_token - # returned from the previous call to 'ListDealAssociations' method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListDealAssociationsResponse.next_page_token returned + # from the previous call to 'ListDealAssociations' method. # @param [String] query # An optional query string to filter deal associations. If no filter is - # specified, all associations will be returned. - # Supported queries are: - #
    - #
  • accountId=account_id_string - #
  • creativeId=creative_id_string - #
  • dealsId=deals_id_string - #
  • dealsStatus:`approved, conditionally_approved, disapproved, - # not_checked` - #
  • openAuctionStatus:`approved, conditionally_approved, disapproved, - # not_checked` - #
- # Example: 'dealsId=12345 AND dealsStatus:disapproved' + # specified, all associations will be returned. Supported queries are: - + # accountId=*account_id_string* - creativeId=*creative_id_string* - dealsId=* + # deals_id_string* - dealsStatus:`approved, conditionally_approved, disapproved, + # not_checked` - openAuctionStatus:`approved, conditionally_approved, + # disapproved, not_checked` Example: 'dealsId=12345 AND dealsStatus:disapproved' # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -842,21 +803,20 @@ module Google execute_or_queue_command(command, &block) end - # List finalized proposals, regardless if a proposal is being renegotiated. - # A filter expression (PQL query) may be specified to filter the results. - # The notes will not be returned. + # List finalized proposals, regardless if a proposal is being renegotiated. A + # filter expression (PQL query) may be specified to filter the results. The + # notes will not be returned. # @param [String] account_id # Account ID of the buyer. # @param [String] filter - # An optional PQL filter query used to query for proposals. - # Nested repeated fields, such as proposal.deals.targetingCriterion, - # cannot be filtered. + # An optional PQL filter query used to query for proposals. Nested repeated + # fields, such as proposal.deals.targetingCriterion, cannot be filtered. # @param [String] filter_syntax - # Syntax the filter is written in. Current implementation defaults to PQL - # but in the future it will be LIST_FILTER. + # Syntax the filter is written in. Current implementation defaults to PQL but in + # the future it will be LIST_FILTER. # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token # The page token as returned from ListProposalsResponse. # @param [String] fields @@ -923,19 +883,18 @@ module Google execute_or_queue_command(command, &block) end - # List all products visible to the buyer (optionally filtered by the - # specified PQL query). + # List all products visible to the buyer (optionally filtered by the specified + # PQL query). # @param [String] account_id # Account ID of the buyer. # @param [String] filter - # An optional PQL query used to query for products. See - # https://developers.google.com/ad-manager/docs/pqlreference - # for documentation about PQL and examples. - # Nested repeated fields, such as product.targetingCriterion.inclusions, - # cannot be filtered. + # An optional PQL query used to query for products. See https://developers. + # google.com/ad-manager/docs/pqlreference for documentation about PQL and + # examples. Nested repeated fields, such as product.targetingCriterion. + # inclusions, cannot be filtered. # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token # The page token as returned from ListProductsResponse. # @param [String] fields @@ -968,10 +927,10 @@ module Google execute_or_queue_command(command, &block) end - # Mark the proposal as accepted at the given revision number. If the number - # does not match the server's revision number an `ABORTED` error message will - # be returned. This call updates the proposal_state from `PROPOSED` to - # `BUYER_ACCEPTED`, or from `SELLER_ACCEPTED` to `FINALIZED`. + # Mark the proposal as accepted at the given revision number. If the number does + # not match the server's revision number an `ABORTED` error message will be + # returned. This call updates the proposal_state from `PROPOSED` to ` + # BUYER_ACCEPTED`, or from `SELLER_ACCEPTED` to `FINALIZED`. # @param [String] account_id # Account ID of the buyer. # @param [String] proposal_id @@ -1007,10 +966,9 @@ module Google execute_or_queue_command(command, &block) end - # Create a new note and attach it to the proposal. The note is assigned - # a unique ID by the server. - # The proposal revision number will not increase when associated with a - # new note. + # Create a new note and attach it to the proposal. The note is assigned a unique + # ID by the server. The proposal revision number will not increase when + # associated with a new note. # @param [String] account_id # Account ID of the buyer. # @param [String] proposal_id @@ -1047,8 +1005,8 @@ module Google end # Cancel an ongoing negotiation on a proposal. This does not cancel or end - # serving for the deals if the proposal has been finalized, but only cancels - # a negotiation unilaterally. + # serving for the deals if the proposal has been finalized, but only cancels a + # negotiation unilaterally. # @param [String] account_id # Account ID of the buyer. # @param [String] proposal_id @@ -1084,12 +1042,12 @@ module Google execute_or_queue_command(command, &block) end - # Update the given proposal to indicate that setup has been completed. - # This method is called by the buyer when the line items have been created - # on their end for a finalized proposal and all the required creatives - # have been uploaded using the creatives API. This call updates the - # `is_setup_completed` bit on the proposal and also notifies the seller. - # The server will advance the revision number of the most recent proposal. + # Update the given proposal to indicate that setup has been completed. This + # method is called by the buyer when the line items have been created on their + # end for a finalized proposal and all the required creatives have been uploaded + # using the creatives API. This call updates the `is_setup_completed` bit on the + # proposal and also notifies the seller. The server will advance the revision + # number of the most recent proposal. # @param [String] account_id # Account ID of the buyer. # @param [String] proposal_id @@ -1125,8 +1083,8 @@ module Google execute_or_queue_command(command, &block) end - # Create the given proposal. Each created proposal and any deals it contains - # are assigned a unique ID by the server. + # Create the given proposal. Each created proposal and any deals it contains are + # assigned a unique ID by the server. # @param [String] account_id # Account ID of the buyer. # @param [Google::Apis::Adexchangebuyer2V2beta1::Proposal] proposal_object @@ -1159,8 +1117,7 @@ module Google execute_or_queue_command(command, &block) end - # Gets a proposal given its ID. The proposal is returned at its head - # revision. + # Gets a proposal given its ID. The proposal is returned at its head revision. # @param [String] account_id # Account ID of the buyer. # @param [String] proposal_id @@ -1193,24 +1150,23 @@ module Google execute_or_queue_command(command, &block) end - # List proposals. A filter expression (PQL query) may be specified to - # filter the results. To retrieve all finalized proposals, regardless if a - # proposal is being renegotiated, see the FinalizedProposals resource. - # Note that Bidder/ChildSeat relationships differ from the usual behavior. - # A Bidder account can only see its child seats' proposals by specifying - # the ChildSeat's accountId in the request path. + # List proposals. A filter expression (PQL query) may be specified to filter the + # results. To retrieve all finalized proposals, regardless if a proposal is + # being renegotiated, see the FinalizedProposals resource. Note that Bidder/ + # ChildSeat relationships differ from the usual behavior. A Bidder account can + # only see its child seats' proposals by specifying the ChildSeat's accountId in + # the request path. # @param [String] account_id # Account ID of the buyer. # @param [String] filter - # An optional PQL filter query used to query for proposals. - # Nested repeated fields, such as proposal.deals.targetingCriterion, - # cannot be filtered. + # An optional PQL filter query used to query for proposals. Nested repeated + # fields, such as proposal.deals.targetingCriterion, cannot be filtered. # @param [String] filter_syntax - # Syntax the filter is written in. Current implementation defaults to PQL - # but in the future it will be LIST_FILTER. + # Syntax the filter is written in. Current implementation defaults to PQL but in + # the future it will be LIST_FILTER. # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token # The page token as returned from ListProposalsResponse. # @param [String] fields @@ -1244,13 +1200,11 @@ module Google execute_or_queue_command(command, &block) end - # Update the given proposal to pause serving. - # This method will set the - # `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all - # deals in the proposal. - # It is a no-op to pause an already-paused proposal. - # It is an error to call PauseProposal for a proposal that is not - # finalized or renegotiating. + # Update the given proposal to pause serving. This method will set the ` + # DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all + # deals in the proposal. It is a no-op to pause an already-paused proposal. It + # is an error to call PauseProposal for a proposal that is not finalized or + # renegotiating. # @param [String] account_id # Account ID of the buyer. # @param [String] proposal_id @@ -1286,15 +1240,12 @@ module Google execute_or_queue_command(command, &block) end - # Update the given proposal to resume serving. - # This method will set the - # `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all - # deals in the proposal. - # Note that if the `has_seller_paused` bit is also set, serving will not - # resume until the seller also resumes. - # It is a no-op to resume an already-running proposal. - # It is an error to call ResumeProposal for a proposal that is not - # finalized or renegotiating. + # Update the given proposal to resume serving. This method will set the ` + # DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all + # deals in the proposal. Note that if the `has_seller_paused` bit is also set, + # serving will not resume until the seller also resumes. It is a no-op to resume + # an already-running proposal. It is an error to call ResumeProposal for a + # proposal that is not finalized or renegotiating. # @param [String] account_id # Account ID of the buyer. # @param [String] proposal_id @@ -1330,18 +1281,15 @@ module Google execute_or_queue_command(command, &block) end - # Update the given proposal at the client known revision number. If the - # server revision has advanced since the passed-in - # `proposal.proposal_revision`, an `ABORTED` error message will be returned. - # Only the buyer-modifiable fields of the proposal will be updated. - # Note that the deals in the proposal will be updated to match the passed-in - # copy. - # If a passed-in deal does not have a `deal_id`, the server will assign a new - # unique ID and create the deal. - # If passed-in deal has a `deal_id`, it will be updated to match the - # passed-in copy. - # Any existing deals not present in the passed-in proposal will be deleted. - # It is an error to pass in a deal with a `deal_id` not present at head. + # Update the given proposal at the client known revision number. If the server + # revision has advanced since the passed-in `proposal.proposal_revision`, an ` + # ABORTED` error message will be returned. Only the buyer-modifiable fields of + # the proposal will be updated. Note that the deals in the proposal will be + # updated to match the passed-in copy. If a passed-in deal does not have a ` + # deal_id`, the server will assign a new unique ID and create the deal. If + # passed-in deal has a `deal_id`, it will be updated to match the passed-in copy. + # Any existing deals not present in the passed-in proposal will be deleted. It + # is an error to pass in a deal with a `deal_id` not present at head. # @param [String] account_id # Account ID of the buyer. # @param [String] proposal_id @@ -1448,18 +1396,16 @@ module Google # Creates the specified filter set for the account with the given account ID. # @param [String] owner_name - # Name of the owner (bidder or account) of the filter set to be created. - # For example: - # - For a bidder-level filter set for bidder 123: `bidders/123` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456` + # Name of the owner (bidder or account) of the filter set to be created. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123` - For + # an account-level filter set for the buyer account representing bidder 123: ` + # bidders/123/accounts/123` - For an account-level filter set for the child seat + # buyer account 456 whose bidder is 123: `bidders/123/accounts/456` # @param [Google::Apis::Adexchangebuyer2V2beta1::FilterSet] filter_set_object # @param [Boolean] is_transient - # Whether the filter set is transient, or should be persisted indefinitely. - # By default, filter sets are not transient. - # If transient, it will be available for at least 1 hour after creation. + # Whether the filter set is transient, or should be persisted indefinitely. By + # default, filter sets are not transient. If transient, it will be available for + # at least 1 hour after creation. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1490,17 +1436,13 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the requested filter set from the account with the given account - # ID. + # Deletes the requested filter set from the account with the given account ID. # @param [String] name - # Full name of the resource to delete. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Full name of the resource to delete. For example: - For a bidder-level filter + # set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter + # set for the buyer account representing bidder 123: `bidders/123/accounts/123/ + # filterSets/abc` - For an account-level filter set for the child seat buyer + # account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1528,17 +1470,14 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the requested filter set for the account with the given account - # ID. + # Retrieves the requested filter set for the account with the given account ID. # @param [String] name - # Full name of the resource being requested. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Full name of the resource being requested. For example: - For a bidder-level + # filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level + # filter set for the buyer account representing bidder 123: `bidders/123/ + # accounts/123/filterSets/abc` - For an account-level filter set for the child + # seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/ + # filterSets/abc` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1568,23 +1507,18 @@ module Google # Lists all filter sets for the account with the given account ID. # @param [String] owner_name - # Name of the owner (bidder or account) of the filter sets to be listed. - # For example: - # - For a bidder-level filter set for bidder 123: `bidders/123` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456` + # Name of the owner (bidder or account) of the filter sets to be listed. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123` - For + # an account-level filter set for the buyer account representing bidder 123: ` + # bidders/123/accounts/123` - For an account-level filter set for the child seat + # buyer account 456 whose bidder is 123: `bidders/123/accounts/456` # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListFilterSetsResponse.nextPageToken - # returned from the previous call to the - # accounts.filterSets.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListFilterSetsResponse.nextPageToken returned from the + # previous call to the accounts.filterSets.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1616,23 +1550,19 @@ module Google # Lists all metrics that are measured in terms of number of bids. # @param [String] filter_set_name - # Name of the filter set that should be applied to the requested metrics. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Name of the filter set that should be applied to the requested metrics. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123/ + # filterSets/abc` - For an account-level filter set for the buyer account + # representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + # account-level filter set for the child seat buyer account 456 whose bidder is + # 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListBidMetricsResponse.nextPageToken - # returned from the previous call to the bidMetrics.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListBidMetricsResponse.nextPageToken returned from the + # previous call to the bidMetrics.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1665,23 +1595,19 @@ module Google # List all errors that occurred in bid responses, with the number of bid # responses affected for each reason. # @param [String] filter_set_name - # Name of the filter set that should be applied to the requested metrics. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Name of the filter set that should be applied to the requested metrics. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123/ + # filterSets/abc` - For an account-level filter set for the buyer account + # representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + # account-level filter set for the child seat buyer account 456 whose bidder is + # 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListBidResponseErrorsResponse.nextPageToken - # returned from the previous call to the bidResponseErrors.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListBidResponseErrorsResponse.nextPageToken returned from + # the previous call to the bidResponseErrors.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1711,26 +1637,22 @@ module Google execute_or_queue_command(command, &block) end - # List all reasons for which bid responses were considered to have no - # applicable bids, with the number of bid responses affected for each reason. + # List all reasons for which bid responses were considered to have no applicable + # bids, with the number of bid responses affected for each reason. # @param [String] filter_set_name - # Name of the filter set that should be applied to the requested metrics. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Name of the filter set that should be applied to the requested metrics. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123/ + # filterSets/abc` - For an account-level filter set for the buyer account + # representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + # account-level filter set for the child seat buyer account 456 whose bidder is + # 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListBidResponsesWithoutBidsResponse.nextPageToken - # returned from the previous call to the bidResponsesWithoutBids.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken + # returned from the previous call to the bidResponsesWithoutBids.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1760,26 +1682,22 @@ module Google execute_or_queue_command(command, &block) end - # List all reasons that caused a bid request not to be sent for an - # impression, with the number of bid requests not sent for each reason. + # List all reasons that caused a bid request not to be sent for an impression, + # with the number of bid requests not sent for each reason. # @param [String] filter_set_name - # Name of the filter set that should be applied to the requested metrics. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Name of the filter set that should be applied to the requested metrics. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123/ + # filterSets/abc` - For an account-level filter set for the buyer account + # representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + # account-level filter set for the child seat buyer account 456 whose bidder is + # 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListFilteredBidRequestsResponse.nextPageToken - # returned from the previous call to the filteredBidRequests.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListFilteredBidRequestsResponse.nextPageToken returned + # from the previous call to the filteredBidRequests.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1812,23 +1730,19 @@ module Google # List all reasons for which bids were filtered, with the number of bids # filtered for each reason. # @param [String] filter_set_name - # Name of the filter set that should be applied to the requested metrics. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Name of the filter set that should be applied to the requested metrics. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123/ + # filterSets/abc` - For an account-level filter set for the buyer account + # representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + # account-level filter set for the child seat buyer account 456 whose bidder is + # 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListFilteredBidsResponse.nextPageToken - # returned from the previous call to the filteredBids.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListFilteredBidsResponse.nextPageToken returned from the + # previous call to the filteredBids.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1861,29 +1775,24 @@ module Google # List all creatives associated with a specific reason for which bids were # filtered, with the number of bids filtered for each creative. # @param [String] filter_set_name - # Name of the filter set that should be applied to the requested metrics. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Name of the filter set that should be applied to the requested metrics. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123/ + # filterSets/abc` - For an account-level filter set for the buyer account + # representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + # account-level filter set for the child seat buyer account 456 whose bidder is + # 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] creative_status_id - # The ID of the creative status for which to retrieve a breakdown by - # creative. - # See - # [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/ - # downloads/creative-status-codes). + # The ID of the creative status for which to retrieve a breakdown by creative. + # See [creative-status-codes](https://developers.google.com/authorized-buyers/ + # rtb/downloads/creative-status-codes). # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListCreativeStatusBreakdownByCreativeResponse.nextPageToken - # returned from the previous call to the filteredBids.creatives.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListCreativeStatusBreakdownByCreativeResponse. + # nextPageToken returned from the previous call to the filteredBids.creatives. + # list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1917,29 +1826,24 @@ module Google # List all details associated with a specific reason for which bids were # filtered, with the number of bids filtered for each detail. # @param [String] filter_set_name - # Name of the filter set that should be applied to the requested metrics. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Name of the filter set that should be applied to the requested metrics. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123/ + # filterSets/abc` - For an account-level filter set for the buyer account + # representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + # account-level filter set for the child seat buyer account 456 whose bidder is + # 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] creative_status_id - # The ID of the creative status for which to retrieve a breakdown by detail. - # See + # The ID of the creative status for which to retrieve a breakdown by detail. See # [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/ - # downloads/creative-status-codes). - # Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87. + # downloads/creative-status-codes). Details are only available for statuses 10, + # 14, 15, 17, 18, 19, 86, and 87. # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListCreativeStatusBreakdownByDetailResponse.nextPageToken - # returned from the previous call to the filteredBids.details.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken + # returned from the previous call to the filteredBids.details.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1972,23 +1876,19 @@ module Google # Lists all metrics that are measured in terms of number of impressions. # @param [String] filter_set_name - # Name of the filter set that should be applied to the requested metrics. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Name of the filter set that should be applied to the requested metrics. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123/ + # filterSets/abc` - For an account-level filter set for the buyer account + # representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + # account-level filter set for the child seat buyer account 456 whose bidder is + # 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListImpressionMetricsResponse.nextPageToken - # returned from the previous call to the impressionMetrics.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListImpressionMetricsResponse.nextPageToken returned from + # the previous call to the impressionMetrics.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2018,26 +1918,22 @@ module Google execute_or_queue_command(command, &block) end - # List all reasons for which bids lost in the auction, with the number of - # bids that lost for each reason. + # List all reasons for which bids lost in the auction, with the number of bids + # that lost for each reason. # @param [String] filter_set_name - # Name of the filter set that should be applied to the requested metrics. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Name of the filter set that should be applied to the requested metrics. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123/ + # filterSets/abc` - For an account-level filter set for the buyer account + # representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + # account-level filter set for the child seat buyer account 456 whose bidder is + # 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListLosingBidsResponse.nextPageToken - # returned from the previous call to the losingBids.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListLosingBidsResponse.nextPageToken returned from the + # previous call to the losingBids.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2067,26 +1963,22 @@ module Google execute_or_queue_command(command, &block) end - # List all reasons for which winning bids were not billable, with the number - # of bids not billed for each reason. + # List all reasons for which winning bids were not billable, with the number of + # bids not billed for each reason. # @param [String] filter_set_name - # Name of the filter set that should be applied to the requested metrics. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Name of the filter set that should be applied to the requested metrics. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123/ + # filterSets/abc` - For an account-level filter set for the buyer account + # representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + # account-level filter set for the child seat buyer account 456 whose bidder is + # 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListNonBillableWinningBidsResponse.nextPageToken - # returned from the previous call to the nonBillableWinningBids.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned + # from the previous call to the nonBillableWinningBids.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2118,18 +2010,16 @@ module Google # Creates the specified filter set for the account with the given account ID. # @param [String] owner_name - # Name of the owner (bidder or account) of the filter set to be created. - # For example: - # - For a bidder-level filter set for bidder 123: `bidders/123` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456` + # Name of the owner (bidder or account) of the filter set to be created. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123` - For + # an account-level filter set for the buyer account representing bidder 123: ` + # bidders/123/accounts/123` - For an account-level filter set for the child seat + # buyer account 456 whose bidder is 123: `bidders/123/accounts/456` # @param [Google::Apis::Adexchangebuyer2V2beta1::FilterSet] filter_set_object # @param [Boolean] is_transient - # Whether the filter set is transient, or should be persisted indefinitely. - # By default, filter sets are not transient. - # If transient, it will be available for at least 1 hour after creation. + # Whether the filter set is transient, or should be persisted indefinitely. By + # default, filter sets are not transient. If transient, it will be available for + # at least 1 hour after creation. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2160,17 +2050,13 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the requested filter set from the account with the given account - # ID. + # Deletes the requested filter set from the account with the given account ID. # @param [String] name - # Full name of the resource to delete. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Full name of the resource to delete. For example: - For a bidder-level filter + # set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter + # set for the buyer account representing bidder 123: `bidders/123/accounts/123/ + # filterSets/abc` - For an account-level filter set for the child seat buyer + # account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2198,17 +2084,14 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the requested filter set for the account with the given account - # ID. + # Retrieves the requested filter set for the account with the given account ID. # @param [String] name - # Full name of the resource being requested. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Full name of the resource being requested. For example: - For a bidder-level + # filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level + # filter set for the buyer account representing bidder 123: `bidders/123/ + # accounts/123/filterSets/abc` - For an account-level filter set for the child + # seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/ + # filterSets/abc` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2238,23 +2121,18 @@ module Google # Lists all filter sets for the account with the given account ID. # @param [String] owner_name - # Name of the owner (bidder or account) of the filter sets to be listed. - # For example: - # - For a bidder-level filter set for bidder 123: `bidders/123` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456` + # Name of the owner (bidder or account) of the filter sets to be listed. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123` - For + # an account-level filter set for the buyer account representing bidder 123: ` + # bidders/123/accounts/123` - For an account-level filter set for the child seat + # buyer account 456 whose bidder is 123: `bidders/123/accounts/456` # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListFilterSetsResponse.nextPageToken - # returned from the previous call to the - # accounts.filterSets.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListFilterSetsResponse.nextPageToken returned from the + # previous call to the accounts.filterSets.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2286,23 +2164,19 @@ module Google # Lists all metrics that are measured in terms of number of bids. # @param [String] filter_set_name - # Name of the filter set that should be applied to the requested metrics. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Name of the filter set that should be applied to the requested metrics. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123/ + # filterSets/abc` - For an account-level filter set for the buyer account + # representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + # account-level filter set for the child seat buyer account 456 whose bidder is + # 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListBidMetricsResponse.nextPageToken - # returned from the previous call to the bidMetrics.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListBidMetricsResponse.nextPageToken returned from the + # previous call to the bidMetrics.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2335,23 +2209,19 @@ module Google # List all errors that occurred in bid responses, with the number of bid # responses affected for each reason. # @param [String] filter_set_name - # Name of the filter set that should be applied to the requested metrics. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Name of the filter set that should be applied to the requested metrics. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123/ + # filterSets/abc` - For an account-level filter set for the buyer account + # representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + # account-level filter set for the child seat buyer account 456 whose bidder is + # 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListBidResponseErrorsResponse.nextPageToken - # returned from the previous call to the bidResponseErrors.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListBidResponseErrorsResponse.nextPageToken returned from + # the previous call to the bidResponseErrors.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2381,26 +2251,22 @@ module Google execute_or_queue_command(command, &block) end - # List all reasons for which bid responses were considered to have no - # applicable bids, with the number of bid responses affected for each reason. + # List all reasons for which bid responses were considered to have no applicable + # bids, with the number of bid responses affected for each reason. # @param [String] filter_set_name - # Name of the filter set that should be applied to the requested metrics. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Name of the filter set that should be applied to the requested metrics. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123/ + # filterSets/abc` - For an account-level filter set for the buyer account + # representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + # account-level filter set for the child seat buyer account 456 whose bidder is + # 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListBidResponsesWithoutBidsResponse.nextPageToken - # returned from the previous call to the bidResponsesWithoutBids.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken + # returned from the previous call to the bidResponsesWithoutBids.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2430,26 +2296,22 @@ module Google execute_or_queue_command(command, &block) end - # List all reasons that caused a bid request not to be sent for an - # impression, with the number of bid requests not sent for each reason. + # List all reasons that caused a bid request not to be sent for an impression, + # with the number of bid requests not sent for each reason. # @param [String] filter_set_name - # Name of the filter set that should be applied to the requested metrics. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Name of the filter set that should be applied to the requested metrics. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123/ + # filterSets/abc` - For an account-level filter set for the buyer account + # representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + # account-level filter set for the child seat buyer account 456 whose bidder is + # 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListFilteredBidRequestsResponse.nextPageToken - # returned from the previous call to the filteredBidRequests.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListFilteredBidRequestsResponse.nextPageToken returned + # from the previous call to the filteredBidRequests.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2482,23 +2344,19 @@ module Google # List all reasons for which bids were filtered, with the number of bids # filtered for each reason. # @param [String] filter_set_name - # Name of the filter set that should be applied to the requested metrics. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Name of the filter set that should be applied to the requested metrics. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123/ + # filterSets/abc` - For an account-level filter set for the buyer account + # representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + # account-level filter set for the child seat buyer account 456 whose bidder is + # 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListFilteredBidsResponse.nextPageToken - # returned from the previous call to the filteredBids.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListFilteredBidsResponse.nextPageToken returned from the + # previous call to the filteredBids.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2531,29 +2389,24 @@ module Google # List all creatives associated with a specific reason for which bids were # filtered, with the number of bids filtered for each creative. # @param [String] filter_set_name - # Name of the filter set that should be applied to the requested metrics. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Name of the filter set that should be applied to the requested metrics. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123/ + # filterSets/abc` - For an account-level filter set for the buyer account + # representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + # account-level filter set for the child seat buyer account 456 whose bidder is + # 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] creative_status_id - # The ID of the creative status for which to retrieve a breakdown by - # creative. - # See - # [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/ - # downloads/creative-status-codes). + # The ID of the creative status for which to retrieve a breakdown by creative. + # See [creative-status-codes](https://developers.google.com/authorized-buyers/ + # rtb/downloads/creative-status-codes). # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListCreativeStatusBreakdownByCreativeResponse.nextPageToken - # returned from the previous call to the filteredBids.creatives.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListCreativeStatusBreakdownByCreativeResponse. + # nextPageToken returned from the previous call to the filteredBids.creatives. + # list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2587,29 +2440,24 @@ module Google # List all details associated with a specific reason for which bids were # filtered, with the number of bids filtered for each detail. # @param [String] filter_set_name - # Name of the filter set that should be applied to the requested metrics. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Name of the filter set that should be applied to the requested metrics. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123/ + # filterSets/abc` - For an account-level filter set for the buyer account + # representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + # account-level filter set for the child seat buyer account 456 whose bidder is + # 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] creative_status_id - # The ID of the creative status for which to retrieve a breakdown by detail. - # See + # The ID of the creative status for which to retrieve a breakdown by detail. See # [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/ - # downloads/creative-status-codes). - # Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87. + # downloads/creative-status-codes). Details are only available for statuses 10, + # 14, 15, 17, 18, 19, 86, and 87. # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListCreativeStatusBreakdownByDetailResponse.nextPageToken - # returned from the previous call to the filteredBids.details.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken + # returned from the previous call to the filteredBids.details.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2642,23 +2490,19 @@ module Google # Lists all metrics that are measured in terms of number of impressions. # @param [String] filter_set_name - # Name of the filter set that should be applied to the requested metrics. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Name of the filter set that should be applied to the requested metrics. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123/ + # filterSets/abc` - For an account-level filter set for the buyer account + # representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + # account-level filter set for the child seat buyer account 456 whose bidder is + # 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListImpressionMetricsResponse.nextPageToken - # returned from the previous call to the impressionMetrics.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListImpressionMetricsResponse.nextPageToken returned from + # the previous call to the impressionMetrics.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2688,26 +2532,22 @@ module Google execute_or_queue_command(command, &block) end - # List all reasons for which bids lost in the auction, with the number of - # bids that lost for each reason. + # List all reasons for which bids lost in the auction, with the number of bids + # that lost for each reason. # @param [String] filter_set_name - # Name of the filter set that should be applied to the requested metrics. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Name of the filter set that should be applied to the requested metrics. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123/ + # filterSets/abc` - For an account-level filter set for the buyer account + # representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + # account-level filter set for the child seat buyer account 456 whose bidder is + # 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListLosingBidsResponse.nextPageToken - # returned from the previous call to the losingBids.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListLosingBidsResponse.nextPageToken returned from the + # previous call to the losingBids.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2737,26 +2577,22 @@ module Google execute_or_queue_command(command, &block) end - # List all reasons for which winning bids were not billable, with the number - # of bids not billed for each reason. + # List all reasons for which winning bids were not billable, with the number of + # bids not billed for each reason. # @param [String] filter_set_name - # Name of the filter set that should be applied to the requested metrics. - # For example: - # - For a bidder-level filter set for bidder 123: - # `bidders/123/filterSets/abc` - # - For an account-level filter set for the buyer account representing bidder - # 123: `bidders/123/accounts/123/filterSets/abc` - # - For an account-level filter set for the child seat buyer account 456 - # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # Name of the filter set that should be applied to the requested metrics. For + # example: - For a bidder-level filter set for bidder 123: `bidders/123/ + # filterSets/abc` - For an account-level filter set for the buyer account + # representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an + # account-level filter set for the child seat buyer account 456 whose bidder is + # 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size - # Requested page size. The server may return fewer results than requested. - # If unspecified, the server will pick an appropriate default. + # Requested page size. The server may return fewer results than requested. If + # unspecified, the server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListNonBillableWinningBidsResponse.nextPageToken - # returned from the previous call to the nonBillableWinningBids.list - # method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned + # from the previous call to the nonBillableWinningBids.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/adexperiencereport_v1.rb b/generated/google/apis/adexperiencereport_v1.rb index 64646d211..cd5e93abd 100644 --- a/generated/google/apis/adexperiencereport_v1.rb +++ b/generated/google/apis/adexperiencereport_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/ad-experience-report/ module AdexperiencereportV1 VERSION = 'V1' - REVISION = '20200210' + REVISION = '20200803' end end end diff --git a/generated/google/apis/adexperiencereport_v1/classes.rb b/generated/google/apis/adexperiencereport_v1/classes.rb index 3eeaccf3a..cf2df583e 100644 --- a/generated/google/apis/adexperiencereport_v1/classes.rb +++ b/generated/google/apis/adexperiencereport_v1/classes.rb @@ -31,19 +31,15 @@ module Google # @return [String] attr_accessor :better_ads_status - # The time at which - # [enforcement](https://support.google.com/webtools/answer/7308033) against - # the site began or will begin on this platform. - # Not set when the - # filter_status - # is OFF. + # The time at which [enforcement](https://support.google.com/webtools/answer/ + # 7308033) against the site began or will begin on this platform. Not set when + # the filter_status is OFF. # Corresponds to the JSON property `enforcementTime` # @return [String] attr_accessor :enforcement_time - # The site's [enforcement - # status](https://support.google.com/webtools/answer/7308033) on this - # platform. + # The site's [enforcement status](https://support.google.com/webtools/answer/ + # 7308033) on this platform. # Corresponds to the JSON property `filterStatus` # @return [String] attr_accessor :filter_status @@ -53,19 +49,16 @@ module Google # @return [String] attr_accessor :last_change_time - # The site's regions on this platform. - # No longer populated, because there is no longer any semantic difference - # between sites in different regions. + # The site's regions on this platform. No longer populated, because there is no + # longer any semantic difference between sites in different regions. # Corresponds to the JSON property `region` # @return [Array] attr_accessor :region - # A link to the full Ad Experience Report for the site on this platform.. - # Not set in - # ViolatingSitesResponse. - # Note that you must complete the [Search Console verification - # process](https://support.google.com/webmasters/answer/9008080) for the site - # before you can access the full report. + # A link to the full Ad Experience Report for the site on this platform.. Not + # set in ViolatingSitesResponse. Note that you must complete the [Search Console + # verification process](https://support.google.com/webmasters/answer/9008080) + # for the site before you can access the full report. # Corresponds to the JSON property `reportUrl` # @return [String] attr_accessor :report_url diff --git a/generated/google/apis/adexperiencereport_v1/service.rb b/generated/google/apis/adexperiencereport_v1/service.rb index 44325f1e5..862e150e7 100644 --- a/generated/google/apis/adexperiencereport_v1/service.rb +++ b/generated/google/apis/adexperiencereport_v1/service.rb @@ -50,9 +50,8 @@ module Google # Gets a site's Ad Experience Report summary. # @param [String] name - # Required. The name of the site whose summary to get, e.g. - # `sites/http%3A%2F%2Fwww.google.com%2F`. - # Format: `sites/`site`` + # Required. The name of the site whose summary to get, e.g. `sites/http%3A%2F% + # 2Fwww.google.com%2F`. Format: `sites/`site`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/admob_v1.rb b/generated/google/apis/admob_v1.rb index 5c02e9c61..fc3cf41f0 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 = '20200722' + REVISION = '20200801' end end end diff --git a/generated/google/apis/admob_v1/classes.rb b/generated/google/apis/admob_v1/classes.rb index 9a9f77638..80af81785 100644 --- a/generated/google/apis/admob_v1/classes.rb +++ b/generated/google/apis/admob_v1/classes.rb @@ -24,30 +24,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 @@ -70,24 +69,24 @@ 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`. # Corresponds to the JSON property `endDate` # @return [Google::Apis::AdmobV1::Date] attr_accessor :end_date # 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::AdmobV1::Date] attr_accessor :start_date @@ -107,38 +106,19 @@ module Google class GenerateMediationReportRequest include Google::Apis::Core::Hashable - # The specification for generating an AdMob Mediation report. - # For example, the specification to get observed ECPM sliced by ad source and - # app for the 'US' and 'CN' countries can look like the following example: - # ` - # "date_range": ` - # "start_date": `"year": 2018, "month": 9, "day": 1`, - # "end_date": `"year": 2018, "month": 9, "day": 30` - # `, - # "dimensions": ["AD_SOURCE", "APP", "COUNTRY"], - # "metrics": ["OBSERVED_ECPM"], - # "dimension_filters": [ - # ` - # "dimension": "COUNTRY", - # "matches_any": `"values": [`"value": "US", "value": "CN"`]` - # ` - # ], - # "sort_conditions": [ - # `"dimension":"APP", order: "ASCENDING"` - # ], - # "localization_settings": ` - # "currency_code": "USD", - # "language_code": "en-US" - # ` - # ` - # For a better understanding, you can treat the preceding specification like - # the following pseudo SQL: - # SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM - # FROM MEDIATION_REPORT - # WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30' - # AND COUNTRY IN ('US', 'CN') - # GROUP BY AD_SOURCE, APP, COUNTRY - # ORDER BY APP ASC; + # The specification for generating an AdMob Mediation report. For example, the + # specification to get observed ECPM sliced by ad source and app for the 'US' + # and 'CN' countries can look like the following example: ` "date_range": ` " + # start_date": `"year": 2018, "month": 9, "day": 1`, "end_date": `"year": 2018, " + # month": 9, "day": 30` `, "dimensions": ["AD_SOURCE", "APP", "COUNTRY"], " + # metrics": ["OBSERVED_ECPM"], "dimension_filters": [ ` "dimension": "COUNTRY", " + # matches_any": `"values": [`"value": "US", "value": "CN"`]` ` ], " + # sort_conditions": [ `"dimension":"APP", order: "ASCENDING"` ], " + # localization_settings": ` "currency_code": "USD", "language_code": "en-US" ` ` + # For a better understanding, you can treat the preceding specification like the + # following pseudo SQL: SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM FROM + # MEDIATION_REPORT WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30' AND + # COUNTRY IN ('US', 'CN') GROUP BY AD_SOURCE, APP, COUNTRY ORDER BY APP ASC; # Corresponds to the JSON property `reportSpec` # @return [Google::Apis::AdmobV1::MediationReportSpec] attr_accessor :report_spec @@ -153,39 +133,16 @@ module Google end end - # The streaming response for the AdMob Mediation report where the first - # response contains the report header, then a stream of row responses, and - # finally a footer as the last response message. - # For example: - # [` - # "header": ` - # "date_range": ` - # "start_date": `"year": 2018, "month": 9, "day": 1`, - # "end_date": `"year": 2018, "month": 9, "day": 1` - # `, - # "localization_settings": ` - # "currency_code": "USD", - # "language_code": "en-US" - # ` - # ` - # `, - # ` - # "row": ` - # "dimension_values": ` - # "DATE": `"value": "20180918"`, - # "APP": ` - # "value": "ca-app-pub-8123415297019784~1001342552", - # "display_label": "My app name!" - # ` - # `, - # "metric_values": ` - # "ESTIMATED_EARNINGS": `"decimal_value": "1324746"` - # ` - # ` - # `, - # ` - # "footer": `"matching_row_count": 1` - # `] + # The streaming response for the AdMob Mediation report where the first response + # contains the report header, then a stream of row responses, and finally a + # footer as the last response message. For example: [` "header": ` "date_range": + # ` "start_date": `"year": 2018, "month": 9, "day": 1`, "end_date": `"year": + # 2018, "month": 9, "day": 1` `, "localization_settings": ` "currency_code": " + # USD", "language_code": "en-US" ` ` `, ` "row": ` "dimension_values": ` "DATE": + # `"value": "20180918"`, "APP": ` "value": "ca-app-pub-8123415297019784~ + # 1001342552", "display_label": "My app name!" ` `, "metric_values": ` " + # ESTIMATED_EARNINGS": `"decimal_value": "1324746"` ` ` `, ` "footer": `" + # matching_row_count": 1` `] class GenerateMediationReportResponse include Google::Apis::Core::Hashable @@ -222,39 +179,20 @@ module Google class GenerateNetworkReportRequest include Google::Apis::Core::Hashable - # The specification for generating an AdMob Network report. - # For example, the specification to get clicks and estimated earnings for only - # the 'US' and 'CN' countries can look like the following example: - # ` - # 'date_range': ` - # 'start_date': `'year': 2018, 'month': 9, 'day': 1`, - # 'end_date': `'year': 2018, 'month': 9, 'day': 30` - # `, - # 'dimensions': ['DATE', 'APP', 'COUNTRY'], - # 'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'], - # 'dimension_filters': [ - # ` - # 'dimension': 'COUNTRY', - # 'matches_any': `'values': [`'value': 'US', 'value': 'CN'`]` - # ` - # ], - # 'sort_conditions': [ - # `'dimension':'APP', order: 'ASCENDING'`, - # `'metric':'CLICKS', order: 'DESCENDING'` - # ], - # 'localization_settings': ` - # 'currency_code': 'USD', - # 'language_code': 'en-US' - # ` - # ` - # For a better understanding, you can treat the preceding specification like - # the following pseudo SQL: - # SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS - # FROM NETWORK_REPORT - # WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30' - # AND COUNTRY IN ('US', 'CN') - # GROUP BY DATE, APP, COUNTRY - # ORDER BY APP ASC, CLICKS DESC; + # The specification for generating an AdMob Network report. For example, the + # specification to get clicks and estimated earnings for only the 'US' and 'CN' + # countries can look like the following example: ` 'date_range': ` 'start_date': + # `'year': 2018, 'month': 9, 'day': 1`, 'end_date': `'year': 2018, 'month': 9, ' + # day': 30` `, 'dimensions': ['DATE', 'APP', 'COUNTRY'], 'metrics': ['CLICKS', ' + # ESTIMATED_EARNINGS'], 'dimension_filters': [ ` 'dimension': 'COUNTRY', ' + # matches_any': `'values': [`'value': 'US', 'value': 'CN'`]` ` ], ' + # sort_conditions': [ `'dimension':'APP', order: 'ASCENDING'`, `'metric':'CLICKS' + # , order: 'DESCENDING'` ], 'localization_settings': ` 'currency_code': 'USD', ' + # language_code': 'en-US' ` ` For a better understanding, you can treat the + # preceding specification like the following pseudo SQL: SELECT DATE, APP, + # COUNTRY, CLICKS, ESTIMATED_EARNINGS FROM NETWORK_REPORT WHERE DATE >= '2018-09- + # 01' AND DATE <= '2018-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY DATE, APP, + # COUNTRY ORDER BY APP ASC, CLICKS DESC; # Corresponds to the JSON property `reportSpec` # @return [Google::Apis::AdmobV1::NetworkReportSpec] attr_accessor :report_spec @@ -271,37 +209,13 @@ module Google # The streaming response for the AdMob Network report where the first response # contains the report header, then a stream of row responses, and finally a - # footer as the last response message. - # For example: - # [` - # "header": ` - # "dateRange": ` - # "startDate": `"year": 2018, "month": 9, "day": 1`, - # "endDate": `"year": 2018, "month": 9, "day": 1` - # `, - # "localizationSettings": ` - # "currencyCode": "USD", - # "languageCode": "en-US" - # ` - # ` - # `, - # ` - # "row": ` - # "dimensionValues": ` - # "DATE": `"value": "20180918"`, - # "APP": ` - # "value": "ca-app-pub-8123415297019784~1001342552", - # displayLabel: "My app name!" - # ` - # `, - # "metricValues": ` - # "ESTIMATED_EARNINGS": `"microsValue": 6500000` - # ` - # ` - # `, - # ` - # "footer": `"matchingRowCount": 1` - # `] + # footer as the last response message. For example: [` "header": ` "dateRange": ` + # "startDate": `"year": 2018, "month": 9, "day": 1`, "endDate": `"year": 2018, " + # month": 9, "day": 1` `, "localizationSettings": ` "currencyCode": "USD", " + # languageCode": "en-US" ` ` `, ` "row": ` "dimensionValues": ` "DATE": `"value": + # "20180918"`, "APP": ` "value": "ca-app-pub-8123415297019784~1001342552", + # displayLabel: "My app name!" ` `, "metricValues": ` "ESTIMATED_EARNINGS": `" + # microsValue": 6500000` ` ` `, ` "footer": `"matchingRowCount": 1` `] class GenerateNetworkReportResponse include Google::Apis::Core::Hashable @@ -343,8 +257,8 @@ module Google # @return [Array] attr_accessor :account - # If not empty, indicates that there might be more accounts for the request; - # you must pass this value in a new `ListPublisherAccountsRequest`. + # If not empty, indicates that there might be more accounts for the request; you + # must pass this value in a new `ListPublisherAccountsRequest`. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -390,38 +304,19 @@ module Google end end - # The specification for generating an AdMob Mediation report. - # For example, the specification to get observed ECPM sliced by ad source and - # app for the 'US' and 'CN' countries can look like the following example: - # ` - # "date_range": ` - # "start_date": `"year": 2018, "month": 9, "day": 1`, - # "end_date": `"year": 2018, "month": 9, "day": 30` - # `, - # "dimensions": ["AD_SOURCE", "APP", "COUNTRY"], - # "metrics": ["OBSERVED_ECPM"], - # "dimension_filters": [ - # ` - # "dimension": "COUNTRY", - # "matches_any": `"values": [`"value": "US", "value": "CN"`]` - # ` - # ], - # "sort_conditions": [ - # `"dimension":"APP", order: "ASCENDING"` - # ], - # "localization_settings": ` - # "currency_code": "USD", - # "language_code": "en-US" - # ` - # ` - # For a better understanding, you can treat the preceding specification like - # the following pseudo SQL: - # SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM - # FROM MEDIATION_REPORT - # WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30' - # AND COUNTRY IN ('US', 'CN') - # GROUP BY AD_SOURCE, APP, COUNTRY - # ORDER BY APP ASC; + # The specification for generating an AdMob Mediation report. For example, the + # specification to get observed ECPM sliced by ad source and app for the 'US' + # and 'CN' countries can look like the following example: ` "date_range": ` " + # start_date": `"year": 2018, "month": 9, "day": 1`, "end_date": `"year": 2018, " + # month": 9, "day": 30` `, "dimensions": ["AD_SOURCE", "APP", "COUNTRY"], " + # metrics": ["OBSERVED_ECPM"], "dimension_filters": [ ` "dimension": "COUNTRY", " + # matches_any": `"values": [`"value": "US", "value": "CN"`]` ` ], " + # sort_conditions": [ `"dimension":"APP", order: "ASCENDING"` ], " + # localization_settings": ` "currency_code": "USD", "language_code": "en-US" ` ` + # For a better understanding, you can treat the preceding specification like the + # following pseudo SQL: SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM FROM + # MEDIATION_REPORT WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30' AND + # COUNTRY IN ('US', 'CN') GROUP BY AD_SOURCE, APP, COUNTRY ORDER BY APP ASC; class MediationReportSpec include Google::Apis::Core::Hashable @@ -436,8 +331,8 @@ module Google attr_accessor :dimension_filters # List of dimensions of the report. The value combination of these dimensions - # determines the row of the report. If no dimensions are specified, the - # report returns a single row of requested metrics for the entire account. + # determines the row of the report. If no dimensions are specified, the report + # returns a single row of requested metrics for the entire account. # Corresponds to the JSON property `dimensions` # @return [Array] attr_accessor :dimensions @@ -448,9 +343,9 @@ module Google # @return [Google::Apis::AdmobV1::LocalizationSettings] attr_accessor :localization_settings - # Maximum number of report data rows to return. If the value is not set, the - # API returns as many rows as possible, up to 100000. Acceptable values are - # 1-100000, inclusive. Any other values are treated as 100000. + # Maximum number of report data rows to return. If the value is not set, the API + # returns as many rows as possible, up to 100000. Acceptable values are 1-100000, + # inclusive. Any other values are treated as 100000. # Corresponds to the JSON property `maxReportRows` # @return [Fixnum] attr_accessor :max_report_rows @@ -460,19 +355,17 @@ module Google # @return [Array] attr_accessor :metrics - # Describes the sorting of report rows. The order of the condition in the - # list defines its precedence; the earlier the condition, the higher its - # precedence. If no sort conditions are specified, the row ordering is - # undefined. + # Describes the sorting of report rows. The order of the condition in the list + # defines its precedence; the earlier the condition, the higher its precedence. + # If no sort conditions are specified, the row ordering is undefined. # Corresponds to the JSON property `sortConditions` # @return [Array] attr_accessor :sort_conditions - # A report time zone. Accepts an IANA TZ name values, such as - # "America/Los_Angeles." If no time zone is defined, the account default - # takes effect. Check default value by the get account action. - # **Warning:** The "America/Los_Angeles" is the only supported value at - # the moment. + # A report time zone. Accepts an IANA TZ name values, such as "America/ + # Los_Angeles." If no time zone is defined, the account default takes effect. + # Check default value by the get account action. **Warning:** The "America/ + # Los_Angeles" is the only supported value at the moment. # Corresponds to the JSON property `timeZone` # @return [String] attr_accessor :time_zone @@ -550,39 +443,20 @@ module Google end end - # The specification for generating an AdMob Network report. - # For example, the specification to get clicks and estimated earnings for only - # the 'US' and 'CN' countries can look like the following example: - # ` - # 'date_range': ` - # 'start_date': `'year': 2018, 'month': 9, 'day': 1`, - # 'end_date': `'year': 2018, 'month': 9, 'day': 30` - # `, - # 'dimensions': ['DATE', 'APP', 'COUNTRY'], - # 'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'], - # 'dimension_filters': [ - # ` - # 'dimension': 'COUNTRY', - # 'matches_any': `'values': [`'value': 'US', 'value': 'CN'`]` - # ` - # ], - # 'sort_conditions': [ - # `'dimension':'APP', order: 'ASCENDING'`, - # `'metric':'CLICKS', order: 'DESCENDING'` - # ], - # 'localization_settings': ` - # 'currency_code': 'USD', - # 'language_code': 'en-US' - # ` - # ` - # For a better understanding, you can treat the preceding specification like - # the following pseudo SQL: - # SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS - # FROM NETWORK_REPORT - # WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30' - # AND COUNTRY IN ('US', 'CN') - # GROUP BY DATE, APP, COUNTRY - # ORDER BY APP ASC, CLICKS DESC; + # The specification for generating an AdMob Network report. For example, the + # specification to get clicks and estimated earnings for only the 'US' and 'CN' + # countries can look like the following example: ` 'date_range': ` 'start_date': + # `'year': 2018, 'month': 9, 'day': 1`, 'end_date': `'year': 2018, 'month': 9, ' + # day': 30` `, 'dimensions': ['DATE', 'APP', 'COUNTRY'], 'metrics': ['CLICKS', ' + # ESTIMATED_EARNINGS'], 'dimension_filters': [ ` 'dimension': 'COUNTRY', ' + # matches_any': `'values': [`'value': 'US', 'value': 'CN'`]` ` ], ' + # sort_conditions': [ `'dimension':'APP', order: 'ASCENDING'`, `'metric':'CLICKS' + # , order: 'DESCENDING'` ], 'localization_settings': ` 'currency_code': 'USD', ' + # language_code': 'en-US' ` ` For a better understanding, you can treat the + # preceding specification like the following pseudo SQL: SELECT DATE, APP, + # COUNTRY, CLICKS, ESTIMATED_EARNINGS FROM NETWORK_REPORT WHERE DATE >= '2018-09- + # 01' AND DATE <= '2018-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY DATE, APP, + # COUNTRY ORDER BY APP ASC, CLICKS DESC; class NetworkReportSpec include Google::Apis::Core::Hashable @@ -597,8 +471,8 @@ module Google attr_accessor :dimension_filters # List of dimensions of the report. The value combination of these dimensions - # determines the row of the report. If no dimensions are specified, the - # report returns a single row of requested metrics for the entire account. + # determines the row of the report. If no dimensions are specified, the report + # returns a single row of requested metrics for the entire account. # Corresponds to the JSON property `dimensions` # @return [Array] attr_accessor :dimensions @@ -609,9 +483,9 @@ module Google # @return [Google::Apis::AdmobV1::LocalizationSettings] attr_accessor :localization_settings - # Maximum number of report data rows to return. If the value is not set, the - # API returns as many rows as possible, up to 100000. Acceptable values are - # 1-100000, inclusive. Any other values are treated as 100000. + # Maximum number of report data rows to return. If the value is not set, the API + # returns as many rows as possible, up to 100000. Acceptable values are 1-100000, + # inclusive. Any other values are treated as 100000. # Corresponds to the JSON property `maxReportRows` # @return [Fixnum] attr_accessor :max_report_rows @@ -621,19 +495,17 @@ module Google # @return [Array] attr_accessor :metrics - # Describes the sorting of report rows. The order of the condition in the - # list defines its precedence; the earlier the condition, the higher its - # precedence. If no sort conditions are specified, the row ordering is - # undefined. + # Describes the sorting of report rows. The order of the condition in the list + # defines its precedence; the earlier the condition, the higher its precedence. + # If no sort conditions are specified, the row ordering is undefined. # Corresponds to the JSON property `sortConditions` # @return [Array] attr_accessor :sort_conditions - # A report time zone. Accepts an IANA TZ name values, such as - # "America/Los_Angeles." If no time zone is defined, the account default - # takes effect. Check default value by the get account action. - # **Warning:** The "America/Los_Angeles" is the only supported value at - # the moment. + # A report time zone. Accepts an IANA TZ name values, such as "America/ + # Los_Angeles." If no time zone is defined, the account default takes effect. + # Check default value by the get account action. **Warning:** The "America/ + # Los_Angeles" is the only supported value at the moment. # Corresponds to the JSON property `timeZone` # @return [String] attr_accessor :time_zone @@ -711,8 +583,8 @@ module Google end end - # A publisher account contains information relevant to the use of this API, - # such as the time zone used for the reports. + # A publisher account contains information relevant to the use of this API, such + # as the time zone used for the reports. class PublisherAccount include Google::Apis::Core::Hashable @@ -723,21 +595,20 @@ module Google # @return [String] attr_accessor :currency_code - # Resource name of this account. - # Format is accounts/`publisher_id`. + # Resource name of this account. Format is accounts/`publisher_id`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The unique ID by which this publisher account can be identified - # in the API requests (for example, pub-1234567890). + # The unique ID by which this publisher account can be identified in the API + # requests (for example, pub-1234567890). # Corresponds to the JSON property `publisherId` # @return [String] attr_accessor :publisher_id - # The time zone that is used in reports that are generated for this account. - # The value is a time-zone ID as specified by the CLDR project, - # for example, "America/Los_Angeles". + # The time zone that is used in reports that are generated for this account. The + # value is a time-zone ID as specified by the CLDR project, for example, " + # America/Los_Angeles". # Corresponds to the JSON property `reportingTimeZone` # @return [String] attr_accessor :reporting_time_zone @@ -760,9 +631,9 @@ module Google class ReportFooter include Google::Apis::Core::Hashable - # Total number of rows that matched the request. - # Warning: This count does NOT always match the number of rows in the - # response. Do not make that assumption when processing the response. + # Total number of rows that matched the request. Warning: This count does NOT + # always match the number of rows in the response. Do not make that assumption + # when processing the response. # Corresponds to the JSON property `matchingRowCount` # @return [Fixnum] attr_accessor :matching_row_count @@ -826,9 +697,8 @@ module Google # @return [Hash] attr_accessor :dimension_values - # Map of metric values in a row, with keys as enum name of the metrics. If - # a metric being requested has no value returned, the map will not include - # it. + # Map of metric values in a row, with keys as enum name of the metrics. If a + # metric being requested has no value returned, the map will not include it. # Corresponds to the JSON property `metricValues` # @return [Hash] attr_accessor :metric_values @@ -848,14 +718,13 @@ module Google class ReportRowDimensionValue include Google::Apis::Core::Hashable - # The localized string representation of the value. If unspecified, the - # display label should be derived from the value. + # The localized string representation of the value. If unspecified, the display + # label should be derived from the value. # Corresponds to the JSON property `displayLabel` # @return [String] attr_accessor :display_label - # Dimension value in the format specified in the report's spec Dimension - # enum. + # Dimension value in the format specified in the report's spec Dimension enum. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -885,9 +754,9 @@ module Google # @return [Fixnum] attr_accessor :integer_value - # Amount in micros. One million is equivalent to one unit. Currency value - # is in the unit (USD, EUR or other) specified by the request. - # For example, $6.50 whould be represented as 6500000 micros. + # Amount in micros. One million is equivalent to one unit. Currency value is in + # the unit (USD, EUR or other) specified by the request. For example, $6.50 + # whould be represented as 6500000 micros. # Corresponds to the JSON property `microsValue` # @return [Fixnum] attr_accessor :micros_value diff --git a/generated/google/apis/admob_v1/service.rb b/generated/google/apis/admob_v1/service.rb index 1ce99b7ba..166360fd1 100644 --- a/generated/google/apis/admob_v1/service.rb +++ b/generated/google/apis/admob_v1/service.rb @@ -49,8 +49,8 @@ module Google # Gets information about the specified AdMob publisher account. # @param [String] name - # Resource name of the publisher account to retrieve. - # Example: accounts/pub-9876543210987654 + # Resource name of the publisher account to retrieve. Example: accounts/pub- + # 9876543210987654 # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -83,9 +83,9 @@ module Google # @param [Fixnum] page_size # Maximum number of accounts to return. # @param [String] page_token - # The value returned by the last `ListPublisherAccountsResponse`; indicates - # that this is a continuation of a prior `ListPublisherAccounts` call, and - # that the system should return the next page of data. + # The value returned by the last `ListPublisherAccountsResponse`; indicates that + # this is a continuation of a prior `ListPublisherAccounts` call, and that the + # system should return the next page of data. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -114,11 +114,10 @@ module Google execute_or_queue_command(command, &block) end - # Generates an AdMob Mediation report based on the provided report - # specification. + # Generates an AdMob Mediation report based on the provided report specification. # @param [String] parent - # Resource name of the account to generate the report for. - # Example: accounts/pub-9876543210987654 + # Resource name of the account to generate the report for. Example: accounts/pub- + # 9876543210987654 # @param [Google::Apis::AdmobV1::GenerateMediationReportRequest] generate_mediation_report_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -149,11 +148,10 @@ module Google execute_or_queue_command(command, &block) end - # Generates an AdMob Network report based on the provided report - # specification. + # Generates an AdMob Network report based on the provided report specification. # @param [String] parent - # Resource name of the account to generate the report for. - # Example: accounts/pub-9876543210987654 + # Resource name of the account to generate the report for. Example: accounts/pub- + # 9876543210987654 # @param [Google::Apis::AdmobV1::GenerateNetworkReportRequest] generate_network_report_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/androiddeviceprovisioning_v1.rb b/generated/google/apis/androiddeviceprovisioning_v1.rb index 9c7782500..0ba90621e 100644 --- a/generated/google/apis/androiddeviceprovisioning_v1.rb +++ b/generated/google/apis/androiddeviceprovisioning_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/zero-touch/ module AndroiddeviceprovisioningV1 VERSION = 'V1' - REVISION = '20200701' + REVISION = '20200801' end end end diff --git a/generated/google/apis/androiddeviceprovisioning_v1/classes.rb b/generated/google/apis/androiddeviceprovisioning_v1/classes.rb index 06f2af86f..034b357b5 100644 --- a/generated/google/apis/androiddeviceprovisioning_v1/classes.rb +++ b/generated/google/apis/androiddeviceprovisioning_v1/classes.rb @@ -31,15 +31,15 @@ module Google # @return [Fixnum] attr_accessor :customer_id - # Encapsulates hardware and product IDs to identify a manufactured device. - # To understand requirements on identifier sets, read - # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). + # Encapsulates hardware and product IDs to identify a manufactured device. To + # understand requirements on identifier sets, read [Identifiers](https:// + # developers.google.com/zero-touch/guides/identifiers). # Corresponds to the JSON property `deviceIdentifier` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier] attr_accessor :device_identifier - # Metadata entries that can be attached to a `Device`. To learn more, read - # [Device metadata](https://developers.google.com/zero-touch/guides/metadata). + # Metadata entries that can be attached to a `Device`. To learn more, read [ + # Device metadata](https://developers.google.com/zero-touch/guides/metadata). # Corresponds to the JSON property `deviceMetadata` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata] attr_accessor :device_metadata @@ -71,8 +71,8 @@ module Google # @return [Fixnum] attr_accessor :device_id - # The resource name of the device in the format - # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. + # The resource name of the device in the format `partners/[PARTNER_ID]/devices/[ + # DEVICE_ID]`. # Corresponds to the JSON property `deviceName` # @return [String] attr_accessor :device_name @@ -89,8 +89,8 @@ module Google end # Request to claim devices asynchronously in batch. Claiming a device adds the - # device to zero-touch enrollment and shows the device in the customer's view - # of the portal. + # device to zero-touch enrollment and shows the device in the customer's view of + # the portal. class ClaimDevicesRequest include Google::Apis::Core::Hashable @@ -113,8 +113,8 @@ module Google class Company include Google::Apis::Core::Hashable - # Optional. Email address of customer's users in the admin role. - # Each email address must be associated with a Google Account. + # Optional. Email address of customer's users in the admin role. Each email + # address must be associated with a Google Account. # Corresponds to the JSON property `adminEmails` # @return [Array] attr_accessor :admin_emails @@ -130,28 +130,24 @@ module Google # @return [String] attr_accessor :company_name - # Output only. The API resource name of the company. The resource name is one - # of the following formats: - # * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` - # * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` - # * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` - # Assigned by the server. + # Output only. The API resource name of the company. The resource name is one of + # the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * ` + # partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[ + # VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Required. Input only. Email address of customer's users in the owner role. At - # least - # one `owner_email` is required. Each email address must be associated with a - # Google Account. Owners share the same access as admins but can also add, + # least one `owner_email` is required. Each email address must be associated + # with a Google Account. Owners share the same access as admins but can also add, # delete, and edit your organization's portal users. # Corresponds to the JSON property `ownerEmails` # @return [Array] attr_accessor :owner_emails - # Output only. Whether any user from the company has accepted the latest - # Terms of Service (ToS). See - # TermsStatus. + # Output only. Whether any user from the company has accepted the latest Terms + # of Service (ToS). See TermsStatus. # Corresponds to the JSON property `termsStatus` # @return [String] attr_accessor :terms_status @@ -172,13 +168,12 @@ module Google end # A configuration collects the provisioning options for Android devices. Each - # configuration combines the following: - # * The EMM device policy controller (DPC) installed on the devices. - # * EMM policies enforced on the devices. - # * Metadata displayed on the device to help users during setup. - # Customers can add as many configurations as they need. However, zero-touch - # enrollment works best when a customer sets a default configuration that's - # applied to any new devices the organization purchases. + # configuration combines the following: * The EMM device policy controller (DPC) + # installed on the devices. * EMM policies enforced on the devices. * Metadata + # displayed on the device to help users during setup. Customers can add as many + # configurations as they need. However, zero-touch enrollment works best when a + # customer sets a default configuration that's applied to any new devices the + # organization purchases. class Configuration include Google::Apis::Core::Hashable @@ -193,31 +188,31 @@ module Google # @return [Fixnum] attr_accessor :configuration_id - # Required. A short name that describes the configuration's purpose. For - # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment - # portal displays this name to IT admins. + # Required. A short name that describes the configuration's purpose. For example, + # _Sales team_ or _Temporary employees_. The zero-touch enrollment portal + # displays this name to IT admins. # Corresponds to the JSON property `configurationName` # @return [String] attr_accessor :configuration_name - # Required. The email address that device users can contact to get help. - # Zero-touch enrollment shows this email address to device users before - # device provisioning. The value is validated on input. + # Required. The email address that device users can contact to get help. Zero- + # touch enrollment shows this email address to device users before device + # provisioning. The value is validated on input. # Corresponds to the JSON property `contactEmail` # @return [String] attr_accessor :contact_email # Required. The telephone number that device users can call, using another - # device, to get help. Zero-touch enrollment shows this number to device - # users before device provisioning. Accepts numerals, spaces, the plus sign, - # hyphens, and parentheses. + # device, to get help. Zero-touch enrollment shows this number to device users + # before device provisioning. Accepts numerals, spaces, the plus sign, hyphens, + # and parentheses. # Corresponds to the JSON property `contactPhone` # @return [String] attr_accessor :contact_phone - # A message, containing one or two sentences, to help device users get help - # or give them more details about what’s happening to their device. - # Zero-touch enrollment shows this message before the device is provisioned. + # A message, containing one or two sentences, to help device users get help or + # give them more details about what’s happening to their device. Zero-touch + # enrollment shows this message before the device is provisioned. # Corresponds to the JSON property `customMessage` # @return [String] attr_accessor :custom_message @@ -227,27 +222,24 @@ module Google # @return [String] attr_accessor :dpc_extras - # Required. The resource name of the selected DPC (device policy controller) - # in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs, - # call - # `customers.dpcs.list`. + # Required. The resource name of the selected DPC (device policy controller) in + # the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs, call ` + # customers.dpcs.list`. # Corresponds to the JSON property `dpcResourcePath` # @return [String] attr_accessor :dpc_resource_path - # Required. Whether this is the default configuration that zero-touch - # enrollment applies to any new devices the organization purchases in the - # future. Only one customer configuration can be the default. Setting this - # value to `true`, changes the previous default configuration's `isDefault` - # value to `false`. + # Required. Whether this is the default configuration that zero-touch enrollment + # applies to any new devices the organization purchases in the future. Only one + # customer configuration can be the default. Setting this value to `true`, + # changes the previous default configuration's `isDefault` value to `false`. # Corresponds to the JSON property `isDefault` # @return [Boolean] attr_accessor :is_default alias_method :is_default?, :is_default - # Output only. The API resource name in the format - # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by - # the server. + # Output only. The API resource name in the format `customers/[CUSTOMER_ID]/ + # configurations/[CONFIGURATION_ID]`. Assigned by the server. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -294,21 +286,19 @@ module Google class CustomerApplyConfigurationRequest include Google::Apis::Core::Hashable - # Required. The configuration applied to the device in the format - # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. + # Required. The configuration applied to the device in the format `customers/[ + # CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. # Corresponds to the JSON property `configuration` # @return [String] attr_accessor :configuration # A `DeviceReference` is an API abstraction that lets you supply a _device_ - # argument to a method using one of the following identifier types: - # * A numeric API resource ID. - # * Real-world hardware IDs, such as IMEI number, belonging to the manufactured - # device. - # Methods that operate on devices take a `DeviceReference` as a parameter type - # because it's more flexible for the caller. To learn more about device - # identifiers, read - # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). + # argument to a method using one of the following identifier types: * A numeric + # API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to + # the manufactured device. Methods that operate on devices take a ` + # DeviceReference` as a parameter type because it's more flexible for the caller. + # To learn more about device identifiers, read [Identifiers](https://developers. + # google.com/zero-touch/guides/identifiers). # Corresponds to the JSON property `device` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceReference] attr_accessor :device @@ -352,8 +342,8 @@ module Google # @return [Array] attr_accessor :customers - # A token used to access the next page of results. Omitted if no further - # results are available. + # A token used to access the next page of results. Omitted if no further results + # are available. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -378,8 +368,8 @@ module Google # @return [Array] attr_accessor :devices - # A token used to access the next page of results. Omitted if no further - # results are available. + # A token used to access the next page of results. Omitted if no further results + # are available. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -399,8 +389,7 @@ module Google class CustomerListDpcsResponse include Google::Apis::Core::Hashable - # The list of DPCs available to the customer that support zero-touch - # enrollment. + # The list of DPCs available to the customer that support zero-touch enrollment. # Corresponds to the JSON property `dpcs` # @return [Array] attr_accessor :dpcs @@ -420,14 +409,12 @@ module Google include Google::Apis::Core::Hashable # A `DeviceReference` is an API abstraction that lets you supply a _device_ - # argument to a method using one of the following identifier types: - # * A numeric API resource ID. - # * Real-world hardware IDs, such as IMEI number, belonging to the manufactured - # device. - # Methods that operate on devices take a `DeviceReference` as a parameter type - # because it's more flexible for the caller. To learn more about device - # identifiers, read - # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). + # argument to a method using one of the following identifier types: * A numeric + # API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to + # the manufactured device. Methods that operate on devices take a ` + # DeviceReference` as a parameter type because it's more flexible for the caller. + # To learn more about device identifiers, read [Identifiers](https://developers. + # google.com/zero-touch/guides/identifiers). # Corresponds to the JSON property `device` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceReference] attr_accessor :device @@ -447,14 +434,12 @@ module Google include Google::Apis::Core::Hashable # A `DeviceReference` is an API abstraction that lets you supply a _device_ - # argument to a method using one of the following identifier types: - # * A numeric API resource ID. - # * Real-world hardware IDs, such as IMEI number, belonging to the manufactured - # device. - # Methods that operate on devices take a `DeviceReference` as a parameter type - # because it's more flexible for the caller. To learn more about device - # identifiers, read - # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). + # argument to a method using one of the following identifier types: * A numeric + # API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to + # the manufactured device. Methods that operate on devices take a ` + # DeviceReference` as a parameter type because it's more flexible for the caller. + # To learn more about device identifiers, read [Identifiers](https://developers. + # google.com/zero-touch/guides/identifiers). # Corresponds to the JSON property `device` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceReference] attr_accessor :device @@ -473,13 +458,10 @@ module Google class Device include Google::Apis::Core::Hashable - # Output only. The provisioning claims for a device. Devices claimed for - # zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. - # Call - # `partners.devices.unclaim` - # or - # `partners.devices.unclaimAsync` - # to remove the device from zero-touch enrollment. + # Output only. The provisioning claims for a device. Devices claimed for zero- + # touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. Call ` + # partners.devices.unclaim` or `partners.devices.unclaimAsync` to remove the + # device from zero-touch enrollment. # Corresponds to the JSON property `claims` # @return [Array] attr_accessor :claims @@ -494,21 +476,21 @@ module Google # @return [Fixnum] attr_accessor :device_id - # Encapsulates hardware and product IDs to identify a manufactured device. - # To understand requirements on identifier sets, read - # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). + # Encapsulates hardware and product IDs to identify a manufactured device. To + # understand requirements on identifier sets, read [Identifiers](https:// + # developers.google.com/zero-touch/guides/identifiers). # Corresponds to the JSON property `deviceIdentifier` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier] attr_accessor :device_identifier - # Metadata entries that can be attached to a `Device`. To learn more, read - # [Device metadata](https://developers.google.com/zero-touch/guides/metadata). + # Metadata entries that can be attached to a `Device`. To learn more, read [ + # Device metadata](https://developers.google.com/zero-touch/guides/metadata). # Corresponds to the JSON property `deviceMetadata` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata] attr_accessor :device_metadata - # Output only. The API resource name in the format - # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server. + # Output only. The API resource name in the format `partners/[PARTNER_ID]/ + # devices/[DEVICE_ID]`. Assigned by the server. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -528,10 +510,10 @@ module Google end end - # A record of a device claimed by a reseller for a customer. Devices claimed - # for zero-touch enrollment have a claim with the type - # `SECTION_TYPE_ZERO_TOUCH`. To learn more, read - # [Claim devices for customers](/zero-touch/guides/how-it-works#claim). + # A record of a device claimed by a reseller for a customer. Devices claimed for + # zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. To + # learn more, read [Claim devices for customers](/zero-touch/guides/how-it-works# + # claim). class DeviceClaim include Google::Apis::Core::Hashable @@ -550,8 +532,8 @@ module Google # @return [String] attr_accessor :section_type - # The timestamp when the device will exit ‘vacation mode’. This value is - # present iff the device is in 'vacation mode'. + # The timestamp when the device will exit ‘vacation mode’. This value is present + # iff the device is in 'vacation mode'. # Corresponds to the JSON property `vacationModeExpireTime` # @return [String] attr_accessor :vacation_mode_expire_time @@ -576,9 +558,9 @@ module Google end end - # Encapsulates hardware and product IDs to identify a manufactured device. - # To understand requirements on identifier sets, read - # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). + # Encapsulates hardware and product IDs to identify a manufactured device. To + # understand requirements on identifier sets, read [Identifiers](https:// + # developers.google.com/zero-touch/guides/identifiers). class DeviceIdentifier include Google::Apis::Core::Hashable @@ -587,10 +569,9 @@ module Google # @return [String] attr_accessor :imei - # The device manufacturer’s name. Matches the device's built-in - # value returned from `android.os.Build.MANUFACTURER`. Allowed values are - # listed in - # [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). + # The device manufacturer’s name. Matches the device's built-in value returned + # from `android.os.Build.MANUFACTURER`. Allowed values are listed in [ + # manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). # Corresponds to the JSON property `manufacturer` # @return [String] attr_accessor :manufacturer @@ -600,9 +581,9 @@ module Google # @return [String] attr_accessor :meid - # The device model's name. Matches the device's built-in value returned from - # `android.os.Build.MODEL`. Allowed values are listed in - # [models](/zero-touch/resources/manufacturer-names#model-names). + # The device model's name. Matches the device's built-in value returned from ` + # android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/ + # resources/manufacturer-names#model-names). # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -627,8 +608,8 @@ module Google end end - # Metadata entries that can be attached to a `Device`. To learn more, read - # [Device metadata](https://developers.google.com/zero-touch/guides/metadata). + # Metadata entries that can be attached to a `Device`. To learn more, read [ + # Device metadata](https://developers.google.com/zero-touch/guides/metadata). class DeviceMetadata include Google::Apis::Core::Hashable @@ -648,14 +629,12 @@ module Google end # A `DeviceReference` is an API abstraction that lets you supply a _device_ - # argument to a method using one of the following identifier types: - # * A numeric API resource ID. - # * Real-world hardware IDs, such as IMEI number, belonging to the manufactured - # device. - # Methods that operate on devices take a `DeviceReference` as a parameter type - # because it's more flexible for the caller. To learn more about device - # identifiers, read - # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). + # argument to a method using one of the following identifier types: * A numeric + # API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to + # the manufactured device. Methods that operate on devices take a ` + # DeviceReference` as a parameter type because it's more flexible for the caller. + # To learn more about device identifiers, read [Identifiers](https://developers. + # google.com/zero-touch/guides/identifiers). class DeviceReference include Google::Apis::Core::Hashable @@ -664,9 +643,9 @@ module Google # @return [Fixnum] attr_accessor :device_id - # Encapsulates hardware and product IDs to identify a manufactured device. - # To understand requirements on identifier sets, read - # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). + # Encapsulates hardware and product IDs to identify a manufactured device. To + # understand requirements on identifier sets, read [Identifiers](https:// + # developers.google.com/zero-touch/guides/identifiers). # Corresponds to the JSON property `deviceIdentifier` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier] attr_accessor :device_identifier @@ -682,15 +661,15 @@ module Google end end - # Tracks the status of a long-running operation to asynchronously update a - # batch of reseller metadata attached to devices. To learn more, read - # [Long‑running batch operations](/zero-touch/guides/how-it-works#operations). + # Tracks the status of a long-running operation to asynchronously update a batch + # of reseller metadata attached to devices. To learn more, read [Long‑running + # batch operations](/zero-touch/guides/how-it-works#operations). class DevicesLongRunningOperationMetadata include Google::Apis::Core::Hashable - # The number of metadata updates in the operation. This might be different - # from the number of updates in the request if the API can't parse some of - # the updates. + # The number of metadata updates in the operation. This might be different from + # the number of updates in the request if the API can't parse some of the + # updates. # Corresponds to the JSON property `devicesCount` # @return [Fixnum] attr_accessor :devices_count @@ -700,9 +679,9 @@ module Google # @return [String] attr_accessor :processing_status - # The processing progress of the operation. Measured as a number from 0 to - # 100. A value of 10O doesnt always mean the operation completed—check for - # the inclusion of a `done` field. + # The processing progress of the operation. Measured as a number from 0 to 100. + # A value of 10O doesnt always mean the operation completed—check for the + # inclusion of a `done` field. # Corresponds to the JSON property `progress` # @return [Fixnum] attr_accessor :progress @@ -720,20 +699,19 @@ module Google end # Tracks the status of a long-running operation to claim, unclaim, or attach - # metadata to devices. To learn more, read - # [Long‑running batch operations](/zero-touch/guides/how-it-works#operations). + # metadata to devices. To learn more, read [Long‑running batch operations](/zero- + # touch/guides/how-it-works#operations). class DevicesLongRunningOperationResponse include Google::Apis::Core::Hashable - # The processing status for each device in the operation. - # One `PerDeviceStatus` per device. The list order matches the items in the - # original request. + # The processing status for each device in the operation. One `PerDeviceStatus` + # per device. The list order matches the items in the original request. # Corresponds to the JSON property `perDeviceStatus` # @return [Array] attr_accessor :per_device_status - # A summary of how many items in the operation the server processed - # successfully. Updated as the operation progresses. + # A summary of how many items in the operation the server processed successfully. + # Updated as the operation progresses. # Corresponds to the JSON property `successCount` # @return [Fixnum] attr_accessor :success_count @@ -749,11 +727,11 @@ module Google end end - # An EMM's DPC ([device policy - # controller](http://developer.android.com/work/dpc/build-dpc.html)). - # Zero-touch enrollment installs a DPC (listed in the `Configuration`) on a - # device to maintain the customer's mobile policies. All the DPCs listed by the - # API support zero-touch enrollment and are available in Google Play. + # An EMM's DPC ([device policy controller](http://developer.android.com/work/dpc/ + # build-dpc.html)). Zero-touch enrollment installs a DPC (listed in the ` + # Configuration`) on a device to maintain the customer's mobile policies. All + # the DPCs listed by the API support zero-touch enrollment and are available in + # Google Play. class Dpc include Google::Apis::Core::Hashable @@ -763,17 +741,16 @@ module Google # @return [String] attr_accessor :dpc_name - # Output only. The API resource name in the format - # `customers/[CUSTOMER_ID]/dpcs/[DPC_ID]`. Assigned by - # the server. To maintain a reference to a DPC across customer accounts, - # persist and match the last path component (`DPC_ID`). + # Output only. The API resource name in the format `customers/[CUSTOMER_ID]/dpcs/ + # [DPC_ID]`. Assigned by the server. To maintain a reference to a DPC across + # customer accounts, persist and match the last path component (`DPC_ID`). # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Output only. The DPC's Android application ID that looks like a Java - # package name. Zero-touch enrollment installs the DPC app onto a device - # using this identifier. + # Output only. The DPC's Android application ID that looks like a Java package + # name. Zero-touch enrollment installs the DPC app onto a device using this + # identifier. # Corresponds to the JSON property `packageName` # @return [String] attr_accessor :package_name @@ -790,13 +767,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 @@ -813,15 +788,15 @@ module Google class FindDevicesByDeviceIdentifierRequest include Google::Apis::Core::Hashable - # Encapsulates hardware and product IDs to identify a manufactured device. - # To understand requirements on identifier sets, read - # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). + # Encapsulates hardware and product IDs to identify a manufactured device. To + # understand requirements on identifier sets, read [Identifiers](https:// + # developers.google.com/zero-touch/guides/identifiers). # Corresponds to the JSON property `deviceIdentifier` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier] attr_accessor :device_identifier - # Required. The maximum number of devices to show in a page of results. Must - # be between 1 and 100 inclusive. + # Required. The maximum number of devices to show in a page of results. Must be + # between 1 and 100 inclusive. # Corresponds to the JSON property `limit` # @return [Fixnum] attr_accessor :limit @@ -852,8 +827,8 @@ module Google # @return [Array] attr_accessor :devices - # A token used to access the next page of results. Omitted if no further - # results are available. + # A token used to access the next page of results. Omitted if no further results + # are available. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -884,8 +859,8 @@ module Google # @return [Array] attr_accessor :customer_id - # Required. The maximum number of devices to show in a page of results. Must - # be between 1 and 100 inclusive. + # Required. The maximum number of devices to show in a page of results. Must be + # between 1 and 100 inclusive. # Corresponds to the JSON property `limit` # @return [Fixnum] attr_accessor :limit @@ -922,8 +897,8 @@ module Google # @return [Array] attr_accessor :devices - # A token used to access the next page of results. - # Omitted if no further results are available. + # A token used to access the next page of results. Omitted if no further results + # are available. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1024,8 +999,8 @@ module Google # @return [Fixnum] attr_accessor :total_size - # List of vendors of the reseller partner. Fields `name`, `companyId` and - # `companyName` are populated to the Company object. + # List of vendors of the reseller partner. Fields `name`, `companyId` and ` + # companyName` are populated to the Company object. # Corresponds to the JSON property `vendors` # @return [Array] attr_accessor :vendors @@ -1047,20 +1022,19 @@ 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::AndroiddeviceprovisioningV1::Status] attr_accessor :error @@ -1072,8 +1046,8 @@ module Google 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 @@ -1098,8 +1072,8 @@ module Google end end - # A task for each device in the operation. Corresponds to each device - # change in the request. + # A task for each device in the operation. Corresponds to each device change in + # the request. class OperationPerDevice include Google::Apis::Core::Hashable @@ -1145,15 +1119,15 @@ module Google # @return [Fixnum] attr_accessor :customer_id - # Encapsulates hardware and product IDs to identify a manufactured device. - # To understand requirements on identifier sets, read - # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). + # Encapsulates hardware and product IDs to identify a manufactured device. To + # understand requirements on identifier sets, read [Identifiers](https:// + # developers.google.com/zero-touch/guides/identifiers). # Corresponds to the JSON property `deviceIdentifier` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier] attr_accessor :device_identifier - # Metadata entries that can be attached to a `Device`. To learn more, read - # [Device metadata](https://developers.google.com/zero-touch/guides/metadata). + # Metadata entries that can be attached to a `Device`. To learn more, read [ + # Device metadata](https://developers.google.com/zero-touch/guides/metadata). # Corresponds to the JSON property `deviceMetadata` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata] attr_accessor :device_metadata @@ -1185,9 +1159,9 @@ module Google # @return [Fixnum] attr_accessor :device_id - # Encapsulates hardware and product IDs to identify a manufactured device. - # To understand requirements on identifier sets, read - # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). + # Encapsulates hardware and product IDs to identify a manufactured device. To + # understand requirements on identifier sets, read [Identifiers](https:// + # developers.google.com/zero-touch/guides/identifiers). # Corresponds to the JSON property `deviceIdentifier` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier] attr_accessor :device_identifier @@ -1198,8 +1172,7 @@ module Google attr_accessor :section_type # Optional. The duration of the vacation unlock starting from when the request - # is - # processed. (1 day is treated as 24 hours) + # is processed. (1 day is treated as 24 hours) # Corresponds to the JSON property `vacationModeDays` # @return [Fixnum] attr_accessor :vacation_mode_days @@ -1260,12 +1233,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 @@ -1274,15 +1247,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 @@ -1308,9 +1281,9 @@ module Google # @return [Fixnum] attr_accessor :device_id - # Encapsulates hardware and product IDs to identify a manufactured device. - # To understand requirements on identifier sets, read - # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). + # Encapsulates hardware and product IDs to identify a manufactured device. To + # understand requirements on identifier sets, read [Identifiers](https:// + # developers.google.com/zero-touch/guides/identifiers). # Corresponds to the JSON property `deviceIdentifier` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier] attr_accessor :device_identifier @@ -1387,8 +1360,8 @@ module Google class UpdateDeviceMetadataRequest include Google::Apis::Core::Hashable - # Metadata entries that can be attached to a `Device`. To learn more, read - # [Device metadata](https://developers.google.com/zero-touch/guides/metadata). + # Metadata entries that can be attached to a `Device`. To learn more, read [ + # Device metadata](https://developers.google.com/zero-touch/guides/metadata). # Corresponds to the JSON property `deviceMetadata` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata] attr_accessor :device_metadata @@ -1412,15 +1385,15 @@ module Google # @return [Fixnum] attr_accessor :device_id - # Encapsulates hardware and product IDs to identify a manufactured device. - # To understand requirements on identifier sets, read - # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). + # Encapsulates hardware and product IDs to identify a manufactured device. To + # understand requirements on identifier sets, read [Identifiers](https:// + # developers.google.com/zero-touch/guides/identifiers). # Corresponds to the JSON property `deviceIdentifier` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier] attr_accessor :device_identifier - # Metadata entries that can be attached to a `Device`. To learn more, read - # [Device metadata](https://developers.google.com/zero-touch/guides/metadata). + # Metadata entries that can be attached to a `Device`. To learn more, read [ + # Device metadata](https://developers.google.com/zero-touch/guides/metadata). # Corresponds to the JSON property `deviceMetadata` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata] attr_accessor :device_metadata diff --git a/generated/google/apis/androiddeviceprovisioning_v1/service.rb b/generated/google/apis/androiddeviceprovisioning_v1/service.rb index 08c954f2f..f104c7180 100644 --- a/generated/google/apis/androiddeviceprovisioning_v1/service.rb +++ b/generated/google/apis/androiddeviceprovisioning_v1/service.rb @@ -50,8 +50,8 @@ module Google # Lists the user's customer accounts. # @param [Fixnum] page_size - # The maximum number of customers to show in a page of results. - # A number between 1 and 100 (inclusive). + # The maximum number of customers to show in a page of results. A number between + # 1 and 100 (inclusive). # @param [String] page_token # A token specifying which result page to return. # @param [String] fields @@ -85,8 +85,8 @@ module Google # Creates a new configuration. Once created, a customer can apply the # configuration to devices. # @param [String] parent - # Required. The customer that manages the configuration. An API resource name - # in the format `customers/[CUSTOMER_ID]`. + # Required. The customer that manages the configuration. An API resource name in + # the format `customers/[CUSTOMER_ID]`. # @param [Google::Apis::AndroiddeviceprovisioningV1::Configuration] configuration_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -120,8 +120,8 @@ module Google # Deletes an unused configuration. The API call fails if the customer has # devices with the configuration applied. # @param [String] name - # Required. The configuration to delete. An API resource name in the format - # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. If the + # Required. The configuration to delete. An API resource name in the format ` + # customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. If the # configuration is applied to any devices, the API call fails. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -152,8 +152,8 @@ module Google # Gets the details of a configuration. # @param [String] name - # Required. The configuration to get. An API resource name in the format - # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. + # Required. The configuration to get. An API resource name in the format ` + # customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -183,8 +183,8 @@ module Google # Lists a customer's configurations. # @param [String] parent - # Required. The customer that manages the listed configurations. An API - # resource name in the format `customers/[CUSTOMER_ID]`. + # Required. The customer that manages the listed configurations. An API resource + # name in the format `customers/[CUSTOMER_ID]`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -214,15 +214,14 @@ module Google # Updates a configuration's field values. # @param [String] name - # Output only. The API resource name in the format - # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by - # the server. + # Output only. The API resource name in the format `customers/[CUSTOMER_ID]/ + # configurations/[CONFIGURATION_ID]`. Assigned by the server. # @param [Google::Apis::AndroiddeviceprovisioningV1::Configuration] configuration_object # @param [String] update_mask - # Required. The field mask applied to the target `Configuration` before - # updating the fields. To learn more about using field masks, read - # [FieldMask](/protocol-buffers/docs/reference/google.protobuf#fieldmask) in - # the Protocol Buffers documentation. + # Required. The field mask applied to the target `Configuration` before updating + # the fields. To learn more about using field masks, read [FieldMask](/protocol- + # buffers/docs/reference/google.protobuf#fieldmask) in the Protocol Buffers + # documentation. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -257,8 +256,8 @@ module Google # enrollment. After applying a configuration to a device, the device # automatically provisions itself on first boot, or next factory reset. # @param [String] parent - # Required. The customer managing the device. An API resource name in the - # format `customers/[CUSTOMER_ID]`. + # Required. The customer managing the device. An API resource name in the format + # `customers/[CUSTOMER_ID]`. # @param [Google::Apis::AndroiddeviceprovisioningV1::CustomerApplyConfigurationRequest] customer_apply_configuration_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -291,8 +290,8 @@ module Google # Gets the details of a device. # @param [String] name - # Required. The device to get. An API resource name in the format - # `customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`. + # Required. The device to get. An API resource name in the format `customers/[ + # CUSTOMER_ID]/devices/[DEVICE_ID]`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -325,8 +324,8 @@ module Google # Required. The customer managing the devices. An API resource name in the # format `customers/[CUSTOMER_ID]`. # @param [Fixnum] page_size - # The maximum number of devices to show in a page of results. - # Must be between 1 and 100 inclusive. + # The maximum number of devices to show in a page of results. Must be between 1 + # and 100 inclusive. # @param [String] page_token # A token specifying which result page to return. # @param [String] fields @@ -360,8 +359,8 @@ module Google # Removes a configuration from device. # @param [String] parent - # Required. The customer managing the device in the format - # `customers/[CUSTOMER_ID]`. + # Required. The customer managing the device in the format `customers/[ + # CUSTOMER_ID]`. # @param [Google::Apis::AndroiddeviceprovisioningV1::CustomerRemoveConfigurationRequest] customer_remove_configuration_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -392,13 +391,12 @@ module Google execute_or_queue_command(command, &block) end - # Unclaims a device from a customer and removes it from zero-touch - # enrollment. + # Unclaims a device from a customer and removes it from zero-touch enrollment. # After removing a device, a customer must contact their reseller to register # the device into zero-touch enrollment again. # @param [String] parent - # Required. The customer managing the device. An API resource name in the - # format `customers/[CUSTOMER_ID]`. + # Required. The customer managing the device. An API resource name in the format + # `customers/[CUSTOMER_ID]`. # @param [Google::Apis::AndroiddeviceprovisioningV1::CustomerUnclaimDeviceRequest] customer_unclaim_device_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -429,8 +427,7 @@ module Google execute_or_queue_command(command, &block) end - # Lists the DPCs (device policy controllers) that support zero-touch - # enrollment. + # Lists the DPCs (device policy controllers) that support zero-touch enrollment. # @param [String] parent # Required. The customer that can use the DPCs in configurations. An API # resource name in the format `customers/[CUSTOMER_ID]`. @@ -461,9 +458,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 @@ -494,10 +490,10 @@ module Google end # Creates a customer for zero-touch enrollment. After the method returns - # successfully, admin and owner roles can manage devices and EMM configs - # by calling API methods or using their zero-touch enrollment portal. - # The customer receives an email that welcomes them to zero-touch enrollment - # and explains how to sign into the portal. + # successfully, admin and owner roles can manage devices and EMM configs by + # calling API methods or using their zero-touch enrollment portal. The customer + # receives an email that welcomes them to zero-touch enrollment and explains how + # to sign into the portal. # @param [String] parent # Required. The parent resource ID in the format `partners/[PARTNER_ID]` that # identifies the reseller. @@ -531,14 +527,14 @@ module Google execute_or_queue_command(command, &block) end - # Lists the customers that are enrolled to the reseller identified by the - # `partnerId` argument. This list includes customers that the reseller - # created and customers that enrolled themselves using the portal. + # Lists the customers that are enrolled to the reseller identified by the ` + # partnerId` argument. This list includes customers that the reseller created + # and customers that enrolled themselves using the portal. # @param [Fixnum] partner_id # Required. The ID of the reseller partner. # @param [Fixnum] page_size - # The maximum number of results to be returned. If not specified or 0, all - # the records are returned. + # The maximum number of results to be returned. If not specified or 0, all the + # records are returned. # @param [String] page_token # A token identifying a page of results returned by the server. # @param [String] fields @@ -604,9 +600,9 @@ module Google execute_or_queue_command(command, &block) end - # Claims a batch of devices for a customer asynchronously. Adds the devices - # to zero-touch enrollment. To learn more, read [Long‑running batch - # operations](/zero-touch/guides/how-it-works#operations). + # Claims a batch of devices for a customer asynchronously. Adds the devices to + # zero-touch enrollment. To learn more, read [Long‑running batch operations](/ + # zero-touch/guides/how-it-works#operations). # @param [Fixnum] partner_id # Required. The ID of the reseller partner. # @param [Google::Apis::AndroiddeviceprovisioningV1::ClaimDevicesRequest] claim_devices_request_object @@ -673,9 +669,8 @@ module Google end # Finds devices claimed for customers. The results only contain devices - # registered to the reseller that's identified by the `partnerId` argument. - # The customer's devices purchased from other resellers don't appear in the - # results. + # registered to the reseller that's identified by the `partnerId` argument. The + # customer's devices purchased from other resellers don't appear in the results. # @param [Fixnum] partner_id # Required. The ID of the reseller partner. # @param [Google::Apis::AndroiddeviceprovisioningV1::FindDevicesByOwnerRequest] find_devices_by_owner_request_object @@ -710,8 +705,8 @@ module Google # Gets a device. # @param [String] name - # Required. The device API resource name in the format - # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. + # Required. The device API resource name in the format `partners/[PARTNER_ID]/ + # devices/[DEVICE_ID]`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -775,8 +770,7 @@ module Google execute_or_queue_command(command, &block) end - # Unclaims a device from a customer and removes it from zero-touch - # enrollment. + # Unclaims a device from a customer and removes it from zero-touch enrollment. # @param [Fixnum] partner_id # Required. The ID of the reseller partner. # @param [Google::Apis::AndroiddeviceprovisioningV1::UnclaimDeviceRequest] unclaim_device_request_object @@ -809,9 +803,9 @@ module Google execute_or_queue_command(command, &block) end - # Unclaims a batch of devices for a customer asynchronously. Removes the - # devices from zero-touch enrollment. To learn more, read [Long‑running batch - # operations](/zero-touch/guides/how-it-works#operations). + # Unclaims a batch of devices for a customer asynchronously. Removes the devices + # from zero-touch enrollment. To learn more, read [Long‑running batch operations] + # (/zero-touch/guides/how-it-works#operations). # @param [Fixnum] partner_id # Required. The reseller partner ID. # @param [Google::Apis::AndroiddeviceprovisioningV1::UnclaimDevicesRequest] unclaim_devices_request_object @@ -845,9 +839,9 @@ module Google end # Updates the reseller metadata attached to a batch of devices. This method - # updates devices asynchronously and returns an `Operation` that can be used - # to track progress. Read [Long‑running batch - # operations](/zero-touch/guides/how-it-works#operations). + # updates devices asynchronously and returns an `Operation` that can be used to + # track progress. Read [Long‑running batch operations](/zero-touch/guides/how-it- + # works#operations). # @param [Fixnum] partner_id # Required. The reseller partner ID. # @param [Google::Apis::AndroiddeviceprovisioningV1::UpdateDeviceMetadataInBatchRequest] update_device_metadata_in_batch_request_object @@ -918,8 +912,8 @@ module Google # Lists the customers of the vendor. # @param [String] parent - # Required. The resource name in the format - # `partners/[PARTNER_ID]/vendors/[VENDOR_ID]`. + # Required. The resource name in the format `partners/[PARTNER_ID]/vendors/[ + # VENDOR_ID]`. # @param [Fixnum] page_size # The maximum number of results to be returned. # @param [String] page_token diff --git a/generated/google/apis/androidpublisher_v3.rb b/generated/google/apis/androidpublisher_v3.rb index f6f6f9141..8bc8a9ed3 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 = '20200701' + REVISION = '20200801' # View and manage your Google Play Developer account AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher' diff --git a/generated/google/apis/androidpublisher_v3/classes.rb b/generated/google/apis/androidpublisher_v3/classes.rb index a9a82ca7e..672e0a612 100644 --- a/generated/google/apis/androidpublisher_v3/classes.rb +++ b/generated/google/apis/androidpublisher_v3/classes.rb @@ -57,8 +57,8 @@ module Google # @return [String] attr_accessor :sha1 - # A sha256 hash of the APK payload, encoded as a hex string and matching - # the output of the sha256sum command. + # A sha256 hash of the APK payload, encoded as a hex string and matching the + # output of the sha256sum command. # Corresponds to the JSON property `sha256` # @return [String] attr_accessor :sha256 @@ -78,10 +78,10 @@ module Google class ApksAddExternallyHostedRequest include Google::Apis::Core::Hashable - # Defines an APK available for this application that is hosted externally - # and not uploaded to Google Play. - # This function is only available to organizations using Managed Play whose - # application is configured to restrict distribution to the organizations. + # Defines an APK available for this application that is hosted externally and + # not uploaded to Google Play. This function is only available to organizations + # using Managed Play whose application is configured to restrict distribution to + # the organizations. # Corresponds to the JSON property `externallyHostedApk` # @return [Google::Apis::AndroidpublisherV3::ExternallyHostedApk] attr_accessor :externally_hosted_apk @@ -100,10 +100,10 @@ module Google class ApksAddExternallyHostedResponse include Google::Apis::Core::Hashable - # Defines an APK available for this application that is hosted externally - # and not uploaded to Google Play. - # This function is only available to organizations using Managed Play whose - # application is configured to restrict distribution to the organizations. + # Defines an APK available for this application that is hosted externally and + # not uploaded to Google Play. This function is only available to organizations + # using Managed Play whose application is configured to restrict distribution to + # the organizations. # Corresponds to the JSON property `externallyHostedApk` # @return [Google::Apis::AndroidpublisherV3::ExternallyHostedApk] attr_accessor :externally_hosted_apk @@ -185,8 +185,7 @@ module Google include Google::Apis::Core::Hashable # Output only. The time (as seconds since Epoch) at which the edit will expire - # and - # will be no longer valid for use. + # and will be no longer valid for use. # Corresponds to the JSON property `expiryTimeSeconds` # @return [String] attr_accessor :expiry_time_seconds @@ -211,14 +210,14 @@ module Google class Bundle include Google::Apis::Core::Hashable - # A sha1 hash of the upload payload, encoded as a hex string and matching - # the output of the sha1sum command. + # A sha1 hash of the upload payload, encoded as a hex string and matching the + # output of the sha1sum command. # Corresponds to the JSON property `sha1` # @return [String] attr_accessor :sha1 - # A sha256 hash of the upload payload, encoded as a hex string and matching - # the output of the sha256sum command. + # A sha256 hash of the upload payload, encoded as a hex string and matching the + # output of the sha256sum command. # Corresponds to the JSON property `sha256` # @return [String] attr_accessor :sha256 @@ -295,9 +294,8 @@ module Google class CountryTargeting include Google::Apis::Core::Hashable - # Countries to target, specified as two letter [CLDR - # codes](https://unicode.org/cldr/charts/latest/supplemental/ - # territory_containment_un_m_49.html). + # Countries to target, specified as two letter [CLDR codes](https://unicode.org/ + # cldr/charts/latest/supplemental/territory_containment_un_m_49.html). # Corresponds to the JSON property `countries` # @return [Array] attr_accessor :countries @@ -362,9 +360,9 @@ module Google include Google::Apis::Core::Hashable # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at - # nanosecond resolution. The count is relative to an epoch at UTC midnight on - # January 1, 1970. + # calendar, encoded as a count of seconds and fractions of seconds at nanosecond + # resolution. The count is relative to an epoch at UTC midnight on January 1, + # 1970. # Corresponds to the JSON property `lastModified` # @return [Google::Apis::AndroidpublisherV3::Timestamp] attr_accessor :last_modified @@ -473,9 +471,8 @@ module Google # @return [Fixnum] attr_accessor :screen_density - # Supported ABI architectures in the order of preference. - # The values should be the string as reported by the platform, e.g. - # "armeabi-v7a", "x86_64". + # Supported ABI architectures in the order of preference. The values should be + # the string as reported by the platform, e.g. "armeabi-v7a", "x86_64". # Corresponds to the JSON property `supportedAbis` # @return [Array] attr_accessor :supported_abis @@ -501,15 +498,15 @@ module Google class ExpansionFile include Google::Apis::Core::Hashable - # If set, this field indicates that this APK has an expansion file uploaded - # to it: this APK does not reference another APK's expansion file. - # The field's value is the size of the uploaded expansion file in bytes. + # If set, this field indicates that this APK has an expansion file uploaded to + # it: this APK does not reference another APK's expansion file. The field's + # value is the size of the uploaded expansion file in bytes. # Corresponds to the JSON property `fileSize` # @return [Fixnum] attr_accessor :file_size - # If set, this APK's expansion file references another APK's expansion file. - # The file_size field will not be set. + # If set, this APK's expansion file references another APK's expansion file. The + # file_size field will not be set. # Corresponds to the JSON property `referencesVersion` # @return [Fixnum] attr_accessor :references_version @@ -544,10 +541,10 @@ module Google end end - # Defines an APK available for this application that is hosted externally - # and not uploaded to Google Play. - # This function is only available to organizations using Managed Play whose - # application is configured to restrict distribution to the organizations. + # Defines an APK available for this application that is hosted externally and + # not uploaded to Google Play. This function is only available to organizations + # using Managed Play whose application is configured to restrict distribution to + # the organizations. class ExternallyHostedApk include Google::Apis::Core::Hashable @@ -556,8 +553,8 @@ module Google # @return [String] attr_accessor :application_label - # A certificate (or array of certificates if a certificate-chain is used) - # used to sign this APK, represented as a base64 encoded byte array. + # A certificate (or array of certificates if a certificate-chain is used) used + # to sign this APK, represented as a base64 encoded byte array. # Corresponds to the JSON property `certificateBase64s` # @return [Array] attr_accessor :certificate_base64s @@ -567,14 +564,12 @@ module Google # @return [String] attr_accessor :externally_hosted_url - # The sha1 checksum of this APK, represented as a base64 encoded byte - # array. + # The sha1 checksum of this APK, represented as a base64 encoded byte array. # Corresponds to the JSON property `fileSha1Base64` # @return [String] attr_accessor :file_sha1_base64 - # The sha256 checksum of this APK, represented as a base64 encoded byte - # array. + # The sha256 checksum of this APK, represented as a base64 encoded byte array. # Corresponds to the JSON property `fileSha256Base64` # @return [String] attr_accessor :file_sha256_base64 @@ -762,16 +757,15 @@ module Google attr_accessor :default_price # Grace period of the subscription, specified in ISO 8601 format. Allows - # developers to give their subscribers a grace period when the payment - # for the new recurrence period is declined. - # Acceptable values are P0D (zero days), P3D (three days), P7D (seven days), - # P14D (14 days), and P30D (30 days). + # developers to give their subscribers a grace period when the payment for the + # new recurrence period is declined. Acceptable values are P0D (zero days), P3D ( + # three days), P7D (seven days), P14D (14 days), and P30D (30 days). # Corresponds to the JSON property `gracePeriod` # @return [String] attr_accessor :grace_period - # List of localized title and description data. Map key is the language of - # the localized data, as defined by BCP-47, e.g. "en-US". + # List of localized title and description data. Map key is the language of the + # localized data, as defined by BCP-47, e.g. "en-US". # Corresponds to the JSON property `listings` # @return [Hash] attr_accessor :listings @@ -802,9 +796,9 @@ module Google # @return [String] attr_accessor :status - # Subscription period, specified in ISO 8601 format. Acceptable values are - # P1W (one week), P1M (one month), P3M (three months), P6M (six months), - # and P1Y (one year). + # Subscription period, specified in ISO 8601 format. Acceptable values are P1W ( + # one week), P1M (one month), P3M (three months), P6M (six months), and P1Y (one + # year). # Corresponds to the JSON property `subscriptionPeriod` # @return [String] attr_accessor :subscription_period @@ -880,22 +874,21 @@ module Google # @return [String] attr_accessor :kind - # Information about the current page. - # List operations that supports paging return only one "page" of results. This - # protocol buffer message describes the page that has been returned. + # Information about the current page. List operations that supports paging + # return only one "page" of results. This protocol buffer message describes the + # page that has been returned. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::AndroidpublisherV3::PageInfo] attr_accessor :page_info - # Pagination information returned by a List operation when token pagination - # is enabled. - # List operations that supports paging return only one "page" of results. This - # protocol buffer message describes the page that has been returned. - # When using token pagination, clients should use the next/previous token - # to get another page of the result. The presence or absence of next/previous - # token indicates whether a next/previous page is available and provides a - # mean of accessing this page. ListRequest.page_token should be set to either - # next_page_token or previous_page_token to access another page. + # Pagination information returned by a List operation when token pagination is + # enabled. List operations that supports paging return only one "page" of + # results. This protocol buffer message describes the page that has been + # returned. When using token pagination, clients should use the next/previous + # token to get another page of the result. The presence or absence of next/ + # previous token indicates whether a next/previous page is available and + # provides a mean of accessing this page. ListRequest.page_token should be set + # to either next_page_token or previous_page_token to access another page. # Corresponds to the JSON property `tokenPagination` # @return [Google::Apis::AndroidpublisherV3::TokenPagination] attr_accessor :token_pagination @@ -913,26 +906,24 @@ module Google end end - # An artifact resource which gets created when uploading an APK or Android - # App Bundle through internal app sharing. + # An artifact resource which gets created when uploading an APK or Android App + # Bundle through internal app sharing. class InternalAppSharingArtifact include Google::Apis::Core::Hashable - # The sha256 fingerprint of the certificate used to sign the generated - # artifact. + # The sha256 fingerprint of the certificate used to sign the generated artifact. # Corresponds to the JSON property `certificateFingerprint` # @return [String] attr_accessor :certificate_fingerprint - # The download URL generated for the uploaded artifact. - # Users that are authorized to download can follow the link to the Play - # Store app to install it. + # The download URL generated for the uploaded artifact. Users that are + # authorized to download can follow the link to the Play Store app to install it. # Corresponds to the JSON property `downloadUrl` # @return [String] attr_accessor :download_url - # The sha256 hash of the artifact represented as a lowercase hexadecimal - # number, matching the output of the sha256sum command. + # The sha256 hash of the artifact represented as a lowercase hexadecimal number, + # matching the output of the sha256sum command. # Corresponds to the JSON property `sha256` # @return [String] attr_accessor :sha256 @@ -953,18 +944,17 @@ module Google class IntroductoryPriceInfo include Google::Apis::Core::Hashable - # Introductory price of the subscription, not including tax. - # The currency is the same as price_currency_code. Price is - # expressed in micro-units, where 1,000,000 micro-units represents one unit - # of the currency. For example, if the subscription price is €1.99, - # price_amount_micros is 1990000. + # Introductory price of the subscription, not including tax. The currency is the + # same as price_currency_code. Price is expressed in micro-units, where 1,000, + # 000 micro-units represents one unit of the currency. For example, if the + # subscription price is €1.99, price_amount_micros is 1990000. # Corresponds to the JSON property `introductoryPriceAmountMicros` # @return [Fixnum] attr_accessor :introductory_price_amount_micros - # ISO 4217 currency code for the introductory subscription price. - # For example, if the price is specified in British pounds sterling, - # price_currency_code is "GBP". + # ISO 4217 currency code for the introductory subscription price. For example, + # if the price is specified in British pounds sterling, price_currency_code is " + # GBP". # Corresponds to the JSON property `introductoryPriceCurrencyCode` # @return [String] attr_accessor :introductory_price_currency_code @@ -974,10 +964,9 @@ module Google # @return [Fixnum] attr_accessor :introductory_price_cycles - # Introductory price period, specified in ISO 8601 format. - # Common values are (but not limited to) "P1W" (one - # week), "P1M" (one month), "P3M" (three months), "P6M" (six months), - # and "P1Y" (one year). + # Introductory price period, specified in ISO 8601 format. Common values are ( + # but not limited to) "P1W" (one week), "P1M" (one month), "P3M" (three months), + # "P6M" (six months), and "P1Y" (one year). # Corresponds to the JSON property `introductoryPricePeriod` # @return [String] attr_accessor :introductory_price_period @@ -1004,8 +993,8 @@ module Google # @return [String] attr_accessor :full_description - # Language localization code (a BCP-47 language tag; for example, "de-AT" - # for Austrian German). + # Language localization code (a BCP-47 language tag; for example, "de-AT" for + # Austrian German). # Corresponds to the JSON property `language` # @return [String] attr_accessor :language @@ -1068,8 +1057,8 @@ module Google class LocalizedText include Google::Apis::Core::Hashable - # Language localization code (a BCP-47 language tag; for example, "de-AT" - # for Austrian German). + # Language localization code (a BCP-47 language tag; for example, "de-AT" for + # Austrian German). # Corresponds to the JSON property `language` # @return [String] attr_accessor :language @@ -1090,14 +1079,14 @@ module Google end end - # Information about the current page. - # List operations that supports paging return only one "page" of results. This - # protocol buffer message describes the page that has been returned. + # Information about the current page. List operations that supports paging + # return only one "page" of results. This protocol buffer message describes the + # page that has been returned. class PageInfo include Google::Apis::Core::Hashable - # Maximum number of results returned in one page. - # ! The number of results included in the API response. + # Maximum number of results returned in one page. ! The number of results + # included in the API response. # Corresponds to the JSON property `resultPerPage` # @return [Fixnum] attr_accessor :result_per_page @@ -1107,8 +1096,8 @@ module Google # @return [Fixnum] attr_accessor :start_index - # Total number of results available on the backend - # ! The total number of results in the result set. + # Total number of results available on the backend ! The total number of results + # in the result set. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results @@ -1129,8 +1118,8 @@ module Google class Price include Google::Apis::Core::Hashable - # 3 letter Currency code, as defined by ISO 4217. - # See java/com/google/common/money/CurrencyCode.java + # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/ + # money/CurrencyCode.java # Corresponds to the JSON property `currency` # @return [String] attr_accessor :currency @@ -1151,51 +1140,46 @@ module Google end end - # A ProductPurchase resource indicates the status of a user's inapp - # product purchase. + # A ProductPurchase resource indicates the status of a user's inapp product + # purchase. class ProductPurchase include Google::Apis::Core::Hashable - # The acknowledgement state of the inapp product. Possible values are: - # 0. Yet to be acknowledged - # 1. Acknowledged + # The acknowledgement state of the inapp product. Possible values are: 0. Yet to + # be acknowledged 1. Acknowledged # Corresponds to the JSON property `acknowledgementState` # @return [Fixnum] attr_accessor :acknowledgement_state - # The consumption state of the inapp product. Possible values are: - # 0. Yet to be consumed - # 1. Consumed + # The consumption state of the inapp product. Possible values are: 0. Yet to be + # consumed 1. Consumed # Corresponds to the JSON property `consumptionState` # @return [Fixnum] attr_accessor :consumption_state - # A developer-specified string that contains supplemental - # information about an order. + # A developer-specified string that contains supplemental information about an + # order. # Corresponds to the JSON property `developerPayload` # @return [String] attr_accessor :developer_payload - # This kind represents an inappPurchase object in the androidpublisher - # service. + # This kind represents an inappPurchase object in the androidpublisher service. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # An obfuscated version of the id that is uniquely associated with the - # user's account in your app. Only present if specified using - # https://developer.android.com/reference/com/android/billingclient/api/ - # BillingFlowParams.Builder#setobfuscatedaccountid - # when the purchase was made. + # An obfuscated version of the id that is uniquely associated with the user's + # account in your app. Only present if specified using https://developer.android. + # com/reference/com/android/billingclient/api/BillingFlowParams.Builder# + # setobfuscatedaccountid when the purchase was made. # Corresponds to the JSON property `obfuscatedExternalAccountId` # @return [String] attr_accessor :obfuscated_external_account_id - # An obfuscated version of the id that is uniquely associated with the - # user's profile in your app. Only present if specified using - # https://developer.android.com/reference/com/android/billingclient/api/ - # BillingFlowParams.Builder#setobfuscatedprofileid - # when the purchase was made. + # An obfuscated version of the id that is uniquely associated with the user's + # profile in your app. Only present if specified using https://developer.android. + # com/reference/com/android/billingclient/api/BillingFlowParams.Builder# + # setobfuscatedprofileid when the purchase was made. # Corresponds to the JSON property `obfuscatedExternalProfileId` # @return [String] attr_accessor :obfuscated_external_profile_id @@ -1210,16 +1194,14 @@ module Google # @return [String] attr_accessor :product_id - # The purchase state of the order. Possible values are: - # 0. Purchased - # 1. Canceled + # The purchase state of the order. Possible values are: 0. Purchased 1. Canceled # 2. Pending # Corresponds to the JSON property `purchaseState` # @return [Fixnum] attr_accessor :purchase_state - # The time the product was purchased, in milliseconds since the - # epoch (Jan 1, 1970). + # The time the product was purchased, in milliseconds since the epoch (Jan 1, + # 1970). # Corresponds to the JSON property `purchaseTimeMillis` # @return [Fixnum] attr_accessor :purchase_time_millis @@ -1229,12 +1211,11 @@ module Google # @return [String] attr_accessor :purchase_token - # The type of purchase of the inapp product. This field is only set if - # this purchase was not made using the standard in-app billing flow. - # Possible values are: - # 0. Test (i.e. purchased from a license testing account) - # 1. Promo (i.e. purchased using a promo code) - # 2. Rewarded (i.e. from watching a video ad instead of paying) + # The type of purchase of the inapp product. This field is only set if this + # purchase was not made using the standard in-app billing flow. Possible values + # are: 0. Test (i.e. purchased from a license testing account) 1. Promo (i.e. + # purchased using a promo code) 2. Rewarded (i.e. from watching a video ad + # instead of paying) # Corresponds to the JSON property `purchaseType` # @return [Fixnum] attr_accessor :purchase_type @@ -1321,9 +1302,9 @@ module Google include Google::Apis::Core::Hashable # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at - # nanosecond resolution. The count is relative to an epoch at UTC midnight on - # January 1, 1970. + # calendar, encoded as a count of seconds and fractions of seconds at nanosecond + # resolution. The count is relative to an epoch at UTC midnight on January 1, + # 1970. # Corresponds to the JSON property `lastEdited` # @return [Google::Apis::AndroidpublisherV3::Timestamp] attr_accessor :last_edited @@ -1348,9 +1329,9 @@ module Google class ReviewsListResponse include Google::Apis::Core::Hashable - # Information about the current page. - # List operations that supports paging return only one "page" of results. This - # protocol buffer message describes the page that has been returned. + # Information about the current page. List operations that supports paging + # return only one "page" of results. This protocol buffer message describes the + # page that has been returned. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::AndroidpublisherV3::PageInfo] attr_accessor :page_info @@ -1360,15 +1341,14 @@ module Google # @return [Array] attr_accessor :reviews - # Pagination information returned by a List operation when token pagination - # is enabled. - # List operations that supports paging return only one "page" of results. This - # protocol buffer message describes the page that has been returned. - # When using token pagination, clients should use the next/previous token - # to get another page of the result. The presence or absence of next/previous - # token indicates whether a next/previous page is available and provides a - # mean of accessing this page. ListRequest.page_token should be set to either - # next_page_token or previous_page_token to access another page. + # Pagination information returned by a List operation when token pagination is + # enabled. List operations that supports paging return only one "page" of + # results. This protocol buffer message describes the page that has been + # returned. When using token pagination, clients should use the next/previous + # token to get another page of the result. The presence or absence of next/ + # previous token indicates whether a next/previous page is available and + # provides a mean of accessing this page. ListRequest.page_token should be set + # to either next_page_token or previous_page_token to access another page. # Corresponds to the JSON property `tokenPagination` # @return [Google::Apis::AndroidpublisherV3::TokenPagination] attr_accessor :token_pagination @@ -1429,13 +1409,9 @@ module Google class SubscriptionCancelSurveyResult include Google::Apis::Core::Hashable - # The cancellation reason the user chose in the survey. - # Possible values are: - # 0. Other - # 1. I don't use this service enough - # 2. Technical issues - # 3. Cost-related reasons - # 4. I found a better app + # The cancellation reason the user chose in the survey. Possible values are: 0. + # Other 1. I don't use this service enough 2. Technical issues 3. Cost-related + # reasons 4. I found a better app # Corresponds to the JSON property `cancelSurveyReason` # @return [Fixnum] attr_accessor :cancel_survey_reason @@ -1457,21 +1433,20 @@ module Google end end - # A SubscriptionDeferralInfo contains the data needed to defer a - # subscription purchase to a future expiry time. + # A SubscriptionDeferralInfo contains the data needed to defer a subscription + # purchase to a future expiry time. class SubscriptionDeferralInfo include Google::Apis::Core::Hashable - # The desired next expiry time to assign to the subscription, in - # milliseconds since the Epoch. The given time must be later/greater - # than the current expiry time for the subscription. + # The desired next expiry time to assign to the subscription, in milliseconds + # since the Epoch. The given time must be later/greater than the current expiry + # time for the subscription. # Corresponds to the JSON property `desiredExpiryTimeMillis` # @return [Fixnum] attr_accessor :desired_expiry_time_millis - # The expected expiry time for the subscription. If the current - # expiry time for the subscription is not the value specified - # here, the deferral will not occur. + # The expected expiry time for the subscription. If the current expiry time for + # the subscription is not the value specified here, the deferral will not occur. # Corresponds to the JSON property `expectedExpiryTimeMillis` # @return [Fixnum] attr_accessor :expected_expiry_time_millis @@ -1499,14 +1474,13 @@ module Google # @return [Google::Apis::AndroidpublisherV3::Price] attr_accessor :new_price - # The current state of the price change. Possible values are: - # 0. Outstanding: State for a pending price change waiting for the user to - # agree. In this state, you can optionally seek confirmation from the - # user using the In-App API. - # 1. Accepted: State for an accepted price change that the subscription - # will renew with unless it's canceled. The price change takes effect on - # a future date when the subscription renews. Note that the change might - # not occur when the subscription is renewed next. + # The current state of the price change. Possible values are: 0. Outstanding: + # State for a pending price change waiting for the user to agree. In this state, + # you can optionally seek confirmation from the user using the In-App API. 1. + # Accepted: State for an accepted price change that the subscription will renew + # with unless it's canceled. The price change takes effect on a future date when + # the subscription renews. Note that the change might not occur when the + # subscription is renewed next. # Corresponds to the JSON property `state` # @return [Fixnum] attr_accessor :state @@ -1522,40 +1496,35 @@ module Google end end - # A SubscriptionPurchase resource indicates the status of a user's - # subscription purchase. + # A SubscriptionPurchase resource indicates the status of a user's subscription + # purchase. class SubscriptionPurchase include Google::Apis::Core::Hashable - # The acknowledgement state of the subscription product. Possible values - # are: - # 0. Yet to be acknowledged - # 1. Acknowledged + # The acknowledgement state of the subscription product. Possible values are: 0. + # Yet to be acknowledged 1. Acknowledged # Corresponds to the JSON property `acknowledgementState` # @return [Fixnum] attr_accessor :acknowledgement_state - # Whether the subscription will automatically be renewed when it - # reaches its current expiry time. + # Whether the subscription will automatically be renewed when it reaches its + # current expiry time. # Corresponds to the JSON property `autoRenewing` # @return [Boolean] attr_accessor :auto_renewing alias_method :auto_renewing?, :auto_renewing - # Time at which the subscription will be automatically resumed, in - # milliseconds since the Epoch. Only present if the user has requested to - # pause the subscription. + # Time at which the subscription will be automatically resumed, in milliseconds + # since the Epoch. Only present if the user has requested to pause the + # subscription. # Corresponds to the JSON property `autoResumeTimeMillis` # @return [Fixnum] attr_accessor :auto_resume_time_millis - # The reason why a subscription was canceled or is not auto-renewing. - # Possible values are: - # 0. User canceled the subscription - # 1. Subscription was canceled by the system, - # for example because of a billing problem - # 2. Subscription was replaced with a new subscription - # 3. Subscription was canceled by the developer + # The reason why a subscription was canceled or is not auto-renewing. Possible + # values are: 0. User canceled the subscription 1. Subscription was canceled by + # the system, for example because of a billing problem 2. Subscription was + # replaced with a new subscription 3. Subscription was canceled by the developer # Corresponds to the JSON property `cancelReason` # @return [Fixnum] attr_accessor :cancel_reason @@ -1566,45 +1535,43 @@ module Google # @return [Google::Apis::AndroidpublisherV3::SubscriptionCancelSurveyResult] attr_accessor :cancel_survey_result - # ISO 3166-1 alpha-2 billing country/region code of the user at the time - # the subscription was granted. + # ISO 3166-1 alpha-2 billing country/region code of the user at the time the + # subscription was granted. # Corresponds to the JSON property `countryCode` # @return [String] attr_accessor :country_code - # A developer-specified string that contains supplemental - # information about an order. + # A developer-specified string that contains supplemental information about an + # order. # Corresponds to the JSON property `developerPayload` # @return [String] attr_accessor :developer_payload - # The email address of the user when the subscription was purchased. - # Only present for purchases made with 'Subscribe with Google'. + # The email address of the user when the subscription was purchased. Only + # present for purchases made with 'Subscribe with Google'. # Corresponds to the JSON property `emailAddress` # @return [String] attr_accessor :email_address - # Time at which the subscription will expire, in milliseconds - # since the Epoch. + # Time at which the subscription will expire, in milliseconds since the Epoch. # Corresponds to the JSON property `expiryTimeMillis` # @return [Fixnum] attr_accessor :expiry_time_millis - # User account identifier in the third-party service. - # Only present if account linking happened as part of the subscription - # purchase flow. + # User account identifier in the third-party service. Only present if account + # linking happened as part of the subscription purchase flow. # Corresponds to the JSON property `externalAccountId` # @return [String] attr_accessor :external_account_id - # The family name of the user when the subscription was purchased. - # Only present for purchases made with 'Subscribe with Google'. + # The family name of the user when the subscription was purchased. Only present + # for purchases made with 'Subscribe with Google'. # Corresponds to the JSON property `familyName` # @return [String] attr_accessor :family_name - # The given name of the user when the subscription was purchased. - # Only present for purchases made with 'Subscribe with Google'. + # The given name of the user when the subscription was purchased. Only present + # for purchases made with 'Subscribe with Google'. # Corresponds to the JSON property `givenName` # @return [String] attr_accessor :given_name @@ -1620,61 +1587,52 @@ module Google # @return [String] attr_accessor :kind - # The purchase token of the originating purchase if this subscription - # is one of the following: - # 0. Re-signup of a canceled but non-lapsed subscription - # 1. Upgrade/downgrade from a previous subscription - # For example, suppose a user originally signs up and you receive - # purchase token X, then the user cancels and goes through the - # resignup flow (before their subscription lapses) and you receive - # purchase token Y, and finally the user upgrades their subscription - # and you receive purchase token Z. If you call this API with purchase - # token Z, this field will be set to Y. If you call this API with - # purchase token Y, this field will be set to X. If you call this API - # with purchase token X, this field will not be set. + # The purchase token of the originating purchase if this subscription is one of + # the following: 0. Re-signup of a canceled but non-lapsed subscription 1. + # Upgrade/downgrade from a previous subscription For example, suppose a user + # originally signs up and you receive purchase token X, then the user cancels + # and goes through the resignup flow (before their subscription lapses) and you + # receive purchase token Y, and finally the user upgrades their subscription and + # you receive purchase token Z. If you call this API with purchase token Z, this + # field will be set to Y. If you call this API with purchase token Y, this field + # will be set to X. If you call this API with purchase token X, this field will + # not be set. # Corresponds to the JSON property `linkedPurchaseToken` # @return [String] attr_accessor :linked_purchase_token - # An obfuscated version of the id that is uniquely associated with the - # user's account in your app. Present for the following purchases: - # * If account linking happened as part of the subscription purchase flow. - # * It was specified using + # An obfuscated version of the id that is uniquely associated with the user's + # account in your app. Present for the following purchases: * If account linking + # happened as part of the subscription purchase flow. * It was specified using # https://developer.android.com/reference/com/android/billingclient/api/ - # BillingFlowParams.Builder#setobfuscatedaccountid - # when the purchase was made. + # BillingFlowParams.Builder#setobfuscatedaccountid when the purchase was made. # Corresponds to the JSON property `obfuscatedExternalAccountId` # @return [String] attr_accessor :obfuscated_external_account_id - # An obfuscated version of the id that is uniquely associated with the - # user's profile in your app. Only present if specified using - # https://developer.android.com/reference/com/android/billingclient/api/ - # BillingFlowParams.Builder#setobfuscatedprofileid - # when the purchase was made. + # An obfuscated version of the id that is uniquely associated with the user's + # profile in your app. Only present if specified using https://developer.android. + # com/reference/com/android/billingclient/api/BillingFlowParams.Builder# + # setobfuscatedprofileid when the purchase was made. # Corresponds to the JSON property `obfuscatedExternalProfileId` # @return [String] attr_accessor :obfuscated_external_profile_id - # The order id of the latest recurring order associated with - # the purchase of the subscription. + # The order id of the latest recurring order associated with the purchase of the + # subscription. # Corresponds to the JSON property `orderId` # @return [String] attr_accessor :order_id - # The payment state of the subscription. Possible values are: - # 0. Payment pending - # 1. Payment received - # 2. Free trial - # 3. Pending deferred upgrade/downgrade + # The payment state of the subscription. Possible values are: 0. Payment pending + # 1. Payment received 2. Free trial 3. Pending deferred upgrade/downgrade # Corresponds to the JSON property `paymentState` # @return [Fixnum] attr_accessor :payment_state - # Price of the subscription, not including tax. Price is expressed - # in micro-units, where 1,000,000 micro-units represents one unit of - # the currency. For example, if the subscription price is €1.99, - # price_amount_micros is 1990000. + # Price of the subscription, not including tax. Price is expressed in micro- + # units, where 1,000,000 micro-units represents one unit of the currency. For + # example, if the subscription price is €1.99, price_amount_micros is 1990000. # Corresponds to the JSON property `priceAmountMicros` # @return [Fixnum] attr_accessor :price_amount_micros @@ -1687,57 +1645,52 @@ module Google # @return [Google::Apis::AndroidpublisherV3::SubscriptionPriceChange] attr_accessor :price_change - # ISO 4217 currency code for the subscription price. For example, - # if the price is specified in British pounds sterling, - # price_currency_code is "GBP". + # ISO 4217 currency code for the subscription price. For example, if the price + # is specified in British pounds sterling, price_currency_code is "GBP". # Corresponds to the JSON property `priceCurrencyCode` # @return [String] attr_accessor :price_currency_code - # The Google profile id of the user when the subscription was purchased. - # Only present for purchases made with 'Subscribe with Google'. + # The Google profile id of the user when the subscription was purchased. Only + # present for purchases made with 'Subscribe with Google'. # Corresponds to the JSON property `profileId` # @return [String] attr_accessor :profile_id - # The profile name of the user when the subscription was purchased. - # Only present for purchases made with 'Subscribe with Google'. + # The profile name of the user when the subscription was purchased. Only present + # for purchases made with 'Subscribe with Google'. # Corresponds to the JSON property `profileName` # @return [String] attr_accessor :profile_name - # The promotion code applied on this purchase. This field is only set if - # a vanity code promotion is applied when the subscription was purchased. + # The promotion code applied on this purchase. This field is only set if a + # vanity code promotion is applied when the subscription was purchased. # Corresponds to the JSON property `promotionCode` # @return [String] attr_accessor :promotion_code - # The type of promotion applied on this purchase. This field is only set if - # a promotion is applied when the subscription was purchased. Possible - # values are: - # 0. One time code - # 1. Vanity code + # The type of promotion applied on this purchase. This field is only set if a + # promotion is applied when the subscription was purchased. Possible values are: + # 0. One time code 1. Vanity code # Corresponds to the JSON property `promotionType` # @return [Fixnum] attr_accessor :promotion_type - # The type of purchase of the subscription. This field is only set if - # this purchase was not made using the standard in-app billing flow. - # Possible values are: - # 0. Test (i.e. purchased from a license testing account) - # 1. Promo (i.e. purchased using a promo code) + # The type of purchase of the subscription. This field is only set if this + # purchase was not made using the standard in-app billing flow. Possible values + # are: 0. Test (i.e. purchased from a license testing account) 1. Promo (i.e. + # purchased using a promo code) # Corresponds to the JSON property `purchaseType` # @return [Fixnum] attr_accessor :purchase_type - # Time at which the subscription was granted, in milliseconds - # since the Epoch. + # Time at which the subscription was granted, in milliseconds since the Epoch. # Corresponds to the JSON property `startTimeMillis` # @return [Fixnum] attr_accessor :start_time_millis - # The time at which the subscription was canceled by the user, in - # milliseconds since the epoch. Only present if cancelReason is 0. + # The time at which the subscription was canceled by the user, in milliseconds + # since the epoch. Only present if cancelReason is 0. # Corresponds to the JSON property `userCancellationTimeMillis` # @return [Fixnum] attr_accessor :user_cancellation_time_millis @@ -1803,8 +1756,8 @@ module Google class SubscriptionPurchasesDeferRequest include Google::Apis::Core::Hashable - # A SubscriptionDeferralInfo contains the data needed to defer a - # subscription purchase to a future expiry time. + # A SubscriptionDeferralInfo contains the data needed to defer a subscription + # purchase to a future expiry time. # Corresponds to the JSON property `deferralInfo` # @return [Google::Apis::AndroidpublisherV3::SubscriptionDeferralInfo] attr_accessor :deferral_info @@ -1877,14 +1830,14 @@ module Google end # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at - # nanosecond resolution. The count is relative to an epoch at UTC midnight on - # January 1, 1970. + # calendar, encoded as a count of seconds and fractions of seconds at nanosecond + # resolution. The count is relative to an epoch at UTC midnight on January 1, + # 1970. class Timestamp include Google::Apis::Core::Hashable - # Non-negative fractions of a second at nanosecond resolution. - # Must be from 0 to 999,999,999 inclusive. + # Non-negative fractions of a second at nanosecond resolution. Must be from 0 to + # 999,999,999 inclusive. # Corresponds to the JSON property `nanos` # @return [Fixnum] attr_accessor :nanos @@ -1905,15 +1858,14 @@ module Google end end - # Pagination information returned by a List operation when token pagination - # is enabled. - # List operations that supports paging return only one "page" of results. This - # protocol buffer message describes the page that has been returned. - # When using token pagination, clients should use the next/previous token - # to get another page of the result. The presence or absence of next/previous - # token indicates whether a next/previous page is available and provides a - # mean of accessing this page. ListRequest.page_token should be set to either - # next_page_token or previous_page_token to access another page. + # Pagination information returned by a List operation when token pagination is + # enabled. List operations that supports paging return only one "page" of + # results. This protocol buffer message describes the page that has been + # returned. When using token pagination, clients should use the next/previous + # token to get another page of the result. The presence or absence of next/ + # previous token indicates whether a next/previous page is available and + # provides a mean of accessing this page. ListRequest.page_token should be set + # to either next_page_token or previous_page_token to access another page. class TokenPagination include Google::Apis::Core::Hashable @@ -1943,8 +1895,8 @@ module Google class Track include Google::Apis::Core::Hashable - # In a read request, represents all active releases in the track. - # In an update request, represents desired changes. + # In a read request, represents all active releases in the track. In an update + # request, represents desired changes. # Corresponds to the JSON property `releases` # @return [Array] attr_accessor :releases @@ -1974,18 +1926,18 @@ module Google # @return [Google::Apis::AndroidpublisherV3::CountryTargeting] attr_accessor :country_targeting - # In-app update priority of the release. All newly added APKs in the - # release will be considered at this priority. Can take values in the range - # [0, 5], with 5 the highest priority. Defaults to 0. - # in_app_update_priority can not be updated once the release is rolled out. - # See https://developer.android.com/guide/playcore/in-app-updates. + # In-app update priority of the release. All newly added APKs in the release + # will be considered at this priority. Can take values in the range [0, 5], with + # 5 the highest priority. Defaults to 0. in_app_update_priority can not be + # updated once the release is rolled out. See https://developer.android.com/ + # guide/playcore/in-app-updates. # Corresponds to the JSON property `inAppUpdatePriority` # @return [Fixnum] attr_accessor :in_app_update_priority - # The release name. Not required to be unique. If not set, the name is - # generated from the APK's version_name. If the release contains multiple - # APKs, the name is generated from the date. + # The release name. Not required to be unique. If not set, the name is generated + # from the APK's version_name. If the release contains multiple APKs, the name + # is generated from the date. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2000,14 +1952,14 @@ module Google # @return [String] attr_accessor :status - # Fraction of users who are eligible for a staged release. 0 < fraction < 1. - # Can only be set when status is "inProgress" or "halted". + # Fraction of users who are eligible for a staged release. 0 < fraction < 1. Can + # only be set when status is "inProgress" or "halted". # Corresponds to the JSON property `userFraction` # @return [Float] attr_accessor :user_fraction - # Version codes of all APKs in the release. Must include version codes to - # retain from previous releases. + # Version codes of all APKs in the release. Must include version codes to retain + # from previous releases. # Corresponds to the JSON property `versionCodes` # @return [Array] attr_accessor :version_codes @@ -2057,20 +2009,20 @@ module Google class UserComment include Google::Apis::Core::Hashable - # Integer Android SDK version of the user's device at the time the - # review was written, e.g. 23 is Marshmallow. May be absent. + # Integer Android SDK version of the user's device at the time the review was + # written, e.g. 23 is Marshmallow. May be absent. # Corresponds to the JSON property `androidOsVersion` # @return [Fixnum] attr_accessor :android_os_version - # Integer version code of the app as installed at the time the - # review was written. May be absent. + # Integer version code of the app as installed at the time the review was + # written. May be absent. # Corresponds to the JSON property `appVersionCode` # @return [Fixnum] attr_accessor :app_version_code - # String version name of the app as installed at the time the - # review was written. May be absent. + # String version name of the app as installed at the time the review was written. + # May be absent. # Corresponds to the JSON property `appVersionName` # @return [String] attr_accessor :app_version_name @@ -2086,22 +2038,21 @@ module Google attr_accessor :device_metadata # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at - # nanosecond resolution. The count is relative to an epoch at UTC midnight on - # January 1, 1970. + # calendar, encoded as a count of seconds and fractions of seconds at nanosecond + # resolution. The count is relative to an epoch at UTC midnight on January 1, + # 1970. # Corresponds to the JSON property `lastModified` # @return [Google::Apis::AndroidpublisherV3::Timestamp] attr_accessor :last_modified - # Untranslated text of the review, where the review was translated. - # If the review was not translated this is left blank. + # Untranslated text of the review, where the review was translated. If the + # review was not translated this is left blank. # Corresponds to the JSON property `originalText` # @return [String] attr_accessor :original_text - # Language code for the reviewer. This is taken from the device - # settings so is not guaranteed to match the language the review - # is written in. May be absent. + # Language code for the reviewer. This is taken from the device settings so is + # not guaranteed to match the language the review is written in. May be absent. # Corresponds to the JSON property `reviewerLanguage` # @return [String] attr_accessor :reviewer_language @@ -2111,10 +2062,9 @@ module Google # @return [Fixnum] attr_accessor :star_rating - # The content of the comment, i.e. review body. In some cases - # users have been able to write a review with separate title and - # body; in those cases the title and body are concatenated and - # separated by a tab character. + # The content of the comment, i.e. review body. In some cases users have been + # able to write a review with separate title and body; in those cases the title + # and body are concatenated and separated by a tab character. # Corresponds to the JSON property `text` # @return [String] attr_accessor :text @@ -2154,8 +2104,7 @@ module Google class UsesPermission include Google::Apis::Core::Hashable - # Optionally, the maximum SDK version for which the permission is - # required. + # Optionally, the maximum SDK version for which the permission is required. # Corresponds to the JSON property `maxSdkVersion` # @return [Fixnum] attr_accessor :max_sdk_version @@ -2202,13 +2151,12 @@ module Google end end - # A VoidedPurchase resource indicates a purchase that was either - # canceled/refunded/charged-back. + # A VoidedPurchase resource indicates a purchase that was either canceled/ + # refunded/charged-back. class VoidedPurchase include Google::Apis::Core::Hashable - # This kind represents a voided purchase object in the androidpublisher - # service. + # This kind represents a voided purchase object in the androidpublisher service. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2219,42 +2167,34 @@ module Google # @return [String] attr_accessor :order_id - # The time at which the purchase was made, in milliseconds since the - # epoch (Jan 1, 1970). + # The time at which the purchase was made, in milliseconds since the epoch (Jan + # 1, 1970). # Corresponds to the JSON property `purchaseTimeMillis` # @return [Fixnum] attr_accessor :purchase_time_millis - # The token which uniquely identifies a one-time purchase or subscription. - # To uniquely identify subscription renewals use order_id (available - # starting from version 3 of the API). + # The token which uniquely identifies a one-time purchase or subscription. To + # uniquely identify subscription renewals use order_id (available starting from + # version 3 of the API). # Corresponds to the JSON property `purchaseToken` # @return [String] attr_accessor :purchase_token - # The reason why the purchase was voided, possible values are: - # 0. Other - # 1. Remorse - # 2. Not_received - # 3. Defective - # 4. Accidental_purchase - # 5. Fraud - # 6. Friendly_fraud - # 7. Chargeback + # The reason why the purchase was voided, possible values are: 0. Other 1. + # Remorse 2. Not_received 3. Defective 4. Accidental_purchase 5. Fraud 6. + # Friendly_fraud 7. Chargeback # Corresponds to the JSON property `voidedReason` # @return [Fixnum] attr_accessor :voided_reason - # The initiator of voided purchase, possible values are: - # 0. User - # 1. Developer - # 2. Google + # The initiator of voided purchase, possible values are: 0. User 1. Developer 2. + # Google # Corresponds to the JSON property `voidedSource` # @return [Fixnum] attr_accessor :voided_source - # The time at which the purchase was canceled/refunded/charged-back, - # in milliseconds since the epoch (Jan 1, 1970). + # The time at which the purchase was canceled/refunded/charged-back, in + # milliseconds since the epoch (Jan 1, 1970). # Corresponds to the JSON property `voidedTimeMillis` # @return [Fixnum] attr_accessor :voided_time_millis @@ -2279,22 +2219,21 @@ module Google class VoidedPurchasesListResponse include Google::Apis::Core::Hashable - # Information about the current page. - # List operations that supports paging return only one "page" of results. This - # protocol buffer message describes the page that has been returned. + # Information about the current page. List operations that supports paging + # return only one "page" of results. This protocol buffer message describes the + # page that has been returned. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::AndroidpublisherV3::PageInfo] attr_accessor :page_info - # Pagination information returned by a List operation when token pagination - # is enabled. - # List operations that supports paging return only one "page" of results. This - # protocol buffer message describes the page that has been returned. - # When using token pagination, clients should use the next/previous token - # to get another page of the result. The presence or absence of next/previous - # token indicates whether a next/previous page is available and provides a - # mean of accessing this page. ListRequest.page_token should be set to either - # next_page_token or previous_page_token to access another page. + # Pagination information returned by a List operation when token pagination is + # enabled. List operations that supports paging return only one "page" of + # results. This protocol buffer message describes the page that has been + # returned. When using token pagination, clients should use the next/previous + # token to get another page of the result. The presence or absence of next/ + # previous token indicates whether a next/previous page is available and + # provides a mean of accessing this page. ListRequest.page_token should be set + # to either next_page_token or previous_page_token to access another page. # Corresponds to the JSON property `tokenPagination` # @return [Google::Apis::AndroidpublisherV3::TokenPagination] attr_accessor :token_pagination diff --git a/generated/google/apis/androidpublisher_v3/service.rb b/generated/google/apis/androidpublisher_v3/service.rb index 5c790a2b7..2e9c73b65 100644 --- a/generated/google/apis/androidpublisher_v3/service.rb +++ b/generated/google/apis/androidpublisher_v3/service.rb @@ -212,8 +212,8 @@ module Google # Creates a new APK without uploading the APK itself to Google Play, instead # hosting the APK at a specified URL. This function is only available to - # organizations using Managed Play whose application is configured to - # restrict distribution to the organizations. + # organizations using Managed Play whose application is configured to restrict + # distribution to the organizations. # @param [String] package_name # Package name of the app. # @param [String] edit_id @@ -358,22 +358,19 @@ module Google execute_or_queue_command(command, &block) end - # Uploads a new Android App Bundle to this edit. - # If you are using the Google API client libraries, please increase the - # timeout of the http request before calling this endpoint - # (a timeout of 2 minutes is recommended). - # See [Timeouts and - # Errors](https://developers.google.com/api-client-library/java/google-api-java- - # client/errors) - # for an example in java. + # Uploads a new Android App Bundle to this edit. If you are using the Google API + # client libraries, please increase the timeout of the http request before + # calling this endpoint (a timeout of 2 minutes is recommended). See [Timeouts + # and Errors](https://developers.google.com/api-client-library/java/google-api- + # java-client/errors) for an example in java. # @param [String] package_name # Package name of the app. # @param [String] edit_id # Identifier of the edit. # @param [Boolean] ack_bundle_installation_warning - # Must be set to true if the bundle installation may trigger a warning on - # user devices (for example, if installation size may be over a threshold, - # typically 100 MB). + # Must be set to true if the bundle installation may trigger a warning on user + # devices (for example, if installation size may be over a threshold, typically + # 100 MB). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -419,8 +416,7 @@ module Google # @param [String] edit_id # Unique identifier for this edit. # @param [Fixnum] apk_version_code - # The version code of the APK whose Deobfuscation File is being - # uploaded. + # The version code of the APK whose Deobfuscation File is being uploaded. # @param [String] deobfuscation_file_type # The type of the deobfuscation file. # @param [String] fields @@ -574,8 +570,8 @@ module Google # @param [String] edit_id # Identifier of the edit. # @param [Fixnum] apk_version_code - # The version code of the APK whose expansion file configuration is being - # read or modified. + # The version code of the APK whose expansion file configuration is being read + # or modified. # @param [String] expansion_file_type # The file type of the file configuration which is being read or modified. # @param [String] fields @@ -609,15 +605,14 @@ module Google end # Patches the APK's expansion file configuration to reference another APK's - # expansion file. - # To add a new expansion file use the Upload method. + # expansion file. To add a new expansion file use the Upload method. # @param [String] package_name # Package name of the app. # @param [String] edit_id # Identifier of the edit. # @param [Fixnum] apk_version_code - # The version code of the APK whose expansion file configuration is being - # read or modified. + # The version code of the APK whose expansion file configuration is being read + # or modified. # @param [String] expansion_file_type # The file type of the expansion file configuration which is being updated. # @param [Google::Apis::AndroidpublisherV3::ExpansionFile] expansion_file_object @@ -654,15 +649,14 @@ module Google end # Updates the APK's expansion file configuration to reference another APK's - # expansion file. - # To add a new expansion file use the Upload method. + # expansion file. To add a new expansion file use the Upload method. # @param [String] package_name # Package name of the app. # @param [String] edit_id # Identifier of the edit. # @param [Fixnum] apk_version_code - # The version code of the APK whose expansion file configuration is being - # read or modified. + # The version code of the APK whose expansion file configuration is being read + # or modified. # @param [String] expansion_file_type # The file type of the file configuration which is being read or modified. # @param [Google::Apis::AndroidpublisherV3::ExpansionFile] expansion_file_object @@ -704,8 +698,8 @@ module Google # @param [String] edit_id # Identifier of the edit. # @param [Fixnum] apk_version_code - # The version code of the APK whose expansion file configuration is being - # read or modified. + # The version code of the APK whose expansion file configuration is being read + # or modified. # @param [String] expansion_file_type # The file type of the expansion file configuration which is being updated. # @param [String] fields @@ -754,8 +748,8 @@ module Google # @param [String] edit_id # Identifier of the edit. # @param [String] language - # Language localization code (a BCP-47 language tag; for example, "de-AT" - # for Austrian German). + # Language localization code (a BCP-47 language tag; for example, "de-AT" for + # Austrian German). # @param [String] image_type # Type of the Image. # @param [String] image_id @@ -789,19 +783,18 @@ module Google execute_or_queue_command(command, &block) end - # Deletes all images for the specified language and image type. - # Returns an empty response if no images are found. + # Deletes all images for the specified language and image type. Returns an empty + # response if no images are found. # @param [String] package_name # Package name of the app. # @param [String] edit_id # Identifier of the edit. # @param [String] language - # Language localization code (a BCP-47 language tag; for example, "de-AT" - # for Austrian German). - # Providing a language that is not supported by the App is a no-op. + # Language localization code (a BCP-47 language tag; for example, "de-AT" for + # Austrian German). Providing a language that is not supported by the App is a + # no-op. # @param [String] image_type - # Type of the Image. - # Providing an image type that refers to no images is a no-op. + # Type of the Image. Providing an image type that refers to no images is a no-op. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -838,9 +831,8 @@ module Google # @param [String] edit_id # Identifier of the edit. # @param [String] language - # Language localization code (a BCP-47 language tag; for example, "de-AT" - # for Austrian German). - # There must be a store listing for the specified language. + # Language localization code (a BCP-47 language tag; for example, "de-AT" for + # Austrian German). There must be a store listing for the specified language. # @param [String] image_type # Type of the Image. Providing an image type that refers to no images will # return an empty response. @@ -881,9 +873,9 @@ module Google # @param [String] edit_id # Identifier of the edit. # @param [String] language - # Language localization code (a BCP-47 language tag; for example, "de-AT" - # for Austrian German). - # Providing a language that is not supported by the App is a no-op. + # Language localization code (a BCP-47 language tag; for example, "de-AT" for + # Austrian German). Providing a language that is not supported by the App is a + # no-op. # @param [String] image_type # Type of the Image. # @param [String] fields @@ -932,8 +924,8 @@ module Google # @param [String] edit_id # Identifier of the edit. # @param [String] language - # Language localization code (a BCP-47 language tag; for example, "de-AT" - # for Austrian German). + # Language localization code (a BCP-47 language tag; for example, "de-AT" for + # Austrian German). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -998,8 +990,8 @@ module Google # @param [String] edit_id # Identifier of the edit. # @param [String] language - # Language localization code (a BCP-47 language tag; for example, "de-AT" - # for Austrian German). + # Language localization code (a BCP-47 language tag; for example, "de-AT" for + # Austrian German). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1068,8 +1060,8 @@ module Google # @param [String] edit_id # Identifier of the edit. # @param [String] language - # Language localization code (a BCP-47 language tag; for example, "de-AT" - # for Austrian German). + # Language localization code (a BCP-47 language tag; for example, "de-AT" for + # Austrian German). # @param [Google::Apis::AndroidpublisherV3::Listing] listing_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1108,8 +1100,8 @@ module Google # @param [String] edit_id # Identifier of the edit. # @param [String] language - # Language localization code (a BCP-47 language tag; for example, "de-AT" - # for Austrian German). + # Language localization code (a BCP-47 language tag; for example, "de-AT" for + # Austrian German). # @param [Google::Apis::AndroidpublisherV3::Listing] listing_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1472,9 +1464,9 @@ module Google # Package name of the app. # @param [Google::Apis::AndroidpublisherV3::InAppProduct] in_app_product_object # @param [Boolean] auto_convert_missing_prices - # If true the prices for all regions targeted by the parent app that don't - # have a price specified for this in-app product will be auto converted to - # the target currency based on the default price. Defaults to false. + # If true the prices for all regions targeted by the parent app that don't have + # a price specified for this in-app product will be auto converted to the target + # currency based on the default price. Defaults to false. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1551,9 +1543,9 @@ module Google # Unique identifier for the in-app product. # @param [Google::Apis::AndroidpublisherV3::InAppProduct] in_app_product_object # @param [Boolean] auto_convert_missing_prices - # If true the prices for all regions targeted by the parent app that don't - # have a price specified for this in-app product will be auto converted to - # the target currency based on the default price. Defaults to false. + # If true the prices for all regions targeted by the parent app that don't have + # a price specified for this in-app product will be auto converted to the target + # currency based on the default price. Defaults to false. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1592,9 +1584,9 @@ module Google # Unique identifier for the in-app product. # @param [Google::Apis::AndroidpublisherV3::InAppProduct] in_app_product_object # @param [Boolean] auto_convert_missing_prices - # If true the prices for all regions targeted by the parent app that don't - # have a price specified for this in-app product will be auto converted to - # the target currency based on the default price. Defaults to false. + # If true the prices for all regions targeted by the parent app that don't have + # a price specified for this in-app product will be auto converted to the target + # currency based on the default price. Defaults to false. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1626,14 +1618,11 @@ module Google execute_or_queue_command(command, &block) end - # Uploads an APK to internal app sharing. - # If you are using the Google API client libraries, please increase the - # timeout of the http request before calling this endpoint - # (a timeout of 2 minutes is recommended). - # See [Timeouts and - # Errors](https://developers.google.com/api-client-library/java/google-api-java- - # client/errors) - # for an example in java. + # Uploads an APK to internal app sharing. If you are using the Google API client + # libraries, please increase the timeout of the http request before calling this + # endpoint (a timeout of 2 minutes is recommended). See [Timeouts and Errors]( + # https://developers.google.com/api-client-library/java/google-api-java-client/ + # errors) for an example in java. # @param [String] package_name # Package name of the app. # @param [String] fields @@ -1673,14 +1662,11 @@ module Google execute_or_queue_command(command, &block) end - # Uploads an app bundle to internal app sharing. - # If you are using the Google API client libraries, please increase the - # timeout of the http request before calling this endpoint - # (a timeout of 2 minutes is recommended). - # See [Timeouts and - # Errors](https://developers.google.com/api-client-library/java/google-api-java- - # client/errors) - # for an example in java. + # Uploads an app bundle to internal app sharing. If you are using the Google API + # client libraries, please increase the timeout of the http request before + # calling this endpoint (a timeout of 2 minutes is recommended). See [Timeouts + # and Errors](https://developers.google.com/api-client-library/java/google-api- + # java-client/errors) for an example in java. # @param [String] package_name # Package name of the app. # @param [String] fields @@ -1722,16 +1708,16 @@ module Google # Refund a user's subscription or in-app purchase order. # @param [String] package_name - # The package name of the application for which this subscription or in-app - # item was purchased (for example, 'com.some.thing'). + # The package name of the application for which this subscription or in-app item + # was purchased (for example, 'com.some.thing'). # @param [String] order_id # The order ID provided to the user when the subscription or in-app order was # purchased. # @param [Boolean] revoke # Whether to revoke the purchased item. If set to true, access to the - # subscription or in-app item will be terminated immediately. If the item is - # a recurring subscription, all future payments will also be terminated. - # Consumed in-app items need to be handled by developer's app. (optional). + # subscription or in-app item will be terminated immediately. If the item is a + # recurring subscription, all future payments will also be terminated. Consumed + # in-app items need to be handled by developer's app. (optional). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1761,13 +1747,12 @@ module Google # Acknowledges a purchase of an inapp item. # @param [String] package_name - # The package name of the application the inapp product was sold in (for - # example, 'com.some.thing'). + # The package name of the application the inapp product was sold in (for example, + # 'com.some.thing'). # @param [String] product_id # The inapp product SKU (for example, 'com.some.thing.inapp1'). # @param [String] token - # The token provided to the user's device when the inapp product was - # purchased. + # The token provided to the user's device when the inapp product was purchased. # @param [Google::Apis::AndroidpublisherV3::ProductPurchasesAcknowledgeRequest] product_purchases_acknowledge_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1800,13 +1785,12 @@ module Google # Checks the purchase and consumption status of an inapp item. # @param [String] package_name - # The package name of the application the inapp product was sold in (for - # example, 'com.some.thing'). + # The package name of the application the inapp product was sold in (for example, + # 'com.some.thing'). # @param [String] product_id # The inapp product SKU (for example, 'com.some.thing.inapp1'). # @param [String] token - # The token provided to the user's device when the inapp product was - # purchased. + # The token provided to the user's device when the inapp product was purchased. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1838,13 +1822,12 @@ module Google # Acknowledges a subscription purchase. # @param [String] package_name - # The package name of the application for which this subscription was - # purchased (for example, 'com.some.thing'). + # The package name of the application for which this subscription was purchased ( + # for example, 'com.some.thing'). # @param [String] subscription_id # The purchased subscription ID (for example, 'monthly001'). # @param [String] token - # The token provided to the user's device when the subscription was - # purchased. + # The token provided to the user's device when the subscription was purchased. # @param [Google::Apis::AndroidpublisherV3::SubscriptionPurchasesAcknowledgeRequest] subscription_purchases_acknowledge_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1875,16 +1858,15 @@ module Google execute_or_queue_command(command, &block) end - # Cancels a user's subscription purchase. The subscription remains valid - # until its expiration time. + # Cancels a user's subscription purchase. The subscription remains valid until + # its expiration time. # @param [String] package_name - # The package name of the application for which this subscription was - # purchased (for example, 'com.some.thing'). + # The package name of the application for which this subscription was purchased ( + # for example, 'com.some.thing'). # @param [String] subscription_id # The purchased subscription ID (for example, 'monthly001'). # @param [String] token - # The token provided to the user's device when the subscription was - # purchased. + # The token provided to the user's device when the subscription was purchased. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1912,16 +1894,14 @@ module Google execute_or_queue_command(command, &block) end - # Defers a user's subscription purchase until a specified future expiration - # time. + # Defers a user's subscription purchase until a specified future expiration time. # @param [String] package_name - # The package name of the application for which this subscription was - # purchased (for example, 'com.some.thing'). + # The package name of the application for which this subscription was purchased ( + # for example, 'com.some.thing'). # @param [String] subscription_id # The purchased subscription ID (for example, 'monthly001'). # @param [String] token - # The token provided to the user's device when the subscription was - # purchased. + # The token provided to the user's device when the subscription was purchased. # @param [Google::Apis::AndroidpublisherV3::SubscriptionPurchasesDeferRequest] subscription_purchases_defer_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1954,16 +1934,15 @@ module Google execute_or_queue_command(command, &block) end - # Checks whether a user's subscription purchase is valid and returns its - # expiry time. + # Checks whether a user's subscription purchase is valid and returns its expiry + # time. # @param [String] package_name - # The package name of the application for which this subscription was - # purchased (for example, 'com.some.thing'). + # The package name of the application for which this subscription was purchased ( + # for example, 'com.some.thing'). # @param [String] subscription_id # The purchased subscription ID (for example, 'monthly001'). # @param [String] token - # The token provided to the user's device when the subscription was - # purchased. + # The token provided to the user's device when the subscription was purchased. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1996,13 +1975,12 @@ module Google # Refunds a user's subscription purchase, but the subscription remains valid # until its expiration time and it will continue to recur. # @param [String] package_name - # The package name of the application for which this subscription was - # purchased (for example, 'com.some.thing'). + # The package name of the application for which this subscription was purchased ( + # for example, 'com.some.thing'). # @param [String] subscription_id # "The purchased subscription ID (for example, 'monthly001'). # @param [String] token - # The token provided to the user's device when the subscription was - # purchased. + # The token provided to the user's device when the subscription was purchased. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2030,16 +2008,15 @@ module Google execute_or_queue_command(command, &block) end - # Refunds and immediately revokes a user's subscription purchase. Access to - # the subscription will be terminated immediately and it will stop recurring. + # Refunds and immediately revokes a user's subscription purchase. Access to the + # subscription will be terminated immediately and it will stop recurring. # @param [String] package_name - # The package name of the application for which this subscription was - # purchased (for example, 'com.some.thing'). + # The package name of the application for which this subscription was purchased ( + # for example, 'com.some.thing'). # @param [String] subscription_id # The purchased subscription ID (for example, 'monthly001'). # @param [String] token - # The token provided to the user's device when the subscription was - # purchased. + # The token provided to the user's device when the subscription was purchased. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2072,43 +2049,38 @@ module Google # The package name of the application for which voided purchases need to be # returned (for example, 'com.some.thing'). # @param [Fixnum] end_time - # The time, in milliseconds since the Epoch, of the newest voided purchase - # that you want to see in the response. The value of this parameter cannot - # be greater than the current time and is ignored if a pagination token is - # set. Default value is current time. - # Note: This filter is applied on the time at which the record is seen as - # voided by our systems and not the actual voided time returned in the - # response. + # The time, in milliseconds since the Epoch, of the newest voided purchase that + # you want to see in the response. The value of this parameter cannot be greater + # than the current time and is ignored if a pagination token is set. Default + # value is current time. Note: This filter is applied on the time at which the + # record is seen as voided by our systems and not the actual voided time + # returned in the response. # @param [Fixnum] max_results - # Defines how many results the list operation should return. - # The default number depends on the resource collection. + # Defines how many results the list operation should return. The default number + # depends on the resource collection. # @param [Fixnum] start_index - # Defines the index of the first element to return. - # This can only be used if indexed paging is enabled. + # Defines the index of the first element to return. This can only be used if + # indexed paging is enabled. # @param [Fixnum] start_time - # The time, in milliseconds since the Epoch, of the oldest voided purchase - # that you want to see in the response. The value of this parameter cannot - # be older than 30 days and is ignored if a pagination token is set. - # Default value is current time minus 30 days. - # Note: This filter is applied on the time at which the record is seen as - # voided by our systems and not the actual voided time returned in the - # response. + # The time, in milliseconds since the Epoch, of the oldest voided purchase that + # you want to see in the response. The value of this parameter cannot be older + # than 30 days and is ignored if a pagination token is set. Default value is + # current time minus 30 days. Note: This filter is applied on the time at which + # the record is seen as voided by our systems and not the actual voided time + # returned in the response. # @param [String] token - # Defines the token of the page to return, usually taken from - # TokenPagination. + # Defines the token of the page to return, usually taken from TokenPagination. # This can only be used if token paging is enabled. # @param [Fixnum] type - # The type of voided purchases that you want to see in the response. - # Possible values are: - # 0. Only voided in-app product purchases will be returned in the - # response. This is the default value. - # 1. Both voided in-app purchases and voided subscription purchases - # will be returned in the response. - # Note: Before requesting to receive voided subscription purchases, you - # must switch to use orderId in the response which uniquely identifies - # one-time purchases and subscriptions. Otherwise, you will receive multiple - # subscription orders with the same PurchaseToken, because subscription - # renewal orders share the same PurchaseToken. + # The type of voided purchases that you want to see in the response. Possible + # values are: 0. Only voided in-app product purchases will be returned in the + # response. This is the default value. 1. Both voided in-app purchases and + # voided subscription purchases will be returned in the response. Note: Before + # requesting to receive voided subscription purchases, you must switch to use + # orderId in the response which uniquely identifies one-time purchases and + # subscriptions. Otherwise, you will receive multiple subscription orders with + # the same PurchaseToken, because subscription renewal orders share the same + # PurchaseToken. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2293,8 +2265,8 @@ module Google execute_or_queue_command(command, &block) end - # Downloads a previously created system APK which is suitable for inclusion - # in a system image. + # Downloads a previously created system APK which is suitable for inclusion in a + # system image. # @param [String] package_name # Unique identifier of the Android app. # @param [Fixnum] version_code diff --git a/generated/google/apis/billingbudgets_v1beta1.rb b/generated/google/apis/billingbudgets_v1beta1.rb index dfd390eb8..4e611686a 100644 --- a/generated/google/apis/billingbudgets_v1beta1.rb +++ b/generated/google/apis/billingbudgets_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/billing/docs/how-to/budget-api-overview module BillingbudgetsV1beta1 VERSION = 'V1beta1' - REVISION = '20200711' + REVISION = '20200801' # 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/billingbudgets_v1beta1/classes.rb b/generated/google/apis/billingbudgets_v1beta1/classes.rb index 60a310ecd..26a293614 100644 --- a/generated/google/apis/billingbudgets_v1beta1/classes.rb +++ b/generated/google/apis/billingbudgets_v1beta1/classes.rb @@ -22,45 +22,38 @@ module Google module Apis module BillingbudgetsV1beta1 - # AllUpdatesRule defines notifications that are sent based on budget spend - # and thresholds. + # AllUpdatesRule defines notifications that are sent based on budget spend and + # thresholds. class GoogleCloudBillingBudgetsV1beta1AllUpdatesRule include Google::Apis::Core::Hashable # Optional. Targets to send notifications to when a threshold is exceeded. This - # is in - # addition to default recipients who have billing account roles. - # The value is the full REST resource name of a monitoring notification - # channel with the form - # `projects/`project_id`/notificationChannels/`channel_id``. A maximum of 5 - # channels are allowed. See - # https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients - # for more details. + # is in addition to default recipients who have billing account roles. The value + # is the full REST resource name of a monitoring notification channel with the + # form `projects/`project_id`/notificationChannels/`channel_id``. A maximum of 5 + # channels are allowed. See https://cloud.google.com/billing/docs/how-to/budgets- + # notification-recipients for more details. # Corresponds to the JSON property `monitoringNotificationChannels` # @return [Array] attr_accessor :monitoring_notification_channels - # Required. The name of the Cloud Pub/Sub topic where budget related messages - # will be - # published, in the form `projects/`project_id`/topics/`topic_id``. Updates - # are sent at regular intervals to the topic. - # The topic needs to be created before the budget is created; see - # https://cloud.google.com/billing/docs/how-to/budgets#manage-notifications - # for more details. - # Caller is expected to have - # `pubsub.topics.setIamPolicy` permission on the topic when it's set for a - # budget, otherwise, the API call will fail with PERMISSION_DENIED. See - # https://cloud.google.com/billing/docs/how-to/budgets-programmatic- - # notifications - # for more details on Pub/Sub roles and permissions. + # Optional. The name of the Pub/Sub topic where budget related messages will be + # published, in the form `projects/`project_id`/topics/`topic_id``. Updates are + # sent at regular intervals to the topic. The topic needs to be created before + # the budget is created; see https://cloud.google.com/billing/docs/how-to/ + # budgets#manage-notifications for more details. Caller is expected to have ` + # pubsub.topics.setIamPolicy` permission on the topic when it's set for a budget, + # otherwise, the API call will fail with PERMISSION_DENIED. See https://cloud. + # google.com/billing/docs/how-to/budgets-programmatic-notifications for more + # details on Pub/Sub roles and permissions. # Corresponds to the JSON property `pubsubTopic` # @return [String] attr_accessor :pubsub_topic - # Required. The schema version of the notification sent to `pubsub_topic`. - # Only "1.0" is accepted. It represents the JSON schema as defined in - # https://cloud.google.com/billing/docs/how-to/budgets-programmatic- - # notifications#notification_format + # Optional. The schema version of the notification sent to `pubsub_topic`. Only " + # 1.0" is accepted. It represents the JSON schema as defined in https://cloud. + # google.com/billing/docs/how-to/budgets-programmatic-notifications# + # notification_format # Corresponds to the JSON property `schemaVersion` # @return [String] attr_accessor :schema_version @@ -77,16 +70,16 @@ module Google end end - # A budget is a plan that describes what you expect to spend on Cloud - # projects, plus the rules to execute as spend is tracked against that plan, - # (for example, send an alert when 90% of the target spend is met). - # Currently all plans are monthly budgets so the usage period(s) tracked are - # implied (calendar months of usage back-to-back). + # A budget is a plan that describes what you expect to spend on Cloud projects, + # plus the rules to execute as spend is tracked against that plan, (for example, + # send an alert when 90% of the target spend is met). Currently all plans are + # monthly budgets so the usage period(s) tracked are implied (calendar months of + # usage back-to-back). class GoogleCloudBillingBudgetsV1beta1Budget include Google::Apis::Core::Hashable - # AllUpdatesRule defines notifications that are sent based on budget spend - # and thresholds. + # AllUpdatesRule defines notifications that are sent based on budget spend and + # thresholds. # Corresponds to the JSON property `allUpdatesRule` # @return [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1AllUpdatesRule] attr_accessor :all_updates_rule @@ -101,28 +94,26 @@ module Google # @return [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1Filter] attr_accessor :budget_filter - # User data for display name in UI. - # Validation: <= 60 chars. + # User data for display name in UI. Validation: <= 60 chars. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Optional. Etag to validate that the object is unchanged for a - # read-modify-write operation. - # An empty etag will cause an update to overwrite other changes. + # Optional. Etag to validate that the object is unchanged for a read-modify- + # write operation. An empty etag will cause an update to overwrite other changes. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag - # Output only. Resource name of the budget. - # The resource name implies the scope of a budget. Values are of the form - # `billingAccounts/`billingAccountId`/budgets/`budgetId``. + # Output only. Resource name of the budget. The resource name implies the scope + # of a budget. Values are of the form `billingAccounts/`billingAccountId`/ + # budgets/`budgetId``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Optional. Rules that trigger alerts (notifications of thresholds - # being crossed) when spend exceeds the specified percentages of the budget. + # Optional. Rules that trigger alerts (notifications of thresholds being crossed) + # when spend exceeds the specified percentages of the budget. # Corresponds to the JSON property `thresholdRules` # @return [Array] attr_accessor :threshold_rules @@ -147,11 +138,10 @@ module Google class GoogleCloudBillingBudgetsV1beta1BudgetAmount include Google::Apis::Core::Hashable - # Describes a budget amount targeted to last period's spend. - # At this time, the amount is automatically 100% of last period's spend; - # that is, there are no other options yet. - # Future configuration will be described here (for example, configuring a - # percentage of last period's spend). + # Describes a budget amount targeted to last period's spend. At this time, the + # amount is automatically 100% of last period's spend; that is, there are no + # other options yet. Future configuration will be described here (for example, + # configuring a percentage of last period's spend). # Corresponds to the JSON property `lastPeriodAmount` # @return [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1LastPeriodAmount] attr_accessor :last_period_amount @@ -176,11 +166,11 @@ module Google class GoogleCloudBillingBudgetsV1beta1CreateBudgetRequest include Google::Apis::Core::Hashable - # A budget is a plan that describes what you expect to spend on Cloud - # projects, plus the rules to execute as spend is tracked against that plan, - # (for example, send an alert when 90% of the target spend is met). - # Currently all plans are monthly budgets so the usage period(s) tracked are - # implied (calendar months of usage back-to-back). + # A budget is a plan that describes what you expect to spend on Cloud projects, + # plus the rules to execute as spend is tracked against that plan, (for example, + # send an alert when 90% of the target spend is met). Currently all plans are + # monthly budgets so the usage period(s) tracked are implied (calendar months of + # usage back-to-back). # Corresponds to the JSON property `budget` # @return [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1Budget] attr_accessor :budget @@ -205,40 +195,36 @@ module Google attr_accessor :credit_types_treatment # Optional. A single label and value pair specifying that usage from only this - # set of - # labeled resources should be included in the budget. Currently, multiple - # entries or multiple values per entry are not allowed. If omitted, the - # report will include all labeled and unlabeled usage. + # set of labeled resources should be included in the budget. Currently, multiple + # entries or multiple values per entry are not allowed. If omitted, the report + # will include all labeled and unlabeled usage. # Corresponds to the JSON property `labels` # @return [Hash>] attr_accessor :labels - # Optional. A set of projects of the form `projects/`project``, - # specifying that usage from only this set of projects should be - # included in the budget. If omitted, the report will include all usage for - # the billing account, regardless of which project the usage occurred on. - # Only zero or one project can be specified currently. + # Optional. A set of projects of the form `projects/`project``, specifying that + # usage from only this set of projects should be included in the budget. If + # omitted, the report will include all usage for the billing account, regardless + # of which project the usage occurred on. Only zero or one project can be + # specified currently. # Corresponds to the JSON property `projects` # @return [Array] attr_accessor :projects - # Optional. A set of services of the form `services/`service_id``, - # specifying that usage from only this set of services should be - # included in the budget. If omitted, the report will include usage for - # all the services. - # The service names are available through the Catalog API: - # https://cloud.google.com/billing/v1/how-tos/catalog-api. + # Optional. A set of services of the form `services/`service_id``, specifying + # that usage from only this set of services should be included in the budget. If + # omitted, the report will include usage for all the services. The service names + # are available through the Catalog API: https://cloud.google.com/billing/v1/how- + # tos/catalog-api. # Corresponds to the JSON property `services` # @return [Array] attr_accessor :services # Optional. A set of subaccounts of the form `billingAccounts/`account_id``, - # specifying - # that usage from only this set of subaccounts should be included in the - # budget. If a subaccount is set to the name of the parent account, - # usage from the parent account will be included. If omitted, the - # report will include usage from the parent account and all - # subaccounts, if they exist. + # specifying that usage from only this set of subaccounts should be included in + # the budget. If a subaccount is set to the name of the parent account, usage + # from the parent account will be included. If omitted, the report will include + # usage from the parent account and all subaccounts, if they exist. # Corresponds to the JSON property `subaccounts` # @return [Array] attr_accessor :subaccounts @@ -257,11 +243,10 @@ module Google end end - # Describes a budget amount targeted to last period's spend. - # At this time, the amount is automatically 100% of last period's spend; - # that is, there are no other options yet. - # Future configuration will be described here (for example, configuring a - # percentage of last period's spend). + # Describes a budget amount targeted to last period's spend. At this time, the + # amount is automatically 100% of last period's spend; that is, there are no + # other options yet. Future configuration will be described here (for example, + # configuring a percentage of last period's spend). class GoogleCloudBillingBudgetsV1beta1LastPeriodAmount include Google::Apis::Core::Hashable @@ -283,8 +268,8 @@ module Google # @return [Array] attr_accessor :budgets - # If not empty, indicates that there may be more budgets that match the - # request; this value should be passed in a new `ListBudgetsRequest`. + # If not empty, indicates that there may be more budgets that match the request; + # this value should be passed in a new `ListBudgetsRequest`. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -300,13 +285,12 @@ module Google end end - # ThresholdRule contains a definition of a threshold which triggers - # an alert (a notification of a threshold being crossed) to be sent when - # spend goes above the specified amount. - # Alerts are automatically e-mailed to users with the Billing Account - # Administrator role or the Billing Account User role. - # The thresholds here have no effect on notifications sent to anything - # configured under `Budget.all_updates_rule`. + # ThresholdRule contains a definition of a threshold which triggers an alert (a + # notification of a threshold being crossed) to be sent when spend goes above + # the specified amount. Alerts are automatically e-mailed to users with the + # Billing Account Administrator role or the Billing Account User role. The + # thresholds here have no effect on notifications sent to anything configured + # under `Budget.all_updates_rule`. class GoogleCloudBillingBudgetsV1beta1ThresholdRule include Google::Apis::Core::Hashable @@ -316,9 +300,8 @@ module Google # @return [String] attr_accessor :spend_basis - # Required. Send an alert when this threshold is exceeded. - # This is a 1.0-based percentage, so 0.5 = 50%. - # Validation: non-negative number. + # Required. Send an alert when this threshold is exceeded. This is a 1.0-based + # percentage, so 0.5 = 50%. Validation: non-negative number. # Corresponds to the JSON property `thresholdPercent` # @return [Float] attr_accessor :threshold_percent @@ -338,21 +321,20 @@ module Google class GoogleCloudBillingBudgetsV1beta1UpdateBudgetRequest include Google::Apis::Core::Hashable - # A budget is a plan that describes what you expect to spend on Cloud - # projects, plus the rules to execute as spend is tracked against that plan, - # (for example, send an alert when 90% of the target spend is met). - # Currently all plans are monthly budgets so the usage period(s) tracked are - # implied (calendar months of usage back-to-back). + # A budget is a plan that describes what you expect to spend on Cloud projects, + # plus the rules to execute as spend is tracked against that plan, (for example, + # send an alert when 90% of the target spend is met). Currently all plans are + # monthly budgets so the usage period(s) tracked are implied (calendar months of + # usage back-to-back). # Corresponds to the JSON property `budget` # @return [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1Budget] attr_accessor :budget - # Optional. Indicates which fields in the provided budget to update. - # Read-only fields (such as `name`) cannot be changed. If this is not - # provided, then only fields with non-default values from the request are - # updated. See - # https://developers.google.com/protocol-buffers/docs/proto3#default for more - # details about default values. + # Optional. Indicates which fields in the provided budget to update. Read-only + # fields (such as `name`) cannot be changed. If this is not provided, then only + # fields with non-default values from the request are updated. See https:// + # developers.google.com/protocol-buffers/docs/proto3#default for more details + # about default values. # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask @@ -368,13 +350,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 GoogleProtobufEmpty include Google::Apis::Core::Hashable @@ -396,18 +376,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 diff --git a/generated/google/apis/billingbudgets_v1beta1/service.rb b/generated/google/apis/billingbudgets_v1beta1/service.rb index 31f8a67eb..fbe46be1c 100644 --- a/generated/google/apis/billingbudgets_v1beta1/service.rb +++ b/generated/google/apis/billingbudgets_v1beta1/service.rb @@ -48,12 +48,11 @@ module Google @batch_path = 'batch' end - # Creates a new budget. See - # Quotas and limits - # for more information on the limits of the number of budgets you can create. + # Creates a new budget. See Quotas and limits for more information on the limits + # of the number of budgets you can create. # @param [String] parent - # Required. The name of the billing account to create the budget in. Values - # are of the form `billingAccounts/`billingAccountId``. + # Required. The name of the billing account to create the budget in. Values are + # of the form `billingAccounts/`billingAccountId``. # @param [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1CreateBudgetRequest] google_cloud_billing_budgets_v1beta1_create_budget_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -86,8 +85,8 @@ module Google # Deletes a budget. Returns successfully if already deleted. # @param [String] name - # Required. Name of the budget to delete. Values are of the form - # `billingAccounts/`billingAccountId`/budgets/`budgetId``. + # Required. Name of the budget to delete. Values are of the form ` + # billingAccounts/`billingAccountId`/budgets/`budgetId``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -115,14 +114,13 @@ module Google execute_or_queue_command(command, &block) end - # Returns a budget. - # WARNING: There are some fields exposed on the Google Cloud Console that - # aren't available on this API. When reading from the API, you will not - # see these fields in the return value, though they may have been set - # in the Cloud Console. + # Returns a budget. WARNING: There are some fields exposed on the Google Cloud + # Console that aren't available on this API. When reading from the API, you will + # not see these fields in the return value, though they may have been set in the + # Cloud Console. # @param [String] name - # Required. Name of budget to get. Values are of the form - # `billingAccounts/`billingAccountId`/budgets/`budgetId``. + # Required. Name of budget to get. Values are of the form `billingAccounts/` + # billingAccountId`/budgets/`budgetId``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -150,21 +148,20 @@ module Google execute_or_queue_command(command, &block) end - # Returns a list of budgets for a billing account. - # WARNING: There are some fields exposed on the Google Cloud Console that - # aren't available on this API. When reading from the API, you will not - # see these fields in the return value, though they may have been set - # in the Cloud Console. + # Returns a list of budgets for a billing account. WARNING: There are some + # fields exposed on the Google Cloud Console that aren't available on this API. + # When reading from the API, you will not see these fields in the return value, + # though they may have been set in the Cloud Console. # @param [String] parent - # Required. Name of billing account to list budgets under. Values - # are of the form `billingAccounts/`billingAccountId``. + # Required. Name of billing account to list budgets under. Values are of the + # form `billingAccounts/`billingAccountId``. # @param [Fixnum] page_size - # Optional. The maximum number of budgets to return per page. - # The default and maximum value are 100. + # Optional. The maximum number of budgets to return per page. The default and + # maximum value are 100. # @param [String] page_token - # Optional. The value returned by the last `ListBudgetsResponse` which - # indicates that this is a continuation of a prior `ListBudgets` call, - # and that the system should return the next page of data. + # Optional. The value returned by the last `ListBudgetsResponse` which indicates + # that this is a continuation of a prior `ListBudgets` call, and that the system + # should return the next page of data. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -194,14 +191,14 @@ module Google execute_or_queue_command(command, &block) end - # Updates a budget and returns the updated budget. - # WARNING: There are some fields exposed on the Google Cloud Console that - # aren't available on this API. Budget fields that are not exposed in - # this API will not be changed by this method. + # Updates a budget and returns the updated budget. WARNING: There are some + # fields exposed on the Google Cloud Console that aren't available on this API. + # Budget fields that are not exposed in this API will not be changed by this + # method. # @param [String] name - # Output only. Resource name of the budget. - # The resource name implies the scope of a budget. Values are of the form - # `billingAccounts/`billingAccountId`/budgets/`budgetId``. + # Output only. Resource name of the budget. The resource name implies the scope + # of a budget. Values are of the form `billingAccounts/`billingAccountId`/ + # budgets/`budgetId``. # @param [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1UpdateBudgetRequest] google_cloud_billing_budgets_v1beta1_update_budget_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/blogger_v2.rb b/generated/google/apis/blogger_v2.rb index 63b4d6fb7..bf46bcf5a 100644 --- a/generated/google/apis/blogger_v2.rb +++ b/generated/google/apis/blogger_v2.rb @@ -20,13 +20,12 @@ module Google module Apis # Blogger API v3 # - # The Blogger API provides access to posts, comments and pages of a - # Blogger blog. + # The Blogger API provides access to posts, comments and pages of a Blogger blog. # # @see https://developers.google.com/blogger/docs/3.0/getting_started module BloggerV2 VERSION = 'V2' - REVISION = '20200405' + REVISION = '20200801' # Manage your Blogger account AUTH_BLOGGER = 'https://www.googleapis.com/auth/blogger' diff --git a/generated/google/apis/blogger_v2/classes.rb b/generated/google/apis/blogger_v2/classes.rb index 99e5803e4..a8d506ef1 100644 --- a/generated/google/apis/blogger_v2/classes.rb +++ b/generated/google/apis/blogger_v2/classes.rb @@ -256,8 +256,7 @@ module Google # @return [String] attr_accessor :photos_album_key - # Access permissions that the user has for the blog (ADMIN, AUTHOR, or - # READER). + # Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER). # Corresponds to the JSON property `role` # @return [String] attr_accessor :role diff --git a/generated/google/apis/blogger_v2/service.rb b/generated/google/apis/blogger_v2/service.rb index b7970f2e3..998181a72 100644 --- a/generated/google/apis/blogger_v2/service.rb +++ b/generated/google/apis/blogger_v2/service.rb @@ -22,8 +22,7 @@ module Google module BloggerV2 # Blogger API v3 # - # The Blogger API provides access to posts, comments and pages of a - # Blogger blog. + # The Blogger API provides access to posts, comments and pages of a Blogger blog. # # @example # require 'google/apis/blogger_v2' diff --git a/generated/google/apis/blogger_v3.rb b/generated/google/apis/blogger_v3.rb index 966c21558..bbc5b3756 100644 --- a/generated/google/apis/blogger_v3.rb +++ b/generated/google/apis/blogger_v3.rb @@ -20,13 +20,12 @@ module Google module Apis # Blogger API v3 # - # The Blogger API provides access to posts, comments and pages of a - # Blogger blog. + # The Blogger API provides access to posts, comments and pages of a Blogger blog. # # @see https://developers.google.com/blogger/docs/3.0/getting_started module BloggerV3 VERSION = 'V3' - REVISION = '20200711' + REVISION = '20200801' # Manage your Blogger account AUTH_BLOGGER = 'https://www.googleapis.com/auth/blogger' diff --git a/generated/google/apis/blogger_v3/classes.rb b/generated/google/apis/blogger_v3/classes.rb index 1c06a7357..e28d9bfe4 100644 --- a/generated/google/apis/blogger_v3/classes.rb +++ b/generated/google/apis/blogger_v3/classes.rb @@ -256,8 +256,7 @@ module Google # @return [String] attr_accessor :photos_album_key - # Access permissions that the user has for the blog (ADMIN, AUTHOR, or - # READER). + # Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER). # Corresponds to the JSON property `role` # @return [String] attr_accessor :role diff --git a/generated/google/apis/blogger_v3/service.rb b/generated/google/apis/blogger_v3/service.rb index 0124b1491..982546ab6 100644 --- a/generated/google/apis/blogger_v3/service.rb +++ b/generated/google/apis/blogger_v3/service.rb @@ -22,8 +22,7 @@ module Google module BloggerV3 # Blogger API v3 # - # The Blogger API provides access to posts, comments and pages of a - # Blogger blog. + # The Blogger API provides access to posts, comments and pages of a Blogger blog. # # @example # require 'google/apis/blogger_v3' diff --git a/generated/google/apis/customsearch_v1.rb b/generated/google/apis/customsearch_v1.rb index ac24e0217..929391e58 100644 --- a/generated/google/apis/customsearch_v1.rb +++ b/generated/google/apis/customsearch_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/custom-search/v1/introduction module CustomsearchV1 VERSION = 'V1' - REVISION = '20200723' + REVISION = '20200801' end end end diff --git a/generated/google/apis/customsearch_v1/classes.rb b/generated/google/apis/customsearch_v1/classes.rb index 676886091..03dedcabf 100644 --- a/generated/google/apis/customsearch_v1/classes.rb +++ b/generated/google/apis/customsearch_v1/classes.rb @@ -26,10 +26,9 @@ module Google class Promotion include Google::Apis::Core::Hashable - # An array of block objects for this promotion. See [Google WebSearch - # Protocol - # reference](https://developers.google.com/custom-search/docs/xml_results) - # for more information. + # An array of block objects for this promotion. See [Google WebSearch Protocol + # reference](https://developers.google.com/custom-search/docs/xml_results) for + # more information. # Corresponds to the JSON property `bodyLines` # @return [Array] attr_accessor :body_lines @@ -186,20 +185,20 @@ module Google # @return [Google::Apis::CustomsearchV1::Result::Image] attr_accessor :image - # A unique identifier for the type of current object. For this API, it is - # `customsearch#result.` + # A unique identifier for the type of current object. For this API, it is ` + # customsearch#result.` # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Encapsulates all information about [refinement - # labels](https://developers.google.com/custom-search/docs/xml_results). + # Encapsulates all information about [refinement labels](https://developers. + # google.com/custom-search/docs/xml_results). # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels - # The full URL to which the search result is pointing, e.g. - # http://www.example.com/foo/bar. + # The full URL to which the search result is pointing, e.g. http://www.example. + # com/foo/bar. # Corresponds to the JSON property `link` # @return [String] attr_accessor :link @@ -209,10 +208,8 @@ module Google # @return [String] attr_accessor :mime - # Contains - # [PageMap](https://developers.google.com/custom-search/docs/structured_data# - # pagemaps) - # information for this search result. + # Contains [PageMap](https://developers.google.com/custom-search/docs/ + # structured_data#pagemaps) information for this search result. # Corresponds to the JSON property `pagemap` # @return [Hash] attr_accessor :pagemap @@ -309,8 +306,8 @@ module Google class Label include Google::Apis::Core::Hashable - # The display name of a refinement label. This is the name you should - # display in your user interface. + # The display name of a refinement label. This is the name you should display in + # your user interface. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -320,8 +317,8 @@ module Google # @return [String] attr_accessor :label_with_op - # The name of a refinement label, which you can use to refine searches. - # Don't display this in your user interface; instead, use displayName. + # The name of a refinement label, which you can use to refine searches. Don't + # display this in your user interface; instead, use displayName. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -343,12 +340,10 @@ module Google class Search include Google::Apis::Core::Hashable - # Metadata and refinements associated with the given search engine, - # including: - # * The name of the search engine that was used for the query. - # * A set of [facet - # objects](https://developers.google.com/custom-search/docs/refinements#create) - # (refinements) you can use for refining a search. + # Metadata and refinements associated with the given search engine, including: * + # The name of the search engine that was used for the query. * A set of [facet + # objects](https://developers.google.com/custom-search/docs/refinements#create) ( + # refinements) you can use for refining a search. # Corresponds to the JSON property `context` # @return [Hash] attr_accessor :context @@ -364,10 +359,9 @@ module Google # @return [String] attr_accessor :kind - # The set of - # [promotions](https://developers.google.com/custom-search/docs/promotions). - # Present only if the custom search engine's configuration files define any - # promotions for the given query. + # The set of [promotions](https://developers.google.com/custom-search/docs/ + # promotions). Present only if the custom search engine's configuration files + # define any promotions for the given query. # Corresponds to the JSON property `promotions` # @return [Array] attr_accessor :promotions @@ -447,191 +441,140 @@ module Google # @return [Fixnum] attr_accessor :count - # Restricts search results to documents originating in a particular - # country. You may use [Boolean - # operators](https://developers.google.com/custom-search/docs/xml_results# - # booleanOperators) - # in the `cr` parameter's value. - # Google WebSearch determines the country of a document by analyzing the - # following: - # * The top-level domain (TLD) of the document's URL. - # * The geographic location of the web server's IP address. - # See [Country (cr) Parameter - # Values](https://developers.google.com/custom-search/docs/xml_results# - # countryCollections) - # for a list of valid values for this parameter. + # Restricts search results to documents originating in a particular country. You + # may use [Boolean operators](https://developers.google.com/custom-search/docs/ + # xml_results#booleanOperators) in the `cr` parameter's value. Google WebSearch + # determines the country of a document by analyzing the following: * The top- + # level domain (TLD) of the document's URL. * The geographic location of the web + # server's IP address. See [Country (cr) Parameter Values](https://developers. + # google.com/custom-search/docs/xml_results#countryCollections) for a list of + # valid values for this parameter. # Corresponds to the JSON property `cr` # @return [String] attr_accessor :cr - # The identifier of an engine created using the Programmable Search Engine - # [Control Panel](https://programmablesearchengine.google.com/). This is a - # custom property not defined in the OpenSearch spec. This parameter is - # **required**. + # The identifier of an engine created using the Programmable Search Engine [ + # Control Panel](https://programmablesearchengine.google.com/). This is a custom + # property not defined in the OpenSearch spec. This parameter is **required**. # Corresponds to the JSON property `cx` # @return [String] attr_accessor :cx - # Restricts results to URLs based on date. Supported values include: - # * `d[number]`: requests results from the specified number of past days. - # * `w[number]`: requests results from the specified number of past weeks. - # * `m[number]`: requests results from the specified number of past months. - # * `y[number]`: requests results from the specified number of past years. + # Restricts results to URLs based on date. Supported values include: * `d[number] + # `: requests results from the specified number of past days. * `w[number]`: + # requests results from the specified number of past weeks. * `m[number]`: + # requests results from the specified number of past months. * `y[number]`: + # requests results from the specified number of past years. # Corresponds to the JSON property `dateRestrict` # @return [String] attr_accessor :date_restrict - # Enables or disables the [Simplified and Traditional Chinese - # Search](https://developers.google.com/custom-search/docs/xml_results# - # chineseSearch) - # feature. - # Supported values are: - # * `0`: enabled (default) - # * `1`: disabled + # Enables or disables the [Simplified and Traditional Chinese Search](https:// + # developers.google.com/custom-search/docs/xml_results#chineseSearch) feature. + # Supported values are: * `0`: enabled (default) * `1`: disabled # Corresponds to the JSON property `disableCnTwTranslation` # @return [String] attr_accessor :disable_cn_tw_translation - # Identifies a phrase that all documents in the search results must - # contain. + # Identifies a phrase that all documents in the search results must contain. # Corresponds to the JSON property `exactTerms` # @return [String] attr_accessor :exact_terms - # Identifies a word or phrase that should not appear in any documents in - # the search results. + # Identifies a word or phrase that should not appear in any documents in the + # search results. # Corresponds to the JSON property `excludeTerms` # @return [String] attr_accessor :exclude_terms - # Restricts results to files of a specified extension. Filetypes supported - # by Google include: - # * Adobe Portable Document Format (`pdf`) - # * Adobe PostScript (`ps`) - # * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) - # * Lotus WordPro (`lwp`) - # * Macwrite (`mw`) - # * Microsoft Excel (`xls`) - # * Microsoft PowerPoint (`ppt`) - # * Microsoft Word (`doc`) - # * Microsoft Works (`wks`, `wps`, `wdb`) - # * Microsoft Write (`wri`) - # * Rich Text Format (`rtf`) - # * Shockwave Flash (`swf`) - # * Text (`ans`, `txt`). - # Additional filetypes may be added in the future. An up-to-date list can - # always be found in Google's [file type - # FAQ](https://support.google.com/webmasters/answer/35287). + # Restricts results to files of a specified extension. Filetypes supported by + # Google include: * Adobe Portable Document Format (`pdf`) * Adobe PostScript (` + # ps`) * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) * + # Lotus WordPro (`lwp`) * Macwrite (`mw`) * Microsoft Excel (`xls`) * Microsoft + # PowerPoint (`ppt`) * Microsoft Word (`doc`) * Microsoft Works (`wks`, `wps`, ` + # wdb`) * Microsoft Write (`wri`) * Rich Text Format (`rtf`) * Shockwave Flash (` + # swf`) * Text (`ans`, `txt`). Additional filetypes may be added in the future. + # An up-to-date list can always be found in Google's [file type FAQ](https:// + # support.google.com/webmasters/answer/35287). # Corresponds to the JSON property `fileType` # @return [String] attr_accessor :file_type - # Activates or deactivates the automatic filtering of Google search - # results. See [Automatic - # Filtering](https://developers.google.com/custom-search/docs/xml_results# - # automaticFiltering) - # for more information about Google's search results filters. Valid values - # for this parameter are: - # * `0`: Disabled - # * `1`: Enabled (default) - # **Note**: By default, Google applies filtering to all search results to - # improve the quality of those results. + # Activates or deactivates the automatic filtering of Google search results. See + # [Automatic Filtering](https://developers.google.com/custom-search/docs/ + # xml_results#automaticFiltering) for more information about Google's search + # results filters. Valid values for this parameter are: * `0`: Disabled * `1`: + # Enabled (default) **Note**: By default, Google applies filtering to all search + # results to improve the quality of those results. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter - # Boosts search results whose country of origin matches the parameter - # value. See [Country - # Codes](https://developers.google.com/custom-search/docs/xml_results# - # countryCodes) - # for a list of valid values. - # Specifying a `gl` parameter value in WebSearch requests should improve - # the relevance of results. This is particularly true for international - # customers and, even more specifically, for customers in English-speaking - # countries other than the United States. + # Boosts search results whose country of origin matches the parameter value. See + # [Country Codes](https://developers.google.com/custom-search/docs/xml_results# + # countryCodes) for a list of valid values. Specifying a `gl` parameter value in + # WebSearch requests should improve the relevance of results. This is + # particularly true for international customers and, even more specifically, for + # customers in English-speaking countries other than the United States. # Corresponds to the JSON property `gl` # @return [String] attr_accessor :gl - # Specifies the Google domain (for example, google.com, google.de, or - # google.fr) to which the search should be limited. + # Specifies the Google domain (for example, google.com, google.de, or google.fr) + # to which the search should be limited. # Corresponds to the JSON property `googleHost` # @return [String] attr_accessor :google_host - # Specifies the ending value for a search range. Use `cse:lowRange` and - # `cse:highrange` to append an inclusive search range of - # `lowRange...highRange` to the query. + # Specifies the ending value for a search range. Use `cse:lowRange` and `cse: + # highrange` to append an inclusive search range of `lowRange...highRange` to + # the query. # Corresponds to the JSON property `highRange` # @return [String] attr_accessor :high_range # Specifies the interface language (host language) of your user interface. - # Explicitly setting this parameter improves the performance and the - # quality of your search results. - # See the [Interface - # Languages](https://developers.google.com/custom-search/docs/xml_results# - # wsInterfaceLanguages) - # section of [Internationalizing Queries and Results - # Presentation](https://developers.google.com/custom-search/docs/xml_results# - # wsInternationalizing) - # for more information, and [Supported Interface - # Languages](https://developers.google.com/custom-search/docs/ - # xml_results_appendices#interfaceLanguages) - # for a list of supported languages. + # Explicitly setting this parameter improves the performance and the quality of + # your search results. See the [Interface Languages](https://developers.google. + # com/custom-search/docs/xml_results#wsInterfaceLanguages) section of [ + # Internationalizing Queries and Results Presentation](https://developers.google. + # com/custom-search/docs/xml_results#wsInternationalizing) for more information, + # and [Supported Interface Languages](https://developers.google.com/custom- + # search/docs/xml_results_appendices#interfaceLanguages) for a list of supported + # languages. # Corresponds to the JSON property `hl` # @return [String] attr_accessor :hl - # Appends the specified query terms to the query, as if they were combined - # with a logical `AND` operator. + # Appends the specified query terms to the query, as if they were combined with + # a logical `AND` operator. # Corresponds to the JSON property `hq` # @return [String] attr_accessor :hq - # Restricts results to images of a specified color type. Supported values - # are: - # * `mono` (black and white) - # * `gray` (grayscale) - # * `color` (color) + # Restricts results to images of a specified color type. Supported values are: * + # `mono` (black and white) * `gray` (grayscale) * `color` (color) # Corresponds to the JSON property `imgColorType` # @return [String] attr_accessor :img_color_type - # Restricts results to images with a specific dominant color. Supported - # values are: - # * `red` - # * `orange` - # * `yellow` - # * `green` - # * `teal` - # * `blue` - # * `purple` - # * `pink` - # * `white` - # * `gray` - # * `black` - # * `brown` + # Restricts results to images with a specific dominant color. Supported values + # are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * ` + # pink` * `white` * `gray` * `black` * `brown` # Corresponds to the JSON property `imgDominantColor` # @return [String] attr_accessor :img_dominant_color - # Restricts results to images of a specified size. Supported values are: - # * `icon` (small) - # * `small | medium | large | xlarge` (medium) - # * `xxlarge` (large) - # * `huge` (extra-large) + # Restricts results to images of a specified size. Supported values are: * `icon` + # (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * ` + # huge` (extra-large) # Corresponds to the JSON property `imgSize` # @return [String] attr_accessor :img_size - # Restricts results to images of a specified type. Supported values are: - # * `clipart` (Clip art) - # * `face` (Face) - # * `lineart` (Line drawing) - # * `photo` (Photo) - # * `animated` (Animated) - # * `stock` (Stock) + # Restricts results to images of a specified type. Supported values are: * ` + # clipart` (Clip art) * `face` (Face) * `lineart` (Line drawing) * `photo` ( + # Photo) * `animated` (Animated) * `stock` (Stock) # Corresponds to the JSON property `imgType` # @return [String] attr_accessor :img_type @@ -651,18 +594,17 @@ module Google # @return [String] attr_accessor :link_site - # Specifies the starting value for a search range. Use `cse:lowRange` and - # `cse:highrange` to append an inclusive search range of - # `lowRange...highRange` to the query. + # Specifies the starting value for a search range. Use `cse:lowRange` and `cse: + # highrange` to append an inclusive search range of `lowRange...highRange` to + # the query. # Corresponds to the JSON property `lowRange` # @return [String] attr_accessor :low_range # Provides additional search terms to check for in a document, where each - # document in the search results must contain at least one of the - # additional search terms. You can also use the [Boolean - # OR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt) - # query term for this type of query. + # document in the search results must contain at least one of the additional + # search terms. You can also use the [Boolean OR](https://developers.google.com/ + # custom-search/docs/xml_results#BooleanOrqt) query term for this type of query. # Corresponds to the JSON property `orTerms` # @return [String] attr_accessor :or_terms @@ -678,23 +620,16 @@ module Google # @return [String] attr_accessor :related_site - # Filters based on licensing. Supported values include: - # * `cc_publicdomain` - # * `cc_attribute` - # * `cc_sharealike` - # * `cc_noncommercial` - # * `cc_nonderived` + # Filters based on licensing. Supported values include: * `cc_publicdomain` * ` + # cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived` # Corresponds to the JSON property `rights` # @return [String] attr_accessor :rights - # Specifies the [SafeSearch - # level](https://developers.google.com/custom-search/docs/xml_results# - # safeSearchLevels) - # used for filtering out adult results. This is a custom property not - # defined in the OpenSearch spec. Valid parameter values are: - # * `"off"`: Disable SafeSearch - # * `"active"`: Enable SafeSearch + # Specifies the [SafeSearch level](https://developers.google.com/custom-search/ + # docs/xml_results#safeSearchLevels) used for filtering out adult results. This + # is a custom property not defined in the OpenSearch spec. Valid parameter + # values are: * `"off"`: Disable SafeSearch * `"active"`: Enable SafeSearch # Corresponds to the JSON property `safe` # @return [String] attr_accessor :safe @@ -704,8 +639,8 @@ module Google # @return [String] attr_accessor :search_terms - # Allowed values are `web` or `image`. If unspecified, results are limited - # to webpages. + # Allowed values are `web` or `image`. If unspecified, results are limited to + # webpages. # Corresponds to the JSON property `searchType` # @return [String] attr_accessor :search_type @@ -715,28 +650,27 @@ module Google # @return [String] attr_accessor :site_search - # Specifies whether to include or exclude results from the site named in - # the `sitesearch` parameter. Supported values are: - # * `i`: include content from site - # * `e`: exclude content from site + # Specifies whether to include or exclude results from the site named in the ` + # sitesearch` parameter. Supported values are: * `i`: include content from site * + # `e`: exclude content from site # Corresponds to the JSON property `siteSearchFilter` # @return [String] attr_accessor :site_search_filter - # Specifies that results should be sorted according to the specified - # expression. For example, sort by date. + # Specifies that results should be sorted according to the specified expression. + # For example, sort by date. # Corresponds to the JSON property `sort` # @return [String] attr_accessor :sort - # The index of the current set of search results into the total set of - # results, where the index of the first result is 1. + # The index of the current set of search results into the total set of results, + # where the index of the first result is 1. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index - # The page number of this set of results, where the page length is set by - # the `count` property. + # The page number of this set of results, where the page length is set by the ` + # count` property. # Corresponds to the JSON property `startPage` # @return [Fixnum] attr_accessor :start_page @@ -805,191 +739,140 @@ module Google # @return [Fixnum] attr_accessor :count - # Restricts search results to documents originating in a particular - # country. You may use [Boolean - # operators](https://developers.google.com/custom-search/docs/xml_results# - # booleanOperators) - # in the `cr` parameter's value. - # Google WebSearch determines the country of a document by analyzing the - # following: - # * The top-level domain (TLD) of the document's URL. - # * The geographic location of the web server's IP address. - # See [Country (cr) Parameter - # Values](https://developers.google.com/custom-search/docs/xml_results# - # countryCollections) - # for a list of valid values for this parameter. + # Restricts search results to documents originating in a particular country. You + # may use [Boolean operators](https://developers.google.com/custom-search/docs/ + # xml_results#booleanOperators) in the `cr` parameter's value. Google WebSearch + # determines the country of a document by analyzing the following: * The top- + # level domain (TLD) of the document's URL. * The geographic location of the web + # server's IP address. See [Country (cr) Parameter Values](https://developers. + # google.com/custom-search/docs/xml_results#countryCollections) for a list of + # valid values for this parameter. # Corresponds to the JSON property `cr` # @return [String] attr_accessor :cr - # The identifier of an engine created using the Programmable Search Engine - # [Control Panel](https://programmablesearchengine.google.com/). This is a - # custom property not defined in the OpenSearch spec. This parameter is - # **required**. + # The identifier of an engine created using the Programmable Search Engine [ + # Control Panel](https://programmablesearchengine.google.com/). This is a custom + # property not defined in the OpenSearch spec. This parameter is **required**. # Corresponds to the JSON property `cx` # @return [String] attr_accessor :cx - # Restricts results to URLs based on date. Supported values include: - # * `d[number]`: requests results from the specified number of past days. - # * `w[number]`: requests results from the specified number of past weeks. - # * `m[number]`: requests results from the specified number of past months. - # * `y[number]`: requests results from the specified number of past years. + # Restricts results to URLs based on date. Supported values include: * `d[number] + # `: requests results from the specified number of past days. * `w[number]`: + # requests results from the specified number of past weeks. * `m[number]`: + # requests results from the specified number of past months. * `y[number]`: + # requests results from the specified number of past years. # Corresponds to the JSON property `dateRestrict` # @return [String] attr_accessor :date_restrict - # Enables or disables the [Simplified and Traditional Chinese - # Search](https://developers.google.com/custom-search/docs/xml_results# - # chineseSearch) - # feature. - # Supported values are: - # * `0`: enabled (default) - # * `1`: disabled + # Enables or disables the [Simplified and Traditional Chinese Search](https:// + # developers.google.com/custom-search/docs/xml_results#chineseSearch) feature. + # Supported values are: * `0`: enabled (default) * `1`: disabled # Corresponds to the JSON property `disableCnTwTranslation` # @return [String] attr_accessor :disable_cn_tw_translation - # Identifies a phrase that all documents in the search results must - # contain. + # Identifies a phrase that all documents in the search results must contain. # Corresponds to the JSON property `exactTerms` # @return [String] attr_accessor :exact_terms - # Identifies a word or phrase that should not appear in any documents in - # the search results. + # Identifies a word or phrase that should not appear in any documents in the + # search results. # Corresponds to the JSON property `excludeTerms` # @return [String] attr_accessor :exclude_terms - # Restricts results to files of a specified extension. Filetypes supported - # by Google include: - # * Adobe Portable Document Format (`pdf`) - # * Adobe PostScript (`ps`) - # * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) - # * Lotus WordPro (`lwp`) - # * Macwrite (`mw`) - # * Microsoft Excel (`xls`) - # * Microsoft PowerPoint (`ppt`) - # * Microsoft Word (`doc`) - # * Microsoft Works (`wks`, `wps`, `wdb`) - # * Microsoft Write (`wri`) - # * Rich Text Format (`rtf`) - # * Shockwave Flash (`swf`) - # * Text (`ans`, `txt`). - # Additional filetypes may be added in the future. An up-to-date list can - # always be found in Google's [file type - # FAQ](https://support.google.com/webmasters/answer/35287). + # Restricts results to files of a specified extension. Filetypes supported by + # Google include: * Adobe Portable Document Format (`pdf`) * Adobe PostScript (` + # ps`) * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) * + # Lotus WordPro (`lwp`) * Macwrite (`mw`) * Microsoft Excel (`xls`) * Microsoft + # PowerPoint (`ppt`) * Microsoft Word (`doc`) * Microsoft Works (`wks`, `wps`, ` + # wdb`) * Microsoft Write (`wri`) * Rich Text Format (`rtf`) * Shockwave Flash (` + # swf`) * Text (`ans`, `txt`). Additional filetypes may be added in the future. + # An up-to-date list can always be found in Google's [file type FAQ](https:// + # support.google.com/webmasters/answer/35287). # Corresponds to the JSON property `fileType` # @return [String] attr_accessor :file_type - # Activates or deactivates the automatic filtering of Google search - # results. See [Automatic - # Filtering](https://developers.google.com/custom-search/docs/xml_results# - # automaticFiltering) - # for more information about Google's search results filters. Valid values - # for this parameter are: - # * `0`: Disabled - # * `1`: Enabled (default) - # **Note**: By default, Google applies filtering to all search results to - # improve the quality of those results. + # Activates or deactivates the automatic filtering of Google search results. See + # [Automatic Filtering](https://developers.google.com/custom-search/docs/ + # xml_results#automaticFiltering) for more information about Google's search + # results filters. Valid values for this parameter are: * `0`: Disabled * `1`: + # Enabled (default) **Note**: By default, Google applies filtering to all search + # results to improve the quality of those results. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter - # Boosts search results whose country of origin matches the parameter - # value. See [Country - # Codes](https://developers.google.com/custom-search/docs/xml_results# - # countryCodes) - # for a list of valid values. - # Specifying a `gl` parameter value in WebSearch requests should improve - # the relevance of results. This is particularly true for international - # customers and, even more specifically, for customers in English-speaking - # countries other than the United States. + # Boosts search results whose country of origin matches the parameter value. See + # [Country Codes](https://developers.google.com/custom-search/docs/xml_results# + # countryCodes) for a list of valid values. Specifying a `gl` parameter value in + # WebSearch requests should improve the relevance of results. This is + # particularly true for international customers and, even more specifically, for + # customers in English-speaking countries other than the United States. # Corresponds to the JSON property `gl` # @return [String] attr_accessor :gl - # Specifies the Google domain (for example, google.com, google.de, or - # google.fr) to which the search should be limited. + # Specifies the Google domain (for example, google.com, google.de, or google.fr) + # to which the search should be limited. # Corresponds to the JSON property `googleHost` # @return [String] attr_accessor :google_host - # Specifies the ending value for a search range. Use `cse:lowRange` and - # `cse:highrange` to append an inclusive search range of - # `lowRange...highRange` to the query. + # Specifies the ending value for a search range. Use `cse:lowRange` and `cse: + # highrange` to append an inclusive search range of `lowRange...highRange` to + # the query. # Corresponds to the JSON property `highRange` # @return [String] attr_accessor :high_range # Specifies the interface language (host language) of your user interface. - # Explicitly setting this parameter improves the performance and the - # quality of your search results. - # See the [Interface - # Languages](https://developers.google.com/custom-search/docs/xml_results# - # wsInterfaceLanguages) - # section of [Internationalizing Queries and Results - # Presentation](https://developers.google.com/custom-search/docs/xml_results# - # wsInternationalizing) - # for more information, and [Supported Interface - # Languages](https://developers.google.com/custom-search/docs/ - # xml_results_appendices#interfaceLanguages) - # for a list of supported languages. + # Explicitly setting this parameter improves the performance and the quality of + # your search results. See the [Interface Languages](https://developers.google. + # com/custom-search/docs/xml_results#wsInterfaceLanguages) section of [ + # Internationalizing Queries and Results Presentation](https://developers.google. + # com/custom-search/docs/xml_results#wsInternationalizing) for more information, + # and [Supported Interface Languages](https://developers.google.com/custom- + # search/docs/xml_results_appendices#interfaceLanguages) for a list of supported + # languages. # Corresponds to the JSON property `hl` # @return [String] attr_accessor :hl - # Appends the specified query terms to the query, as if they were combined - # with a logical `AND` operator. + # Appends the specified query terms to the query, as if they were combined with + # a logical `AND` operator. # Corresponds to the JSON property `hq` # @return [String] attr_accessor :hq - # Restricts results to images of a specified color type. Supported values - # are: - # * `mono` (black and white) - # * `gray` (grayscale) - # * `color` (color) + # Restricts results to images of a specified color type. Supported values are: * + # `mono` (black and white) * `gray` (grayscale) * `color` (color) # Corresponds to the JSON property `imgColorType` # @return [String] attr_accessor :img_color_type - # Restricts results to images with a specific dominant color. Supported - # values are: - # * `red` - # * `orange` - # * `yellow` - # * `green` - # * `teal` - # * `blue` - # * `purple` - # * `pink` - # * `white` - # * `gray` - # * `black` - # * `brown` + # Restricts results to images with a specific dominant color. Supported values + # are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * ` + # pink` * `white` * `gray` * `black` * `brown` # Corresponds to the JSON property `imgDominantColor` # @return [String] attr_accessor :img_dominant_color - # Restricts results to images of a specified size. Supported values are: - # * `icon` (small) - # * `small | medium | large | xlarge` (medium) - # * `xxlarge` (large) - # * `huge` (extra-large) + # Restricts results to images of a specified size. Supported values are: * `icon` + # (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * ` + # huge` (extra-large) # Corresponds to the JSON property `imgSize` # @return [String] attr_accessor :img_size - # Restricts results to images of a specified type. Supported values are: - # * `clipart` (Clip art) - # * `face` (Face) - # * `lineart` (Line drawing) - # * `photo` (Photo) - # * `animated` (Animated) - # * `stock` (Stock) + # Restricts results to images of a specified type. Supported values are: * ` + # clipart` (Clip art) * `face` (Face) * `lineart` (Line drawing) * `photo` ( + # Photo) * `animated` (Animated) * `stock` (Stock) # Corresponds to the JSON property `imgType` # @return [String] attr_accessor :img_type @@ -1009,18 +892,17 @@ module Google # @return [String] attr_accessor :link_site - # Specifies the starting value for a search range. Use `cse:lowRange` and - # `cse:highrange` to append an inclusive search range of - # `lowRange...highRange` to the query. + # Specifies the starting value for a search range. Use `cse:lowRange` and `cse: + # highrange` to append an inclusive search range of `lowRange...highRange` to + # the query. # Corresponds to the JSON property `lowRange` # @return [String] attr_accessor :low_range # Provides additional search terms to check for in a document, where each - # document in the search results must contain at least one of the - # additional search terms. You can also use the [Boolean - # OR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt) - # query term for this type of query. + # document in the search results must contain at least one of the additional + # search terms. You can also use the [Boolean OR](https://developers.google.com/ + # custom-search/docs/xml_results#BooleanOrqt) query term for this type of query. # Corresponds to the JSON property `orTerms` # @return [String] attr_accessor :or_terms @@ -1036,23 +918,16 @@ module Google # @return [String] attr_accessor :related_site - # Filters based on licensing. Supported values include: - # * `cc_publicdomain` - # * `cc_attribute` - # * `cc_sharealike` - # * `cc_noncommercial` - # * `cc_nonderived` + # Filters based on licensing. Supported values include: * `cc_publicdomain` * ` + # cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived` # Corresponds to the JSON property `rights` # @return [String] attr_accessor :rights - # Specifies the [SafeSearch - # level](https://developers.google.com/custom-search/docs/xml_results# - # safeSearchLevels) - # used for filtering out adult results. This is a custom property not - # defined in the OpenSearch spec. Valid parameter values are: - # * `"off"`: Disable SafeSearch - # * `"active"`: Enable SafeSearch + # Specifies the [SafeSearch level](https://developers.google.com/custom-search/ + # docs/xml_results#safeSearchLevels) used for filtering out adult results. This + # is a custom property not defined in the OpenSearch spec. Valid parameter + # values are: * `"off"`: Disable SafeSearch * `"active"`: Enable SafeSearch # Corresponds to the JSON property `safe` # @return [String] attr_accessor :safe @@ -1062,8 +937,8 @@ module Google # @return [String] attr_accessor :search_terms - # Allowed values are `web` or `image`. If unspecified, results are limited - # to webpages. + # Allowed values are `web` or `image`. If unspecified, results are limited to + # webpages. # Corresponds to the JSON property `searchType` # @return [String] attr_accessor :search_type @@ -1073,28 +948,27 @@ module Google # @return [String] attr_accessor :site_search - # Specifies whether to include or exclude results from the site named in - # the `sitesearch` parameter. Supported values are: - # * `i`: include content from site - # * `e`: exclude content from site + # Specifies whether to include or exclude results from the site named in the ` + # sitesearch` parameter. Supported values are: * `i`: include content from site * + # `e`: exclude content from site # Corresponds to the JSON property `siteSearchFilter` # @return [String] attr_accessor :site_search_filter - # Specifies that results should be sorted according to the specified - # expression. For example, sort by date. + # Specifies that results should be sorted according to the specified expression. + # For example, sort by date. # Corresponds to the JSON property `sort` # @return [String] attr_accessor :sort - # The index of the current set of search results into the total set of - # results, where the index of the first result is 1. + # The index of the current set of search results into the total set of results, + # where the index of the first result is 1. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index - # The page number of this set of results, where the page length is set by - # the `count` property. + # The page number of this set of results, where the page length is set by the ` + # count` property. # Corresponds to the JSON property `startPage` # @return [Fixnum] attr_accessor :start_page @@ -1163,191 +1037,140 @@ module Google # @return [Fixnum] attr_accessor :count - # Restricts search results to documents originating in a particular - # country. You may use [Boolean - # operators](https://developers.google.com/custom-search/docs/xml_results# - # booleanOperators) - # in the `cr` parameter's value. - # Google WebSearch determines the country of a document by analyzing the - # following: - # * The top-level domain (TLD) of the document's URL. - # * The geographic location of the web server's IP address. - # See [Country (cr) Parameter - # Values](https://developers.google.com/custom-search/docs/xml_results# - # countryCollections) - # for a list of valid values for this parameter. + # Restricts search results to documents originating in a particular country. You + # may use [Boolean operators](https://developers.google.com/custom-search/docs/ + # xml_results#booleanOperators) in the `cr` parameter's value. Google WebSearch + # determines the country of a document by analyzing the following: * The top- + # level domain (TLD) of the document's URL. * The geographic location of the web + # server's IP address. See [Country (cr) Parameter Values](https://developers. + # google.com/custom-search/docs/xml_results#countryCollections) for a list of + # valid values for this parameter. # Corresponds to the JSON property `cr` # @return [String] attr_accessor :cr - # The identifier of an engine created using the Programmable Search Engine - # [Control Panel](https://programmablesearchengine.google.com/). This is a - # custom property not defined in the OpenSearch spec. This parameter is - # **required**. + # The identifier of an engine created using the Programmable Search Engine [ + # Control Panel](https://programmablesearchengine.google.com/). This is a custom + # property not defined in the OpenSearch spec. This parameter is **required**. # Corresponds to the JSON property `cx` # @return [String] attr_accessor :cx - # Restricts results to URLs based on date. Supported values include: - # * `d[number]`: requests results from the specified number of past days. - # * `w[number]`: requests results from the specified number of past weeks. - # * `m[number]`: requests results from the specified number of past months. - # * `y[number]`: requests results from the specified number of past years. + # Restricts results to URLs based on date. Supported values include: * `d[number] + # `: requests results from the specified number of past days. * `w[number]`: + # requests results from the specified number of past weeks. * `m[number]`: + # requests results from the specified number of past months. * `y[number]`: + # requests results from the specified number of past years. # Corresponds to the JSON property `dateRestrict` # @return [String] attr_accessor :date_restrict - # Enables or disables the [Simplified and Traditional Chinese - # Search](https://developers.google.com/custom-search/docs/xml_results# - # chineseSearch) - # feature. - # Supported values are: - # * `0`: enabled (default) - # * `1`: disabled + # Enables or disables the [Simplified and Traditional Chinese Search](https:// + # developers.google.com/custom-search/docs/xml_results#chineseSearch) feature. + # Supported values are: * `0`: enabled (default) * `1`: disabled # Corresponds to the JSON property `disableCnTwTranslation` # @return [String] attr_accessor :disable_cn_tw_translation - # Identifies a phrase that all documents in the search results must - # contain. + # Identifies a phrase that all documents in the search results must contain. # Corresponds to the JSON property `exactTerms` # @return [String] attr_accessor :exact_terms - # Identifies a word or phrase that should not appear in any documents in - # the search results. + # Identifies a word or phrase that should not appear in any documents in the + # search results. # Corresponds to the JSON property `excludeTerms` # @return [String] attr_accessor :exclude_terms - # Restricts results to files of a specified extension. Filetypes supported - # by Google include: - # * Adobe Portable Document Format (`pdf`) - # * Adobe PostScript (`ps`) - # * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) - # * Lotus WordPro (`lwp`) - # * Macwrite (`mw`) - # * Microsoft Excel (`xls`) - # * Microsoft PowerPoint (`ppt`) - # * Microsoft Word (`doc`) - # * Microsoft Works (`wks`, `wps`, `wdb`) - # * Microsoft Write (`wri`) - # * Rich Text Format (`rtf`) - # * Shockwave Flash (`swf`) - # * Text (`ans`, `txt`). - # Additional filetypes may be added in the future. An up-to-date list can - # always be found in Google's [file type - # FAQ](https://support.google.com/webmasters/answer/35287). + # Restricts results to files of a specified extension. Filetypes supported by + # Google include: * Adobe Portable Document Format (`pdf`) * Adobe PostScript (` + # ps`) * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) * + # Lotus WordPro (`lwp`) * Macwrite (`mw`) * Microsoft Excel (`xls`) * Microsoft + # PowerPoint (`ppt`) * Microsoft Word (`doc`) * Microsoft Works (`wks`, `wps`, ` + # wdb`) * Microsoft Write (`wri`) * Rich Text Format (`rtf`) * Shockwave Flash (` + # swf`) * Text (`ans`, `txt`). Additional filetypes may be added in the future. + # An up-to-date list can always be found in Google's [file type FAQ](https:// + # support.google.com/webmasters/answer/35287). # Corresponds to the JSON property `fileType` # @return [String] attr_accessor :file_type - # Activates or deactivates the automatic filtering of Google search - # results. See [Automatic - # Filtering](https://developers.google.com/custom-search/docs/xml_results# - # automaticFiltering) - # for more information about Google's search results filters. Valid values - # for this parameter are: - # * `0`: Disabled - # * `1`: Enabled (default) - # **Note**: By default, Google applies filtering to all search results to - # improve the quality of those results. + # Activates or deactivates the automatic filtering of Google search results. See + # [Automatic Filtering](https://developers.google.com/custom-search/docs/ + # xml_results#automaticFiltering) for more information about Google's search + # results filters. Valid values for this parameter are: * `0`: Disabled * `1`: + # Enabled (default) **Note**: By default, Google applies filtering to all search + # results to improve the quality of those results. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter - # Boosts search results whose country of origin matches the parameter - # value. See [Country - # Codes](https://developers.google.com/custom-search/docs/xml_results# - # countryCodes) - # for a list of valid values. - # Specifying a `gl` parameter value in WebSearch requests should improve - # the relevance of results. This is particularly true for international - # customers and, even more specifically, for customers in English-speaking - # countries other than the United States. + # Boosts search results whose country of origin matches the parameter value. See + # [Country Codes](https://developers.google.com/custom-search/docs/xml_results# + # countryCodes) for a list of valid values. Specifying a `gl` parameter value in + # WebSearch requests should improve the relevance of results. This is + # particularly true for international customers and, even more specifically, for + # customers in English-speaking countries other than the United States. # Corresponds to the JSON property `gl` # @return [String] attr_accessor :gl - # Specifies the Google domain (for example, google.com, google.de, or - # google.fr) to which the search should be limited. + # Specifies the Google domain (for example, google.com, google.de, or google.fr) + # to which the search should be limited. # Corresponds to the JSON property `googleHost` # @return [String] attr_accessor :google_host - # Specifies the ending value for a search range. Use `cse:lowRange` and - # `cse:highrange` to append an inclusive search range of - # `lowRange...highRange` to the query. + # Specifies the ending value for a search range. Use `cse:lowRange` and `cse: + # highrange` to append an inclusive search range of `lowRange...highRange` to + # the query. # Corresponds to the JSON property `highRange` # @return [String] attr_accessor :high_range # Specifies the interface language (host language) of your user interface. - # Explicitly setting this parameter improves the performance and the - # quality of your search results. - # See the [Interface - # Languages](https://developers.google.com/custom-search/docs/xml_results# - # wsInterfaceLanguages) - # section of [Internationalizing Queries and Results - # Presentation](https://developers.google.com/custom-search/docs/xml_results# - # wsInternationalizing) - # for more information, and [Supported Interface - # Languages](https://developers.google.com/custom-search/docs/ - # xml_results_appendices#interfaceLanguages) - # for a list of supported languages. + # Explicitly setting this parameter improves the performance and the quality of + # your search results. See the [Interface Languages](https://developers.google. + # com/custom-search/docs/xml_results#wsInterfaceLanguages) section of [ + # Internationalizing Queries and Results Presentation](https://developers.google. + # com/custom-search/docs/xml_results#wsInternationalizing) for more information, + # and [Supported Interface Languages](https://developers.google.com/custom- + # search/docs/xml_results_appendices#interfaceLanguages) for a list of supported + # languages. # Corresponds to the JSON property `hl` # @return [String] attr_accessor :hl - # Appends the specified query terms to the query, as if they were combined - # with a logical `AND` operator. + # Appends the specified query terms to the query, as if they were combined with + # a logical `AND` operator. # Corresponds to the JSON property `hq` # @return [String] attr_accessor :hq - # Restricts results to images of a specified color type. Supported values - # are: - # * `mono` (black and white) - # * `gray` (grayscale) - # * `color` (color) + # Restricts results to images of a specified color type. Supported values are: * + # `mono` (black and white) * `gray` (grayscale) * `color` (color) # Corresponds to the JSON property `imgColorType` # @return [String] attr_accessor :img_color_type - # Restricts results to images with a specific dominant color. Supported - # values are: - # * `red` - # * `orange` - # * `yellow` - # * `green` - # * `teal` - # * `blue` - # * `purple` - # * `pink` - # * `white` - # * `gray` - # * `black` - # * `brown` + # Restricts results to images with a specific dominant color. Supported values + # are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * ` + # pink` * `white` * `gray` * `black` * `brown` # Corresponds to the JSON property `imgDominantColor` # @return [String] attr_accessor :img_dominant_color - # Restricts results to images of a specified size. Supported values are: - # * `icon` (small) - # * `small | medium | large | xlarge` (medium) - # * `xxlarge` (large) - # * `huge` (extra-large) + # Restricts results to images of a specified size. Supported values are: * `icon` + # (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * ` + # huge` (extra-large) # Corresponds to the JSON property `imgSize` # @return [String] attr_accessor :img_size - # Restricts results to images of a specified type. Supported values are: - # * `clipart` (Clip art) - # * `face` (Face) - # * `lineart` (Line drawing) - # * `photo` (Photo) - # * `animated` (Animated) - # * `stock` (Stock) + # Restricts results to images of a specified type. Supported values are: * ` + # clipart` (Clip art) * `face` (Face) * `lineart` (Line drawing) * `photo` ( + # Photo) * `animated` (Animated) * `stock` (Stock) # Corresponds to the JSON property `imgType` # @return [String] attr_accessor :img_type @@ -1367,18 +1190,17 @@ module Google # @return [String] attr_accessor :link_site - # Specifies the starting value for a search range. Use `cse:lowRange` and - # `cse:highrange` to append an inclusive search range of - # `lowRange...highRange` to the query. + # Specifies the starting value for a search range. Use `cse:lowRange` and `cse: + # highrange` to append an inclusive search range of `lowRange...highRange` to + # the query. # Corresponds to the JSON property `lowRange` # @return [String] attr_accessor :low_range # Provides additional search terms to check for in a document, where each - # document in the search results must contain at least one of the - # additional search terms. You can also use the [Boolean - # OR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt) - # query term for this type of query. + # document in the search results must contain at least one of the additional + # search terms. You can also use the [Boolean OR](https://developers.google.com/ + # custom-search/docs/xml_results#BooleanOrqt) query term for this type of query. # Corresponds to the JSON property `orTerms` # @return [String] attr_accessor :or_terms @@ -1394,23 +1216,16 @@ module Google # @return [String] attr_accessor :related_site - # Filters based on licensing. Supported values include: - # * `cc_publicdomain` - # * `cc_attribute` - # * `cc_sharealike` - # * `cc_noncommercial` - # * `cc_nonderived` + # Filters based on licensing. Supported values include: * `cc_publicdomain` * ` + # cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived` # Corresponds to the JSON property `rights` # @return [String] attr_accessor :rights - # Specifies the [SafeSearch - # level](https://developers.google.com/custom-search/docs/xml_results# - # safeSearchLevels) - # used for filtering out adult results. This is a custom property not - # defined in the OpenSearch spec. Valid parameter values are: - # * `"off"`: Disable SafeSearch - # * `"active"`: Enable SafeSearch + # Specifies the [SafeSearch level](https://developers.google.com/custom-search/ + # docs/xml_results#safeSearchLevels) used for filtering out adult results. This + # is a custom property not defined in the OpenSearch spec. Valid parameter + # values are: * `"off"`: Disable SafeSearch * `"active"`: Enable SafeSearch # Corresponds to the JSON property `safe` # @return [String] attr_accessor :safe @@ -1420,8 +1235,8 @@ module Google # @return [String] attr_accessor :search_terms - # Allowed values are `web` or `image`. If unspecified, results are limited - # to webpages. + # Allowed values are `web` or `image`. If unspecified, results are limited to + # webpages. # Corresponds to the JSON property `searchType` # @return [String] attr_accessor :search_type @@ -1431,28 +1246,27 @@ module Google # @return [String] attr_accessor :site_search - # Specifies whether to include or exclude results from the site named in - # the `sitesearch` parameter. Supported values are: - # * `i`: include content from site - # * `e`: exclude content from site + # Specifies whether to include or exclude results from the site named in the ` + # sitesearch` parameter. Supported values are: * `i`: include content from site * + # `e`: exclude content from site # Corresponds to the JSON property `siteSearchFilter` # @return [String] attr_accessor :site_search_filter - # Specifies that results should be sorted according to the specified - # expression. For example, sort by date. + # Specifies that results should be sorted according to the specified expression. + # For example, sort by date. # Corresponds to the JSON property `sort` # @return [String] attr_accessor :sort - # The index of the current set of search results into the total set of - # results, where the index of the first result is 1. + # The index of the current set of search results into the total set of results, + # where the index of the first result is 1. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index - # The page number of this set of results, where the page length is set by - # the `count` property. + # The page number of this set of results, where the page length is set by the ` + # count` property. # Corresponds to the JSON property `startPage` # @return [Fixnum] attr_accessor :start_page @@ -1517,8 +1331,8 @@ module Google class SearchInformation include Google::Apis::Core::Hashable - # The time taken for the server to return search results, formatted - # according to locale style. + # The time taken for the server to return search results, formatted according to + # locale style. # Corresponds to the JSON property `formattedSearchTime` # @return [String] attr_accessor :formatted_search_time @@ -1580,16 +1394,13 @@ module Google class Url include Google::Apis::Core::Hashable - # The actual [OpenSearch - # template](http://www.opensearch.org/specifications/opensearch/1.1# - # opensearch_url_template_syntax) - # for this API. + # The actual [OpenSearch template](http://www.opensearch.org/specifications/ + # opensearch/1.1#opensearch_url_template_syntax) for this API. # Corresponds to the JSON property `template` # @return [String] attr_accessor :template - # The MIME type of the OpenSearch URL template for the Custom Search JSON - # API. + # The MIME type of the OpenSearch URL template for the Custom Search JSON API. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type diff --git a/generated/google/apis/customsearch_v1/service.rb b/generated/google/apis/customsearch_v1/service.rb index 0e91ddc2f..15df999d1 100644 --- a/generated/google/apis/customsearch_v1/service.rb +++ b/generated/google/apis/customsearch_v1/service.rb @@ -47,37 +47,30 @@ module Google @batch_path = 'batch' end - # Returns metadata about the search performed, metadata about the - # engine used for the search, and the search results. + # Returns metadata about the search performed, metadata about the engine used + # for the search, and the search results. # @param [String] c2coff - # Enables or disables [Simplified and Traditional Chinese - # Search](https://developers.google.com/custom-search/docs/xml_results# - # chineseSearch). - # The default value for this parameter is 0 (zero), meaning that the feature - # is enabled. Supported values are: - # * `1`: Disabled - # * `0`: Enabled (default) + # Enables or disables [Simplified and Traditional Chinese Search](https:// + # developers.google.com/custom-search/docs/xml_results#chineseSearch). The + # default value for this parameter is 0 (zero), meaning that the feature is + # enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default) # @param [String] cr - # Restricts search results to documents originating in a particular country. - # You may use [Boolean - # operators](https://developers.google.com/custom-search/docs/ - # xml_results_appendices#booleanOperators) - # in the cr parameter's value. - # Google Search determines the country of a document by analyzing: - # * the top-level domain (TLD) of the document's URL - # * the geographic location of the Web server's IP address - # See the [Country Parameter - # Values](https://developers.google.com/custom-search/docs/ - # xml_results_appendices#countryCollections) - # page for a list of valid values for this parameter. + # Restricts search results to documents originating in a particular country. You + # may use [Boolean operators](https://developers.google.com/custom-search/docs/ + # xml_results_appendices#booleanOperators) in the cr parameter's value. Google + # Search determines the country of a document by analyzing: * the top-level + # domain (TLD) of the document's URL * the geographic location of the Web server' + # s IP address See the [Country Parameter Values](https://developers.google.com/ + # custom-search/docs/xml_results_appendices#countryCollections) page for a list + # of valid values for this parameter. # @param [String] cx # The Programmable Search Engine ID to use for this request. # @param [String] date_restrict - # Restricts results to URLs based on date. Supported values include: - # * `d[number]`: requests results from the specified number of past days. - # * `w[number]`: requests results from the specified number of past weeks. - # * `m[number]`: requests results from the specified number of past months. - # * `y[number]`: requests results from the specified number of past years. + # Restricts results to URLs based on date. Supported values include: * `d[number] + # `: requests results from the specified number of past days. * `w[number]`: + # requests results from the specified number of past weeks. * `m[number]`: + # requests results from the specified number of past months. * `y[number]`: + # requests results from the specified number of past years. # @param [String] exact_terms # Identifies a phrase that all documents in the search results must contain. # @param [String] exclude_terms @@ -85,144 +78,80 @@ module Google # search results. # @param [String] file_type # Restricts results to files of a specified extension. A list of file types - # indexable by Google can be found in Search Console [Help - # Center](https://support.google.com/webmasters/answer/35287). + # indexable by Google can be found in Search Console [Help Center](https:// + # support.google.com/webmasters/answer/35287). # @param [String] filter - # Controls turning on or off the duplicate content filter. - # * See [Automatic + # Controls turning on or off the duplicate content filter. * See [Automatic # Filtering](https://developers.google.com/custom-search/docs/xml_results# - # automaticFiltering) - # for more information about Google's search results filters. Note that host - # crowding filtering applies only to multi-site searches. - # * By default, Google applies filtering to all search results to improve the - # quality of those results. - # Acceptable values are: - # * `0`: Turns off duplicate content filter. - # * `1`: Turns on duplicate content filter. + # automaticFiltering) for more information about Google's search results filters. + # Note that host crowding filtering applies only to multi-site searches. * By + # default, Google applies filtering to all search results to improve the quality + # of those results. Acceptable values are: * `0`: Turns off duplicate content + # filter. * `1`: Turns on duplicate content filter. # @param [String] gl - # Geolocation of end user. - # * The `gl` parameter value is a two-letter country code. The `gl` parameter - # boosts search results whose country of origin matches the parameter value. - # See the [Country - # Codes](https://developers.google.com/custom-search/docs/xml_results_appendices# - # countryCodes) - # page for a list of valid values. - # * Specifying a `gl` parameter value should lead to more relevant results. - # This is particularly true for international customers and, even more + # Geolocation of end user. * The `gl` parameter value is a two-letter country + # code. The `gl` parameter boosts search results whose country of origin matches + # the parameter value. See the [Country Codes](https://developers.google.com/ + # custom-search/docs/xml_results_appendices#countryCodes) page for a list of + # valid values. * Specifying a `gl` parameter value should lead to more relevant + # results. This is particularly true for international customers and, even more # specifically, for customers in English- speaking countries other than the # United States. # @param [String] googlehost - # **Deprecated**. Use the `gl` parameter for a similar effect. - # The local Google domain (for example, google.com, google.de, or - # google.fr) to use to perform the search. + # **Deprecated**. Use the `gl` parameter for a similar effect. The local Google + # domain (for example, google.com, google.de, or google.fr) to use to perform + # the search. # @param [String] high_range - # Specifies the ending value for a search range. - # * Use `lowRange` and `highRange` to append an inclusive search range of - # `lowRange...highRange` to the query. + # Specifies the ending value for a search range. * Use `lowRange` and `highRange` + # to append an inclusive search range of `lowRange...highRange` to the query. # @param [String] hl - # Sets the user interface language. - # * Explicitly setting this parameter improves the performance and the - # quality of your search results. - # * See the [Interface + # Sets the user interface language. * Explicitly setting this parameter improves + # the performance and the quality of your search results. * See the [Interface # Languages](https://developers.google.com/custom-search/docs/xml_results# - # wsInterfaceLanguages) - # section of [Internationalizing Queries and Results + # wsInterfaceLanguages) section of [Internationalizing Queries and Results # Presentation](https://developers.google.com/custom-search/docs/xml_results# - # wsInternationalizing) - # for more information, and (Supported Interface - # Languages)[https://developers.google.com/custom-search/docs/ - # xml_results_appendices#interfaceLanguages] - # for a list of supported languages. + # wsInternationalizing) for more information, and (Supported Interface Languages) + # [https://developers.google.com/custom-search/docs/xml_results_appendices# + # interfaceLanguages] for a list of supported languages. # @param [String] hq - # Appends the specified query terms to the query, as if they were combined - # with a logical AND operator. + # Appends the specified query terms to the query, as if they were combined with + # a logical AND operator. # @param [String] img_color_type - # Returns black and white, grayscale, transparent, or color images. - # Acceptable values are: - # * `"color"` - # * `"gray"` - # * `"mono"`: black and white - # * `"trans"`: transparent background + # Returns black and white, grayscale, transparent, or color images. Acceptable + # values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: + # transparent background # @param [String] img_dominant_color - # Returns images of a specific dominant color. Acceptable values are: - # * `"black"` - # * `"blue"` - # * `"brown"` - # * `"gray"` - # * `"green"` - # * `"orange"` - # * `"pink"` - # * `"purple"` - # * `"red"` - # * `"teal"` - # * `"white"` - # * `"yellow"` + # Returns images of a specific dominant color. Acceptable values are: * `"black"` + # * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `" + # purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` # @param [String] img_size - # Returns images of a specified size. Acceptable values are: - # * `"huge"` - # * `"icon"` - # * `"large"` - # * `"medium"` - # * `"small"` - # * `"xlarge"` - # * `"xxlarge"` + # Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon" + # ` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` # @param [String] img_type - # Returns images of a type. Acceptable values are: - # * `"clipart"` - # * `"face"` - # * `"lineart"` - # * `"stock"` - # * `"photo"` - # * `"animated"` + # Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `" + # lineart"` * `"stock"` * `"photo"` * `"animated"` # @param [String] link_site - # Specifies that all search results should contain a link to a particular - # URL. + # Specifies that all search results should contain a link to a particular URL. # @param [String] low_range - # Specifies the starting value for a search range. Use `lowRange` and - # `highRange` to append an inclusive search range of `lowRange...highRange` - # to the query. + # Specifies the starting value for a search range. Use `lowRange` and `highRange` + # to append an inclusive search range of `lowRange...highRange` to the query. # @param [String] lr - # Restricts the search to documents written in a particular language (e.g., - # `lr=lang_ja`). - # Acceptable values are: - # * `"lang_ar"`: Arabic - # * `"lang_bg"`: Bulgarian - # * `"lang_ca"`: Catalan - # * `"lang_cs"`: Czech - # * `"lang_da"`: Danish - # * `"lang_de"`: German - # * `"lang_el"`: Greek - # * `"lang_en"`: English - # * `"lang_es"`: Spanish - # * `"lang_et"`: Estonian - # * `"lang_fi"`: Finnish - # * `"lang_fr"`: French - # * `"lang_hr"`: Croatian - # * `"lang_hu"`: Hungarian - # * `"lang_id"`: Indonesian - # * `"lang_is"`: Icelandic - # * `"lang_it"`: Italian - # * `"lang_iw"`: Hebrew - # * `"lang_ja"`: Japanese - # * `"lang_ko"`: Korean - # * `"lang_lt"`: Lithuanian - # * `"lang_lv"`: Latvian - # * `"lang_nl"`: Dutch - # * `"lang_no"`: Norwegian - # * `"lang_pl"`: Polish - # * `"lang_pt"`: Portuguese - # * `"lang_ro"`: Romanian - # * `"lang_ru"`: Russian - # * `"lang_sk"`: Slovak - # * `"lang_sl"`: Slovenian - # * `"lang_sr"`: Serbian - # * `"lang_sv"`: Swedish - # * `"lang_tr"`: Turkish - # * `"lang_zh-CN"`: Chinese (Simplified) - # * `"lang_zh-TW"`: Chinese (Traditional) + # Restricts the search to documents written in a particular language (e.g., `lr= + # lang_ja`). Acceptable values are: * `"lang_ar"`: Arabic * `"lang_bg"`: + # Bulgarian * `"lang_ca"`: Catalan * `"lang_cs"`: Czech * `"lang_da"`: Danish * ` + # "lang_de"`: German * `"lang_el"`: Greek * `"lang_en"`: English * `"lang_es"`: + # Spanish * `"lang_et"`: Estonian * `"lang_fi"`: Finnish * `"lang_fr"`: French * + # `"lang_hr"`: Croatian * `"lang_hu"`: Hungarian * `"lang_id"`: Indonesian * `" + # lang_is"`: Icelandic * `"lang_it"`: Italian * `"lang_iw"`: Hebrew * `"lang_ja"` + # : Japanese * `"lang_ko"`: Korean * `"lang_lt"`: Lithuanian * `"lang_lv"`: + # Latvian * `"lang_nl"`: Dutch * `"lang_no"`: Norwegian * `"lang_pl"`: Polish * ` + # "lang_pt"`: Portuguese * `"lang_ro"`: Romanian * `"lang_ru"`: Russian * `" + # lang_sk"`: Slovak * `"lang_sl"`: Slovenian * `"lang_sr"`: Serbian * `"lang_sv"` + # : Swedish * `"lang_tr"`: Turkish * `"lang_zh-CN"`: Chinese (Simplified) * `" + # lang_zh-TW"`: Chinese (Traditional) # @param [Fixnum] num - # Number of search results to return. - # * Valid values are integers between 1 and 10, inclusive. + # Number of search results to return. * Valid values are integers between 1 and + # 10, inclusive. # @param [String] or_terms # Provides additional search terms to check for in a document, where each # document in the search results must contain at least one of the additional @@ -233,42 +162,35 @@ module Google # Specifies that all search results should be pages that are related to the # specified URL. # @param [String] rights - # Filters based on licensing. Supported values include: `cc_publicdomain`, - # `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and - # combinations of these. See [typical - # combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration). + # Filters based on licensing. Supported values include: `cc_publicdomain`, ` + # cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and + # combinations of these. See [typical combinations](https://wiki.creativecommons. + # org/wiki/CC_Search_integration). # @param [String] safe - # Search safety level. Acceptable values are: - # * `"active"`: Enables SafeSearch filtering. - # * `"off"`: Disables SafeSearch filtering. (default) + # Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch + # filtering. * `"off"`: Disables SafeSearch filtering. (default) # @param [String] search_type # Specifies the search type: `image`. If unspecified, results are limited to - # webpages. - # Acceptable values are: - # * `"image"`: custom image search. + # webpages. Acceptable values are: * `"image"`: custom image search. # @param [String] site_search # Specifies a given site which should always be included or excluded from # results (see `siteSearchFilter` parameter, below). # @param [String] site_search_filter - # Controls whether to include or exclude results from the site named in the - # `siteSearch` parameter. - # Acceptable values are: - # * `"e"`: exclude - # * `"i"`: include + # Controls whether to include or exclude results from the site named in the ` + # siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: + # include # @param [String] sort - # The sort expression to apply to the results. The sort parameter specifies - # that the results be sorted according to the specified expression i.e. sort - # by date. - # [Example: - # sort=date](https://developers.google.com/custom-search/docs/structured_search# - # sort-by-attribute). + # The sort expression to apply to the results. The sort parameter specifies that + # the results be sorted according to the specified expression i.e. sort by date. + # [Example: sort=date](https://developers.google.com/custom-search/docs/ + # structured_search#sort-by-attribute). # @param [Fixnum] start # The index of the first result to return. The default number of results per # page is 10, so `&start=11` would start at the top of the second page of - # results. **Note**: The JSON API will never return more than 100 results, - # even if more than 100 documents match the query, so setting the sum of - # `start + num` to a number greater than 100 will produce an error. Also note - # that the maximum value for `num` is 10. + # results. **Note**: The JSON API will never return more than 100 results, even + # if more than 100 documents match the query, so setting the sum of `start + num` + # to a number greater than 100 will produce an error. Also note that the + # maximum value for `num` is 10. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -326,38 +248,30 @@ module Google execute_or_queue_command(command, &block) end - # Returns metadata about the search performed, metadata about the - # engine used for the search, and the search results. Uses a small set - # of url patterns. + # Returns metadata about the search performed, metadata about the engine used + # for the search, and the search results. Uses a small set of url patterns. # @param [String] c2coff - # Enables or disables [Simplified and Traditional Chinese - # Search](https://developers.google.com/custom-search/docs/xml_results# - # chineseSearch). - # The default value for this parameter is 0 (zero), meaning that the feature - # is enabled. Supported values are: - # * `1`: Disabled - # * `0`: Enabled (default) + # Enables or disables [Simplified and Traditional Chinese Search](https:// + # developers.google.com/custom-search/docs/xml_results#chineseSearch). The + # default value for this parameter is 0 (zero), meaning that the feature is + # enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default) # @param [String] cr - # Restricts search results to documents originating in a particular country. - # You may use [Boolean - # operators](https://developers.google.com/custom-search/docs/ - # xml_results_appendices#booleanOperators) - # in the cr parameter's value. - # Google Search determines the country of a document by analyzing: - # * the top-level domain (TLD) of the document's URL - # * the geographic location of the Web server's IP address - # See the [Country Parameter - # Values](https://developers.google.com/custom-search/docs/ - # xml_results_appendices#countryCollections) - # page for a list of valid values for this parameter. + # Restricts search results to documents originating in a particular country. You + # may use [Boolean operators](https://developers.google.com/custom-search/docs/ + # xml_results_appendices#booleanOperators) in the cr parameter's value. Google + # Search determines the country of a document by analyzing: * the top-level + # domain (TLD) of the document's URL * the geographic location of the Web server' + # s IP address See the [Country Parameter Values](https://developers.google.com/ + # custom-search/docs/xml_results_appendices#countryCollections) page for a list + # of valid values for this parameter. # @param [String] cx # The Programmable Search Engine ID to use for this request. # @param [String] date_restrict - # Restricts results to URLs based on date. Supported values include: - # * `d[number]`: requests results from the specified number of past days. - # * `w[number]`: requests results from the specified number of past weeks. - # * `m[number]`: requests results from the specified number of past months. - # * `y[number]`: requests results from the specified number of past years. + # Restricts results to URLs based on date. Supported values include: * `d[number] + # `: requests results from the specified number of past days. * `w[number]`: + # requests results from the specified number of past weeks. * `m[number]`: + # requests results from the specified number of past months. * `y[number]`: + # requests results from the specified number of past years. # @param [String] exact_terms # Identifies a phrase that all documents in the search results must contain. # @param [String] exclude_terms @@ -365,144 +279,80 @@ module Google # search results. # @param [String] file_type # Restricts results to files of a specified extension. A list of file types - # indexable by Google can be found in Search Console [Help - # Center](https://support.google.com/webmasters/answer/35287). + # indexable by Google can be found in Search Console [Help Center](https:// + # support.google.com/webmasters/answer/35287). # @param [String] filter - # Controls turning on or off the duplicate content filter. - # * See [Automatic + # Controls turning on or off the duplicate content filter. * See [Automatic # Filtering](https://developers.google.com/custom-search/docs/xml_results# - # automaticFiltering) - # for more information about Google's search results filters. Note that host - # crowding filtering applies only to multi-site searches. - # * By default, Google applies filtering to all search results to improve the - # quality of those results. - # Acceptable values are: - # * `0`: Turns off duplicate content filter. - # * `1`: Turns on duplicate content filter. + # automaticFiltering) for more information about Google's search results filters. + # Note that host crowding filtering applies only to multi-site searches. * By + # default, Google applies filtering to all search results to improve the quality + # of those results. Acceptable values are: * `0`: Turns off duplicate content + # filter. * `1`: Turns on duplicate content filter. # @param [String] gl - # Geolocation of end user. - # * The `gl` parameter value is a two-letter country code. The `gl` parameter - # boosts search results whose country of origin matches the parameter value. - # See the [Country - # Codes](https://developers.google.com/custom-search/docs/xml_results_appendices# - # countryCodes) - # page for a list of valid values. - # * Specifying a `gl` parameter value should lead to more relevant results. - # This is particularly true for international customers and, even more + # Geolocation of end user. * The `gl` parameter value is a two-letter country + # code. The `gl` parameter boosts search results whose country of origin matches + # the parameter value. See the [Country Codes](https://developers.google.com/ + # custom-search/docs/xml_results_appendices#countryCodes) page for a list of + # valid values. * Specifying a `gl` parameter value should lead to more relevant + # results. This is particularly true for international customers and, even more # specifically, for customers in English- speaking countries other than the # United States. # @param [String] googlehost - # **Deprecated**. Use the `gl` parameter for a similar effect. - # The local Google domain (for example, google.com, google.de, or - # google.fr) to use to perform the search. + # **Deprecated**. Use the `gl` parameter for a similar effect. The local Google + # domain (for example, google.com, google.de, or google.fr) to use to perform + # the search. # @param [String] high_range - # Specifies the ending value for a search range. - # * Use `lowRange` and `highRange` to append an inclusive search range of - # `lowRange...highRange` to the query. + # Specifies the ending value for a search range. * Use `lowRange` and `highRange` + # to append an inclusive search range of `lowRange...highRange` to the query. # @param [String] hl - # Sets the user interface language. - # * Explicitly setting this parameter improves the performance and the - # quality of your search results. - # * See the [Interface + # Sets the user interface language. * Explicitly setting this parameter improves + # the performance and the quality of your search results. * See the [Interface # Languages](https://developers.google.com/custom-search/docs/xml_results# - # wsInterfaceLanguages) - # section of [Internationalizing Queries and Results + # wsInterfaceLanguages) section of [Internationalizing Queries and Results # Presentation](https://developers.google.com/custom-search/docs/xml_results# - # wsInternationalizing) - # for more information, and (Supported Interface - # Languages)[https://developers.google.com/custom-search/docs/ - # xml_results_appendices#interfaceLanguages] - # for a list of supported languages. + # wsInternationalizing) for more information, and (Supported Interface Languages) + # [https://developers.google.com/custom-search/docs/xml_results_appendices# + # interfaceLanguages] for a list of supported languages. # @param [String] hq - # Appends the specified query terms to the query, as if they were combined - # with a logical AND operator. + # Appends the specified query terms to the query, as if they were combined with + # a logical AND operator. # @param [String] img_color_type - # Returns black and white, grayscale, transparent, or color images. - # Acceptable values are: - # * `"color"` - # * `"gray"` - # * `"mono"`: black and white - # * `"trans"`: transparent background + # Returns black and white, grayscale, transparent, or color images. Acceptable + # values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: + # transparent background # @param [String] img_dominant_color - # Returns images of a specific dominant color. Acceptable values are: - # * `"black"` - # * `"blue"` - # * `"brown"` - # * `"gray"` - # * `"green"` - # * `"orange"` - # * `"pink"` - # * `"purple"` - # * `"red"` - # * `"teal"` - # * `"white"` - # * `"yellow"` + # Returns images of a specific dominant color. Acceptable values are: * `"black"` + # * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `" + # purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` # @param [String] img_size - # Returns images of a specified size. Acceptable values are: - # * `"huge"` - # * `"icon"` - # * `"large"` - # * `"medium"` - # * `"small"` - # * `"xlarge"` - # * `"xxlarge"` + # Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon" + # ` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` # @param [String] img_type - # Returns images of a type. Acceptable values are: - # * `"clipart"` - # * `"face"` - # * `"lineart"` - # * `"stock"` - # * `"photo"` - # * `"animated"` + # Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `" + # lineart"` * `"stock"` * `"photo"` * `"animated"` # @param [String] link_site - # Specifies that all search results should contain a link to a particular - # URL. + # Specifies that all search results should contain a link to a particular URL. # @param [String] low_range - # Specifies the starting value for a search range. Use `lowRange` and - # `highRange` to append an inclusive search range of `lowRange...highRange` - # to the query. + # Specifies the starting value for a search range. Use `lowRange` and `highRange` + # to append an inclusive search range of `lowRange...highRange` to the query. # @param [String] lr - # Restricts the search to documents written in a particular language (e.g., - # `lr=lang_ja`). - # Acceptable values are: - # * `"lang_ar"`: Arabic - # * `"lang_bg"`: Bulgarian - # * `"lang_ca"`: Catalan - # * `"lang_cs"`: Czech - # * `"lang_da"`: Danish - # * `"lang_de"`: German - # * `"lang_el"`: Greek - # * `"lang_en"`: English - # * `"lang_es"`: Spanish - # * `"lang_et"`: Estonian - # * `"lang_fi"`: Finnish - # * `"lang_fr"`: French - # * `"lang_hr"`: Croatian - # * `"lang_hu"`: Hungarian - # * `"lang_id"`: Indonesian - # * `"lang_is"`: Icelandic - # * `"lang_it"`: Italian - # * `"lang_iw"`: Hebrew - # * `"lang_ja"`: Japanese - # * `"lang_ko"`: Korean - # * `"lang_lt"`: Lithuanian - # * `"lang_lv"`: Latvian - # * `"lang_nl"`: Dutch - # * `"lang_no"`: Norwegian - # * `"lang_pl"`: Polish - # * `"lang_pt"`: Portuguese - # * `"lang_ro"`: Romanian - # * `"lang_ru"`: Russian - # * `"lang_sk"`: Slovak - # * `"lang_sl"`: Slovenian - # * `"lang_sr"`: Serbian - # * `"lang_sv"`: Swedish - # * `"lang_tr"`: Turkish - # * `"lang_zh-CN"`: Chinese (Simplified) - # * `"lang_zh-TW"`: Chinese (Traditional) + # Restricts the search to documents written in a particular language (e.g., `lr= + # lang_ja`). Acceptable values are: * `"lang_ar"`: Arabic * `"lang_bg"`: + # Bulgarian * `"lang_ca"`: Catalan * `"lang_cs"`: Czech * `"lang_da"`: Danish * ` + # "lang_de"`: German * `"lang_el"`: Greek * `"lang_en"`: English * `"lang_es"`: + # Spanish * `"lang_et"`: Estonian * `"lang_fi"`: Finnish * `"lang_fr"`: French * + # `"lang_hr"`: Croatian * `"lang_hu"`: Hungarian * `"lang_id"`: Indonesian * `" + # lang_is"`: Icelandic * `"lang_it"`: Italian * `"lang_iw"`: Hebrew * `"lang_ja"` + # : Japanese * `"lang_ko"`: Korean * `"lang_lt"`: Lithuanian * `"lang_lv"`: + # Latvian * `"lang_nl"`: Dutch * `"lang_no"`: Norwegian * `"lang_pl"`: Polish * ` + # "lang_pt"`: Portuguese * `"lang_ro"`: Romanian * `"lang_ru"`: Russian * `" + # lang_sk"`: Slovak * `"lang_sl"`: Slovenian * `"lang_sr"`: Serbian * `"lang_sv"` + # : Swedish * `"lang_tr"`: Turkish * `"lang_zh-CN"`: Chinese (Simplified) * `" + # lang_zh-TW"`: Chinese (Traditional) # @param [Fixnum] num - # Number of search results to return. - # * Valid values are integers between 1 and 10, inclusive. + # Number of search results to return. * Valid values are integers between 1 and + # 10, inclusive. # @param [String] or_terms # Provides additional search terms to check for in a document, where each # document in the search results must contain at least one of the additional @@ -513,42 +363,35 @@ module Google # Specifies that all search results should be pages that are related to the # specified URL. # @param [String] rights - # Filters based on licensing. Supported values include: `cc_publicdomain`, - # `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and - # combinations of these. See [typical - # combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration). + # Filters based on licensing. Supported values include: `cc_publicdomain`, ` + # cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and + # combinations of these. See [typical combinations](https://wiki.creativecommons. + # org/wiki/CC_Search_integration). # @param [String] safe - # Search safety level. Acceptable values are: - # * `"active"`: Enables SafeSearch filtering. - # * `"off"`: Disables SafeSearch filtering. (default) + # Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch + # filtering. * `"off"`: Disables SafeSearch filtering. (default) # @param [String] search_type # Specifies the search type: `image`. If unspecified, results are limited to - # webpages. - # Acceptable values are: - # * `"image"`: custom image search. + # webpages. Acceptable values are: * `"image"`: custom image search. # @param [String] site_search # Specifies a given site which should always be included or excluded from # results (see `siteSearchFilter` parameter, below). # @param [String] site_search_filter - # Controls whether to include or exclude results from the site named in the - # `siteSearch` parameter. - # Acceptable values are: - # * `"e"`: exclude - # * `"i"`: include + # Controls whether to include or exclude results from the site named in the ` + # siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: + # include # @param [String] sort - # The sort expression to apply to the results. The sort parameter specifies - # that the results be sorted according to the specified expression i.e. sort - # by date. - # [Example: - # sort=date](https://developers.google.com/custom-search/docs/structured_search# - # sort-by-attribute). + # The sort expression to apply to the results. The sort parameter specifies that + # the results be sorted according to the specified expression i.e. sort by date. + # [Example: sort=date](https://developers.google.com/custom-search/docs/ + # structured_search#sort-by-attribute). # @param [Fixnum] start # The index of the first result to return. The default number of results per # page is 10, so `&start=11` would start at the top of the second page of - # results. **Note**: The JSON API will never return more than 100 results, - # even if more than 100 documents match the query, so setting the sum of - # `start + num` to a number greater than 100 will produce an error. Also note - # that the maximum value for `num` is 10. + # results. **Note**: The JSON API will never return more than 100 results, even + # if more than 100 documents match the query, so setting the sum of `start + num` + # to a number greater than 100 will produce an error. Also note that the + # maximum value for `num` is 10. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/datafusion_v1.rb b/generated/google/apis/datafusion_v1.rb new file mode 100644 index 000000000..7f74963c1 --- /dev/null +++ b/generated/google/apis/datafusion_v1.rb @@ -0,0 +1,43 @@ +# 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/datafusion_v1/service.rb' +require 'google/apis/datafusion_v1/classes.rb' +require 'google/apis/datafusion_v1/representations.rb' + +module Google + module Apis + # Cloud Data Fusion API + # + # Cloud Data Fusion is a fully-managed, cloud native, enterprise data + # integration service for + # quickly building and managing data pipelines. It provides a graphical + # interface to increase + # time efficiency and reduce complexity, and allows business users, + # developers, and data + # scientists to easily and reliably build scalable data integration + # solutions to cleanse, + # prepare, blend, transfer and transform data without having to wrestle with + # infrastructure. + # + # @see https://cloud.google.com/data-fusion/docs + module DatafusionV1 + VERSION = 'V1' + REVISION = '20200609' + + # 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/datafusion_v1/classes.rb b/generated/google/apis/datafusion_v1/classes.rb new file mode 100644 index 000000000..509434f9b --- /dev/null +++ b/generated/google/apis/datafusion_v1/classes.rb @@ -0,0 +1,1154 @@ +# 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 DatafusionV1 + + # Identifies Data Fusion accelerators for an instance. + class Accelerator + include Google::Apis::Core::Hashable + + # The type of an accelator for a CDF instance. + # Corresponds to the JSON property `acceleratorType` + # @return [String] + attr_accessor :accelerator_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @accelerator_type = args[:accelerator_type] if args.key?(:accelerator_type) + 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 AuditConfig + 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 AuditLogConfig + 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 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. + # Corresponds to the JSON property `condition` + # @return [Google::Apis::DatafusionV1::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`. + # 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 CancelOperationRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + 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 + + # 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. + # 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 + + # Represents a Data Fusion instance. + # Next available ID: 23 + class Instance + include Google::Apis::Core::Hashable + + # List of accelerators enabled for this CDF instance. + # Corresponds to the JSON property `accelerators` + # @return [Array] + attr_accessor :accelerators + + # Output only. Endpoint on which the REST APIs is accessible. + # Corresponds to the JSON property `apiEndpoint` + # @return [String] + attr_accessor :api_endpoint + + # Available versions that the instance can be upgraded to using + # UpdateInstanceRequest. + # Corresponds to the JSON property `availableVersion` + # @return [Array] + attr_accessor :available_version + + # Output only. The time the instance was created. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # A description of this instance. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Display name for an instance. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Option to enable Stackdriver Logging. + # Corresponds to the JSON property `enableStackdriverLogging` + # @return [Boolean] + attr_accessor :enable_stackdriver_logging + alias_method :enable_stackdriver_logging?, :enable_stackdriver_logging + + # Option to enable Stackdriver Monitoring. + # Corresponds to the JSON property `enableStackdriverMonitoring` + # @return [Boolean] + attr_accessor :enable_stackdriver_monitoring + alias_method :enable_stackdriver_monitoring?, :enable_stackdriver_monitoring + + # Output only. Cloud Storage bucket generated by Data Fusion in the customer + # project. + # Corresponds to the JSON property `gcsBucket` + # @return [String] + attr_accessor :gcs_bucket + + # The resource labels for instance to use to annotate any related underlying + # resources such as GCE VMs. The character '=' is not allowed to be used + # within the labels. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # Output only. The name of this instance is in the form of + # projects/`project`/locations/`location`/instances/`instance`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Network configuration for a Data Fusion instance. These configurations + # are used for peering with the customer network. Configurations are optional + # when a public Data Fusion instance is to be created. However, providing + # these configurations allows several benefits, such as reduced network latency + # while accessing the customer resources from managed Data Fusion instance + # nodes, as well as access to the customer on-prem resources. + # Corresponds to the JSON property `networkConfig` + # @return [Google::Apis::DatafusionV1::NetworkConfig] + attr_accessor :network_config + + # Map of additional options used to configure the behavior of + # Data Fusion instance. + # Corresponds to the JSON property `options` + # @return [Hash] + attr_accessor :options + + # Specifies whether the Data Fusion instance should be private. If set to + # true, all Data Fusion nodes will have private IP addresses and will not be + # able to access the public internet. + # Corresponds to the JSON property `privateInstance` + # @return [Boolean] + attr_accessor :private_instance + alias_method :private_instance?, :private_instance + + # Output only. Service account which will be used to access resources in + # the customer project." + # Corresponds to the JSON property `serviceAccount` + # @return [String] + attr_accessor :service_account + + # Output only. Endpoint on which the Data Fusion UI is accessible. + # Corresponds to the JSON property `serviceEndpoint` + # @return [String] + attr_accessor :service_endpoint + + # Output only. The current state of this Data Fusion instance. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # Output only. Additional information about the current state of this Data + # Fusion instance if available. + # Corresponds to the JSON property `stateMessage` + # @return [String] + attr_accessor :state_message + + # Required. Instance type. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # Output only. The time the instance was last updated. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + + # Current version of the Data Fusion. Only specifiable in Update. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + + # Name of the zone in which the Data Fusion instance will be created. Only + # DEVELOPER instances use this field. + # Corresponds to the JSON property `zone` + # @return [String] + attr_accessor :zone + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @accelerators = args[:accelerators] if args.key?(:accelerators) + @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) + @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) + @enable_stackdriver_monitoring = args[:enable_stackdriver_monitoring] if args.key?(:enable_stackdriver_monitoring) + @gcs_bucket = args[:gcs_bucket] if args.key?(:gcs_bucket) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + @network_config = args[:network_config] if args.key?(:network_config) + @options = args[:options] if args.key?(:options) + @private_instance = args[:private_instance] if args.key?(:private_instance) + @service_account = args[:service_account] if args.key?(:service_account) + @service_endpoint = args[:service_endpoint] if args.key?(:service_endpoint) + @state = args[:state] if args.key?(:state) + @state_message = args[:state_message] if args.key?(:state_message) + @type = args[:type] if args.key?(:type) + @update_time = args[:update_time] if args.key?(:update_time) + @version = args[:version] if args.key?(:version) + @zone = args[:zone] if args.key?(:zone) + end + end + + # Response message for the list available versions request. + class ListAvailableVersionsResponse + include Google::Apis::Core::Hashable + + # Represents a list of versions that are supported. + # Corresponds to the JSON property `availableVersions` + # @return [Array] + attr_accessor :available_versions + + # Token to retrieve the next page of results or empty if there are no more + # results in the list. + # 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) + @available_versions = args[:available_versions] if args.key?(:available_versions) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Response message for the list instance request. + class ListInstancesResponse + include Google::Apis::Core::Hashable + + # Represents a list of Data Fusion instances. + # Corresponds to the JSON property `instances` + # @return [Array] + attr_accessor :instances + + # Token to retrieve the next page of results or empty if there are no more + # results in the list. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Locations that could not be reached. + # Corresponds to the JSON property `unreachable` + # @return [Array] + attr_accessor :unreachable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @instances = args[:instances] if args.key?(:instances) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @unreachable = args[:unreachable] if args.key?(:unreachable) + 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 + + # The response message for Operations.ListOperations. + class ListOperationsResponse + 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 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 + + # Network configuration for a Data Fusion instance. These configurations + # are used for peering with the customer network. Configurations are optional + # when a public Data Fusion instance is to be created. However, providing + # these configurations allows several benefits, such as reduced network latency + # while accessing the customer resources from managed Data Fusion instance + # nodes, as well as access to the customer on-prem resources. + class NetworkConfig + include Google::Apis::Core::Hashable + + # The IP range in CIDR notation to use for the managed Data Fusion instance + # nodes. This range must not overlap with any other ranges used in the + # customer network. + # Corresponds to the JSON property `ipAllocation` + # @return [String] + attr_accessor :ip_allocation + + # Name of the network in the customer project with which the Tenant Project + # will be peered for executing pipelines. In case of shared VPC where the + # network resides in another host project the network should specified in + # the form of projects/`host-project-id`/global/networks/`network` + # Corresponds to the JSON property `network` + # @return [String] + attr_accessor :network + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ip_allocation = args[:ip_allocation] if args.key?(:ip_allocation) + @network = args[:network] if args.key?(:network) + 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::DatafusionV1::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 + + # Represents the metadata of a long-running operation. + class OperationMetadata + include Google::Apis::Core::Hashable + + # API version used to start the operation. + # Corresponds to the JSON property `apiVersion` + # @return [String] + attr_accessor :api_version + + # The time the operation was created. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # The time the operation finished running. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # 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 + + # Human-readable status of the operation if any. + # Corresponds to the JSON property `statusDetail` + # @return [String] + attr_accessor :status_detail + + # Server-defined resource path for the target of the operation. + # Corresponds to the JSON property `target` + # @return [String] + attr_accessor :target + + # 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) + @end_time = args[:end_time] if args.key?(:end_time) + @requested_cancellation = args[:requested_cancellation] if args.key?(:requested_cancellation) + @status_detail = args[:status_detail] if args.key?(:status_detail) + @target = args[:target] if args.key?(:target) + @verb = args[:verb] if args.key?(:verb) + 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 Policy + 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 restarting a Data Fusion instance. + class RestartInstanceRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Request message for `SetIamPolicy` method. + class SetIamPolicyRequest + 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::DatafusionV1::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"` + # 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 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 + + # Request message for `TestIamPermissions` method. + 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). + # 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 TestIamPermissionsResponse + 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 + + # The Data Fusion version. This proto message stores information about certain + # Data Fusion version, which is used for Data Fusion version upgrade. + class Version + include Google::Apis::Core::Hashable + + # Whether this is currently the default version for Cloud Data Fusion + # Corresponds to the JSON property `defaultVersion` + # @return [Boolean] + attr_accessor :default_version + alias_method :default_version?, :default_version + + # The version number of the Data Fusion instance, such as '6.0.1.0'. + # Corresponds to the JSON property `versionNumber` + # @return [String] + attr_accessor :version_number + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @default_version = args[:default_version] if args.key?(:default_version) + @version_number = args[:version_number] if args.key?(:version_number) + end + end + end + end +end diff --git a/generated/google/apis/datafusion_v1/representations.rb b/generated/google/apis/datafusion_v1/representations.rb new file mode 100644 index 000000000..6cebf8e7f --- /dev/null +++ b/generated/google/apis/datafusion_v1/representations.rb @@ -0,0 +1,390 @@ +# 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 DatafusionV1 + + class Accelerator + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuditConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuditLogConfig + 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 CancelOperationRequest + 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 Expr + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Instance + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListAvailableVersionsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListInstancesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListLocationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListOperationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Location + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class NetworkConfig + 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 OperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Policy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RestartInstanceRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SetIamPolicyRequest + 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 TestIamPermissionsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TestIamPermissionsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Version + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Accelerator + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :accelerator_type, as: 'acceleratorType' + end + end + + class AuditConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::DatafusionV1::AuditLogConfig, decorator: Google::Apis::DatafusionV1::AuditLogConfig::Representation + + property :service, as: 'service' + end + end + + class AuditLogConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :exempted_members, as: 'exemptedMembers' + property :log_type, as: 'logType' + end + end + + class Binding + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :condition, as: 'condition', class: Google::Apis::DatafusionV1::Expr, decorator: Google::Apis::DatafusionV1::Expr::Representation + + collection :members, as: 'members' + property :role, as: 'role' + end + end + + class CancelOperationRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class Empty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class Expr + # @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 Instance + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :accelerators, as: 'accelerators', class: Google::Apis::DatafusionV1::Accelerator, decorator: Google::Apis::DatafusionV1::Accelerator::Representation + + property :api_endpoint, as: 'apiEndpoint' + collection :available_version, as: 'availableVersion', class: Google::Apis::DatafusionV1::Version, decorator: Google::Apis::DatafusionV1::Version::Representation + + property :create_time, as: 'createTime' + property :description, as: 'description' + property :display_name, as: 'displayName' + property :enable_stackdriver_logging, as: 'enableStackdriverLogging' + property :enable_stackdriver_monitoring, as: 'enableStackdriverMonitoring' + property :gcs_bucket, as: 'gcsBucket' + hash :labels, as: 'labels' + property :name, as: 'name' + property :network_config, as: 'networkConfig', class: Google::Apis::DatafusionV1::NetworkConfig, decorator: Google::Apis::DatafusionV1::NetworkConfig::Representation + + hash :options, as: 'options' + property :private_instance, as: 'privateInstance' + property :service_account, as: 'serviceAccount' + property :service_endpoint, as: 'serviceEndpoint' + property :state, as: 'state' + property :state_message, as: 'stateMessage' + property :type, as: 'type' + property :update_time, as: 'updateTime' + property :version, as: 'version' + property :zone, as: 'zone' + end + end + + class ListAvailableVersionsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :available_versions, as: 'availableVersions', class: Google::Apis::DatafusionV1::Version, decorator: Google::Apis::DatafusionV1::Version::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListInstancesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :instances, as: 'instances', class: Google::Apis::DatafusionV1::Instance, decorator: Google::Apis::DatafusionV1::Instance::Representation + + property :next_page_token, as: 'nextPageToken' + collection :unreachable, as: 'unreachable' + end + end + + class ListLocationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :locations, as: 'locations', class: Google::Apis::DatafusionV1::Location, decorator: Google::Apis::DatafusionV1::Location::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListOperationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :operations, as: 'operations', class: Google::Apis::DatafusionV1::Operation, decorator: Google::Apis::DatafusionV1::Operation::Representation + + 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 NetworkConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :ip_allocation, as: 'ipAllocation' + property :network, as: 'network' + end + end + + class Operation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :done, as: 'done' + property :error, as: 'error', class: Google::Apis::DatafusionV1::Status, decorator: Google::Apis::DatafusionV1::Status::Representation + + hash :metadata, as: 'metadata' + property :name, as: 'name' + hash :response, as: 'response' + end + end + + class OperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :api_version, as: 'apiVersion' + property :create_time, as: 'createTime' + property :end_time, as: 'endTime' + property :requested_cancellation, as: 'requestedCancellation' + property :status_detail, as: 'statusDetail' + property :target, as: 'target' + property :verb, as: 'verb' + end + end + + class Policy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audit_configs, as: 'auditConfigs', class: Google::Apis::DatafusionV1::AuditConfig, decorator: Google::Apis::DatafusionV1::AuditConfig::Representation + + collection :bindings, as: 'bindings', class: Google::Apis::DatafusionV1::Binding, decorator: Google::Apis::DatafusionV1::Binding::Representation + + property :etag, :base64 => true, as: 'etag' + property :version, as: 'version' + end + end + + class RestartInstanceRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class SetIamPolicyRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :policy, as: 'policy', class: Google::Apis::DatafusionV1::Policy, decorator: Google::Apis::DatafusionV1::Policy::Representation + + property :update_mask, as: 'updateMask' + 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 + + class TestIamPermissionsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end + + class TestIamPermissionsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end + + class Version + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :default_version, as: 'defaultVersion' + property :version_number, as: 'versionNumber' + end + end + end + end +end diff --git a/generated/google/apis/datafusion_v1/service.rb b/generated/google/apis/datafusion_v1/service.rb new file mode 100644 index 000000000..77c909535 --- /dev/null +++ b/generated/google/apis/datafusion_v1/service.rb @@ -0,0 +1,680 @@ +# 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 DatafusionV1 + # Cloud Data Fusion API + # + # Cloud Data Fusion is a fully-managed, cloud native, enterprise data + # integration service for + # quickly building and managing data pipelines. It provides a graphical + # interface to increase + # time efficiency and reduce complexity, and allows business users, + # developers, and data + # scientists to easily and reliably build scalable data integration + # solutions to cleanse, + # prepare, blend, transfer and transform data without having to wrestle with + # infrastructure. + # + # @example + # require 'google/apis/datafusion_v1' + # + # Datafusion = Google::Apis::DatafusionV1 # Alias the module + # service = Datafusion::DataFusionService.new + # + # @see https://cloud.google.com/data-fusion/docs + class DataFusionService < 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://datafusion.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::DatafusionV1::Location] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DatafusionV1::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::DatafusionV1::Location::Representation + command.response_class = Google::Apis::DatafusionV1::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 [Boolean] include_unrevealed_locations + # If true, the returned list will include locations which are not yet + # revealed. + # @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::DatafusionV1::ListLocationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DatafusionV1::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, include_unrevealed_locations: 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::DatafusionV1::ListLocationsResponse::Representation + command.response_class = Google::Apis::DatafusionV1::ListLocationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['includeUnrevealedLocations'] = include_unrevealed_locations unless include_unrevealed_locations.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 Data Fusion instance in the specified project and location. + # @param [String] parent + # The instance's project and location in the format + # projects/`project`/locations/`location`. + # @param [Google::Apis::DatafusionV1::Instance] instance_object + # @param [String] instance_id + # The name of the instance to create. + # @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::DatafusionV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DatafusionV1::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_project_location_instance(parent, instance_object = nil, instance_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/instances', options) + command.request_representation = Google::Apis::DatafusionV1::Instance::Representation + command.request_object = instance_object + command.response_representation = Google::Apis::DatafusionV1::Operation::Representation + command.response_class = Google::Apis::DatafusionV1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['instanceId'] = instance_id unless instance_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 Date Fusion instance. + # @param [String] name + # The instance resource name in the format + # projects/`project`/locations/`location`/instances/`instance` + # @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::DatafusionV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DatafusionV1::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_project_location_instance(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::DatafusionV1::Operation::Representation + command.response_class = Google::Apis::DatafusionV1::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 details of a single Data Fusion instance. + # @param [String] name + # The instance resource name in the format + # projects/`project`/locations/`location`/instances/`instance`. + # @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::DatafusionV1::Instance] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DatafusionV1::Instance] + # + # @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_instance(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::DatafusionV1::Instance::Representation + command.response_class = Google::Apis::DatafusionV1::Instance + 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::DatafusionV1::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DatafusionV1::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_instance_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::DatafusionV1::Policy::Representation + command.response_class = Google::Apis::DatafusionV1::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 + + # Lists Data Fusion instances in the specified project and location. + # @param [String] parent + # The project and location for which to retrieve instance information + # in the format projects/`project`/locations/`location`. If the location is + # specified as '-' (wildcard), then all regions available to the project + # are queried, and the results are aggregated. + # @param [String] filter + # List filter. + # @param [String] order_by + # Sort results. Supported values are "name", "name desc", or "" (unsorted). + # @param [Fixnum] page_size + # The maximum number of items to return. + # @param [String] page_token + # The next_page_token value to use if there are additional + # results to retrieve for this 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::DatafusionV1::ListInstancesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DatafusionV1::ListInstancesResponse] + # + # @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_instances(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, 'v1/{+parent}/instances', options) + command.response_representation = Google::Apis::DatafusionV1::ListInstancesResponse::Representation + command.response_class = Google::Apis::DatafusionV1::ListInstancesResponse + 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 a single Data Fusion instance. + # @param [String] name + # Output only. The name of this instance is in the form of + # projects/`project`/locations/`location`/instances/`instance`. + # @param [Google::Apis::DatafusionV1::Instance] instance_object + # @param [String] update_mask + # Field mask is used to specify the fields that the update will overwrite + # in an instance resource. 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, all the supported fields (labels, + # options, and version currently) 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::DatafusionV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DatafusionV1::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_project_location_instance(name, instance_object = 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::DatafusionV1::Instance::Representation + command.request_object = instance_object + command.response_representation = Google::Apis::DatafusionV1::Operation::Representation + command.response_class = Google::Apis::DatafusionV1::Operation + 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 + + # Restart a single Data Fusion instance. + # At the end of an operation instance is fully restarted. + # @param [String] name + # Name of the Data Fusion instance which need to be restarted in the form of + # projects/`project`/locations/`location`/instances/`instance` + # @param [Google::Apis::DatafusionV1::RestartInstanceRequest] restart_instance_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::DatafusionV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DatafusionV1::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 restart_instance(name, restart_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:restart', options) + command.request_representation = Google::Apis::DatafusionV1::RestartInstanceRequest::Representation + command.request_object = restart_instance_request_object + command.response_representation = Google::Apis::DatafusionV1::Operation::Representation + command.response_class = Google::Apis::DatafusionV1::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 + + # 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::DatafusionV1::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::DatafusionV1::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DatafusionV1::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_instance_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::DatafusionV1::SetIamPolicyRequest::Representation + command.request_object = set_iam_policy_request_object + command.response_representation = Google::Apis::DatafusionV1::Policy::Representation + command.response_class = Google::Apis::DatafusionV1::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::DatafusionV1::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::DatafusionV1::TestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DatafusionV1::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_instance_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::DatafusionV1::TestIamPermissionsRequest::Representation + command.request_object = test_iam_permissions_request_object + command.response_representation = Google::Apis::DatafusionV1::TestIamPermissionsResponse::Representation + command.response_class = Google::Apis::DatafusionV1::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 + + # 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::DatafusionV1::CancelOperationRequest] 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::DatafusionV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DatafusionV1::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_operation(name, cancel_operation_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::DatafusionV1::CancelOperationRequest::Representation + command.request_object = cancel_operation_request_object + command.response_representation = Google::Apis::DatafusionV1::Empty::Representation + command.response_class = Google::Apis::DatafusionV1::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::DatafusionV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DatafusionV1::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, 'v1/{+name}', options) + command.response_representation = Google::Apis::DatafusionV1::Empty::Representation + command.response_class = Google::Apis::DatafusionV1::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::DatafusionV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DatafusionV1::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_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::DatafusionV1::Operation::Representation + command.response_class = Google::Apis::DatafusionV1::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 + + # 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::DatafusionV1::ListOperationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DatafusionV1::ListOperationsResponse] + # + # @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, 'v1/{+name}/operations', options) + command.response_representation = Google::Apis::DatafusionV1::ListOperationsResponse::Representation + command.response_class = Google::Apis::DatafusionV1::ListOperationsResponse + 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 + + # Lists possible versions for Data Fusion instances in the specified project + # and location. + # @param [String] parent + # Required. The project and location for which to retrieve instance information + # in the format projects/`project`/locations/`location`. + # @param [Boolean] latest_patch_only + # Whether or not to return the latest patch of every available minor version. + # If true, only the latest patch will be returned. Ex. if allowed versions is + # [6.1.1, 6.1.2, 6.2.0] then response will be [6.1.2, 6.2.0] + # @param [Fixnum] page_size + # The maximum number of items to return. + # @param [String] page_token + # The next_page_token value to use if there are additional + # results to retrieve for this 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::DatafusionV1::ListAvailableVersionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DatafusionV1::ListAvailableVersionsResponse] + # + # @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_versions(parent, latest_patch_only: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/versions', options) + command.response_representation = Google::Apis::DatafusionV1::ListAvailableVersionsResponse::Representation + command.response_class = Google::Apis::DatafusionV1::ListAvailableVersionsResponse + command.params['parent'] = parent unless parent.nil? + command.query['latestPatchOnly'] = latest_patch_only unless latest_patch_only.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/domainsrdap_v1.rb b/generated/google/apis/domainsrdap_v1.rb index f4049378e..0a9b7e972 100644 --- a/generated/google/apis/domainsrdap_v1.rb +++ b/generated/google/apis/domainsrdap_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/domains/rdap/ module DomainsrdapV1 VERSION = 'V1' - REVISION = '20200218' + REVISION = '20200803' end end end diff --git a/generated/google/apis/domainsrdap_v1/classes.rb b/generated/google/apis/domainsrdap_v1/classes.rb index 1130ddcae..4ff70c162 100644 --- a/generated/google/apis/domainsrdap_v1/classes.rb +++ b/generated/google/apis/domainsrdap_v1/classes.rb @@ -23,34 +23,21 @@ module Google module DomainsrdapV1 # Message that represents an arbitrary HTTP body. It should only be used for - # payload formats that can't be represented as JSON, such as raw binary or - # an HTML page. - # This message can be used both in streaming and non-streaming API methods in - # the request as well as the response. - # It can be used as a top-level request field, which is convenient if one - # wants to extract parameters from either the URL or HTTP template into the - # request fields and also want access to the raw HTTP body. - # Example: - # message GetResourceRequest ` - # // A unique request id. - # string request_id = 1; - # // The raw HTTP body is bound to this field. - # google.api.HttpBody http_body = 2; - # ` - # service ResourceService ` - # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); - # rpc UpdateResource(google.api.HttpBody) returns - # (google.protobuf.Empty); - # ` - # Example with streaming methods: - # service CaldavService ` - # rpc GetCalendar(stream google.api.HttpBody) - # returns (stream google.api.HttpBody); - # rpc UpdateCalendar(stream google.api.HttpBody) - # returns (stream google.api.HttpBody); - # ` - # Use of this type only changes how the request and response bodies are - # handled, all other features will continue to work unchanged. + # payload formats that can't be represented as JSON, such as raw binary or an + # HTML page. This message can be used both in streaming and non-streaming API + # methods in the request as well as the response. It can be used as a top-level + # request field, which is convenient if one wants to extract parameters from + # either the URL or HTTP template into the request fields and also want access + # to the raw HTTP body. Example: message GetResourceRequest ` // A unique + # request id. string request_id = 1; // The raw HTTP body is bound to this field. + # google.api.HttpBody http_body = 2; ` service ResourceService ` rpc + # GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + # UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); ` Example + # with streaming methods: service CaldavService ` rpc GetCalendar(stream google. + # api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream + # google.api.HttpBody) returns (stream google.api.HttpBody); ` Use of this type + # only changes how the request and response bodies are handled, all other + # features will continue to work unchanged. class HttpBody include Google::Apis::Core::Hashable @@ -65,8 +52,8 @@ module Google # @return [String] attr_accessor :data - # Application specific response metadata. Must be set in the first response - # for streaming APIs. + # Application specific response metadata. Must be set in the first response for + # streaming APIs. # Corresponds to the JSON property `extensions` # @return [Array>] attr_accessor :extensions @@ -83,8 +70,8 @@ module Google end end - # Links object defined in [section 4.2 of RFC - # 7483](https://tools.ietf.org/html/rfc7483#section-4.2). + # Links object defined in [section 4.2 of RFC 7483](https://tools.ietf.org/html/ + # rfc7483#section-4.2). class Link include Google::Apis::Core::Hashable @@ -139,8 +126,8 @@ module Google end end - # Notices object defined in [section 4.3 of RFC - # 7483](https://tools.ietf.org/html/rfc7483#section-4.3). + # Notices object defined in [section 4.3 of RFC 7483](https://tools.ietf.org/ + # html/rfc7483#section-4.3). class Notice include Google::Apis::Core::Hashable @@ -159,11 +146,10 @@ module Google # @return [String] attr_accessor :title - # Type values defined in [section 10.2.1 of RFC - # 7483](https://tools.ietf.org/html/rfc7483#section-10.2.1) specific to a - # whole response: "result set truncated due to authorization", "result set - # truncated due to excessive load", "result set truncated due to - # unexplainable reasons". + # Type values defined in [section 10.2.1 of RFC 7483](https://tools.ietf.org/ + # html/rfc7483#section-10.2.1) specific to a whole response: "result set + # truncated due to authorization", "result set truncated due to excessive load", + # "result set truncated due to unexplainable reasons". # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -196,40 +182,27 @@ module Google attr_accessor :error_code # Message that represents an arbitrary HTTP body. It should only be used for - # payload formats that can't be represented as JSON, such as raw binary or - # an HTML page. - # This message can be used both in streaming and non-streaming API methods in - # the request as well as the response. - # It can be used as a top-level request field, which is convenient if one - # wants to extract parameters from either the URL or HTTP template into the - # request fields and also want access to the raw HTTP body. - # Example: - # message GetResourceRequest ` - # // A unique request id. - # string request_id = 1; - # // The raw HTTP body is bound to this field. - # google.api.HttpBody http_body = 2; - # ` - # service ResourceService ` - # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); - # rpc UpdateResource(google.api.HttpBody) returns - # (google.protobuf.Empty); - # ` - # Example with streaming methods: - # service CaldavService ` - # rpc GetCalendar(stream google.api.HttpBody) - # returns (stream google.api.HttpBody); - # rpc UpdateCalendar(stream google.api.HttpBody) - # returns (stream google.api.HttpBody); - # ` - # Use of this type only changes how the request and response bodies are - # handled, all other features will continue to work unchanged. + # payload formats that can't be represented as JSON, such as raw binary or an + # HTML page. This message can be used both in streaming and non-streaming API + # methods in the request as well as the response. It can be used as a top-level + # request field, which is convenient if one wants to extract parameters from + # either the URL or HTTP template into the request fields and also want access + # to the raw HTTP body. Example: message GetResourceRequest ` // A unique + # request id. string request_id = 1; // The raw HTTP body is bound to this field. + # google.api.HttpBody http_body = 2; ` service ResourceService ` rpc + # GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + # UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); ` Example + # with streaming methods: service CaldavService ` rpc GetCalendar(stream google. + # api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream + # google.api.HttpBody) returns (stream google.api.HttpBody); ` Use of this type + # only changes how the request and response bodies are handled, all other + # features will continue to work unchanged. # Corresponds to the JSON property `jsonResponse` # @return [Google::Apis::DomainsrdapV1::HttpBody] attr_accessor :json_response - # Error language code. Error response info fields are defined in [section 6 - # of RFC 7483](https://tools.ietf.org/html/rfc7483#section-6). + # Error language code. Error response info fields are defined in [section 6 of + # RFC 7483](https://tools.ietf.org/html/rfc7483#section-6). # Corresponds to the JSON property `lang` # @return [String] attr_accessor :lang diff --git a/generated/google/apis/domainsrdap_v1/service.rb b/generated/google/apis/domainsrdap_v1/service.rb index ff2a106c3..a2b2e6c2d 100644 --- a/generated/google/apis/domainsrdap_v1/service.rb +++ b/generated/google/apis/domainsrdap_v1/service.rb @@ -47,8 +47,8 @@ module Google @batch_path = 'batch' end - # The RDAP API recognizes this command from the RDAP specification but - # does not support it. The response is a formatted 501 error. + # The RDAP API recognizes this command from the RDAP specification but does not + # support it. The response is a formatted 501 error. # @param [String] autnum_id # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -107,8 +107,8 @@ module Google execute_or_queue_command(command, &block) end - # The RDAP API recognizes this command from the RDAP specification but - # does not support it. The response is a formatted 501 error. + # The RDAP API recognizes this command from the RDAP specification but does not + # support it. The response is a formatted 501 error. # @param [String] entity_id # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -137,8 +137,8 @@ module Google execute_or_queue_command(command, &block) end - # The RDAP API recognizes this command from the RDAP specification but - # does not support it. The response is a formatted 501 error. + # The RDAP API recognizes this command from the RDAP specification but does not + # support it. The response is a formatted 501 error. # @param [String] ip_id # @param [String] ip_id1 # @param [String] fields @@ -169,8 +169,8 @@ module Google execute_or_queue_command(command, &block) end - # The RDAP API recognizes this command from the RDAP specification but - # does not support it. The response is a formatted 501 error. + # The RDAP API recognizes this command from the RDAP specification but does not + # support it. The response is a formatted 501 error. # @param [String] nameserver_id # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -199,8 +199,8 @@ module Google execute_or_queue_command(command, &block) end - # The RDAP API recognizes this command from the RDAP specification but - # does not support it. The response is a formatted 501 error. + # The RDAP API recognizes this command from the RDAP specification but does not + # support it. The response is a formatted 501 error. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -227,8 +227,8 @@ module Google execute_or_queue_command(command, &block) end - # The RDAP API recognizes this command from the RDAP specification but - # does not support it. The response is a formatted 501 error. + # The RDAP API recognizes this command from the RDAP specification but does not + # support it. The response is a formatted 501 error. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -282,8 +282,8 @@ module Google execute_or_queue_command(command, &block) end - # The RDAP API recognizes this command from the RDAP specification but - # does not support it. The response is a formatted 501 error. + # The RDAP API recognizes this command from the RDAP specification but does not + # support it. The response is a formatted 501 error. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -310,8 +310,8 @@ module Google execute_or_queue_command(command, &block) end - # The RDAP API recognizes this command from the RDAP specification but - # does not support it. The response is a formatted 501 error. + # The RDAP API recognizes this command from the RDAP specification but does not + # support it. The response is a formatted 501 error. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/factchecktools_v1alpha1.rb b/generated/google/apis/factchecktools_v1alpha1.rb index 4030de25a..9b62071a7 100644 --- a/generated/google/apis/factchecktools_v1alpha1.rb +++ b/generated/google/apis/factchecktools_v1alpha1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/fact-check/tools/api/ module FactchecktoolsV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200215' + REVISION = '20200801' # View your email address AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email' diff --git a/generated/google/apis/factchecktools_v1alpha1/classes.rb b/generated/google/apis/factchecktools_v1alpha1/classes.rb index 1cb7e09df..19034c6fc 100644 --- a/generated/google/apis/factchecktools_v1alpha1/classes.rb +++ b/generated/google/apis/factchecktools_v1alpha1/classes.rb @@ -73,7 +73,7 @@ module Google # @return [String] attr_accessor :job_title - # A person or organization stating the claim. For instance, "John Doe".
+ # A person or organization stating the claim. For instance, "John Doe". # Corresponds to `ClaimReview.itemReviewed.author.name`. # Corresponds to the JSON property `name` # @return [String] @@ -101,8 +101,7 @@ module Google class GoogleFactcheckingFactchecktoolsV1alpha1ClaimRating include Google::Apis::Core::Hashable - # For numeric ratings, the best value possible in the scale from worst to - # best.
+ # For numeric ratings, the best value possible in the scale from worst to best. # Corresponds to `ClaimReview.reviewRating.bestRating`. # Corresponds to the JSON property `bestRating` # @return [Fixnum] @@ -119,20 +118,18 @@ module Google attr_accessor :rating_explanation # A numeric rating of this claim, in the range worstRating — bestRating - # inclusive.
- # Corresponds to `ClaimReview.reviewRating.ratingValue`. + # inclusive. Corresponds to `ClaimReview.reviewRating.ratingValue`. # Corresponds to the JSON property `ratingValue` # @return [Fixnum] attr_accessor :rating_value - # The truthfulness rating as a human-readible short word or phrase.
- # Corresponds to `ClaimReview.reviewRating.alternateName`. + # The truthfulness rating as a human-readible short word or phrase. Corresponds + # to `ClaimReview.reviewRating.alternateName`. # Corresponds to the JSON property `textualRating` # @return [String] attr_accessor :textual_rating - # For numeric ratings, the worst value possible in the scale from worst to - # best.
+ # For numeric ratings, the worst value possible in the scale from worst to best. # Corresponds to `ClaimReview.reviewRating.worstRating`. # Corresponds to the JSON property `worstRating` # @return [Fixnum] @@ -211,8 +208,8 @@ module Google # @return [String] attr_accessor :image_url - # Name of the organization that is publishing the fact check.
- # Corresponds to `ClaimReview.author.name`. + # Name of the organization that is publishing the fact check. Corresponds to ` + # ClaimReview.author.name`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -228,16 +225,15 @@ module Google end end - # Fields for an individual `ClaimReview` element. - # Except for sub-messages that group fields together, each of these fields - # correspond those in https://schema.org/ClaimReview. We list the precise - # mapping for each field. + # Fields for an individual `ClaimReview` element. Except for sub-messages that + # group fields together, each of these fields correspond those in https://schema. + # org/ClaimReview. We list the precise mapping for each field. class GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkup include Google::Apis::Core::Hashable # A list of links to works in which this claim appears, aside from the one - # specified in `claim_first_appearance`.
- # Corresponds to `ClaimReview.itemReviewed[@type=Claim].appearance.url`. + # specified in `claim_first_appearance`. Corresponds to `ClaimReview. + # itemReviewed[@type=Claim].appearance.url`. # Corresponds to the JSON property `claimAppearances` # @return [Array] attr_accessor :claim_appearances @@ -247,26 +243,26 @@ module Google # @return [Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimAuthor] attr_accessor :claim_author - # The date when the claim was made or entered public discourse.
- # Corresponds to `ClaimReview.itemReviewed.datePublished`. + # The date when the claim was made or entered public discourse. Corresponds to ` + # ClaimReview.itemReviewed.datePublished`. # Corresponds to the JSON property `claimDate` # @return [String] attr_accessor :claim_date - # A link to a work in which this claim first appears.
- # Corresponds to `ClaimReview.itemReviewed[@type=Claim].firstAppearance.url`. + # A link to a work in which this claim first appears. Corresponds to ` + # ClaimReview.itemReviewed[@type=Claim].firstAppearance.url`. # Corresponds to the JSON property `claimFirstAppearance` # @return [String] attr_accessor :claim_first_appearance - # The location where this claim was made.
- # Corresponds to `ClaimReview.itemReviewed.name`. + # The location where this claim was made. Corresponds to `ClaimReview. + # itemReviewed.name`. # Corresponds to the JSON property `claimLocation` # @return [String] attr_accessor :claim_location - # A short summary of the claim being evaluated.
- # Corresponds to `ClaimReview.claimReviewed`. + # A short summary of the claim being evaluated. Corresponds to `ClaimReview. + # claimReviewed`. # Corresponds to the JSON property `claimReviewed` # @return [String] attr_accessor :claim_reviewed @@ -278,7 +274,7 @@ module Google # This field is optional, and will default to the page URL. We provide this # field to allow you the override the default value, but the only permitted - # override is the page URL plus an optional anchor link ("page jump").
+ # override is the page URL plus an optional anchor link ("page jump"). # Corresponds to `ClaimReview.url` # Corresponds to the JSON property `url` # @return [String] @@ -310,32 +306,30 @@ module Google # @return [Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewAuthor] attr_accessor :claim_review_author - # A list of individual claim reviews for this page. - # Each item in the list corresponds to one `ClaimReview` element. + # A list of individual claim reviews for this page. Each item in the list + # corresponds to one `ClaimReview` element. # Corresponds to the JSON property `claimReviewMarkups` # @return [Array] attr_accessor :claim_review_markups - # The name of this `ClaimReview` markup page resource, in the form of - # `pages/`page_id``. Except for update requests, this field is output-only - # and should not be set by the user. + # The name of this `ClaimReview` markup page resource, in the form of `pages/` + # page_id``. Except for update requests, this field is output-only and should + # not be set by the user. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The URL of the page associated with this `ClaimReview` markup. - # While every individual `ClaimReview` has its own URL field, semantically - # this is a page-level field, and each `ClaimReview` on this page will use - # this value unless individually overridden.
- # Corresponds to `ClaimReview.url` + # The URL of the page associated with this `ClaimReview` markup. While every + # individual `ClaimReview` has its own URL field, semantically this is a page- + # level field, and each `ClaimReview` on this page will use this value unless + # individually overridden. Corresponds to `ClaimReview.url` # Corresponds to the JSON property `pageUrl` # @return [String] attr_accessor :page_url - # The date when the fact check was published. - # Similar to the URL, semantically this is a page-level field, and each - # `ClaimReview` on this page will contain the same value.
- # Corresponds to `ClaimReview.datePublished` + # The date when the fact check was published. Similar to the URL, semantically + # this is a page-level field, and each `ClaimReview` on this page will contain + # the same value. Corresponds to `ClaimReview.datePublished` # Corresponds to the JSON property `publishDate` # @return [String] attr_accessor :publish_date @@ -370,9 +364,8 @@ module Google # @return [Array] attr_accessor :claims - # The next pagination token in the Search response. It should be used as the - # `page_token` for the following request. An empty value means no more - # results. + # The next pagination token in the Search response. It should be used as the ` + # page_token` for the following request. An empty value means no more results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -397,9 +390,8 @@ module Google # @return [Array] attr_accessor :claim_review_markup_pages - # The next pagination token in the Search response. It should be used as the - # `page_token` for the following request. An empty value means no more - # results. + # The next pagination token in the Search response. It should be used as the ` + # page_token` for the following request. An empty value means no more results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -424,9 +416,9 @@ module Google # @return [String] attr_accessor :name - # Host-level site name, without the protocol or "www" prefix. For instance, - # "awesomefactchecks.com". This value of this field is based purely on the - # claim review URL. + # Host-level site name, without the protocol or "www" prefix. For instance, " + # awesomefactchecks.com". This value of this field is based purely on the claim + # review URL. # Corresponds to the JSON property `site` # @return [String] attr_accessor :site @@ -442,13 +434,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 GoogleProtobufEmpty include Google::Apis::Core::Hashable diff --git a/generated/google/apis/factchecktools_v1alpha1/service.rb b/generated/google/apis/factchecktools_v1alpha1/service.rb index 3946278d1..71459b317 100644 --- a/generated/google/apis/factchecktools_v1alpha1/service.rb +++ b/generated/google/apis/factchecktools_v1alpha1/service.rb @@ -50,23 +50,22 @@ module Google # Search through fact-checked claims. # @param [String] language_code # The BCP-47 language code, such as "en-US" or "sr-Latn". Can be used to - # restrict results by language, though we do not currently consider the - # region. + # restrict results by language, though we do not currently consider the region. # @param [Fixnum] max_age_days - # The maximum age of the returned search results, in days. - # Age is determined by either claim date or review date, whichever is newer. + # The maximum age of the returned search results, in days. Age is determined by + # either claim date or review date, whichever is newer. # @param [Fixnum] offset # An integer that specifies the current offset (that is, starting result - # location) 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 result, and 10 means to return from the 11th result. + # location) 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 + # result, and 10 means to return from the 11th result. # @param [Fixnum] page_size - # The pagination size. We will return up to that many results. Defaults to - # 10 if not set. + # The pagination size. We will return up to that many results. Defaults to 10 if + # not set. # @param [String] page_token # The pagination token. You may provide the `next_page_token` returned from a - # previous List request, if any, in order to get the next page. All other - # fields must have the same values as in the previous request. + # previous List request, if any, in order to get the next page. All other fields + # must have the same values as in the previous request. # @param [String] query # Textual query string. Required unless `review_publisher_site_filter` is # specified. @@ -195,29 +194,28 @@ module Google execute_or_queue_command(command, &block) end - # List the `ClaimReview` markup pages for a specific URL or for an - # organization. + # List the `ClaimReview` markup pages for a specific URL or for an organization. # @param [Fixnum] offset # An integer that specifies the current offset (that is, starting result - # location) in search results. This field is only considered if `page_token` - # is unset, and if the request is not for a specific URL. For example, 0 - # means to return results starting from the first matching result, and 10 - # means to return from the 11th result. + # location) in search results. This field is only considered if `page_token` is + # unset, and if the request is not for a specific URL. For example, 0 means to + # return results starting from the first matching result, and 10 means to return + # from the 11th result. # @param [String] organization - # The organization for which we want to fetch markups for. For instance, - # "site.com". Cannot be specified along with an URL. + # The organization for which we want to fetch markups for. For instance, "site. + # com". Cannot be specified along with an URL. # @param [Fixnum] page_size - # The pagination size. We will return up to that many results. Defaults to - # 10 if not set. Has no effect if a URL is requested. + # The pagination size. We will return up to that many results. Defaults to 10 if + # not set. Has no effect if a URL is requested. # @param [String] page_token # The pagination token. You may provide the `next_page_token` returned from a - # previous List request, if any, in order to get the next page. All other - # fields must have the same values as in the previous request. + # previous List request, if any, in order to get the next page. All other fields + # must have the same values as in the previous request. # @param [String] url # The URL from which to get `ClaimReview` markup. There will be at most one # result. If markup is associated with a more canonical version of the URL - # provided, we will return that URL instead. Cannot be specified along with - # an organization. + # provided, we will return that URL instead. Cannot be specified along with an + # organization. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -249,15 +247,14 @@ module Google execute_or_queue_command(command, &block) end - # Update for all `ClaimReview` markup on a page - # Note that this is a full update. To retain the existing `ClaimReview` - # markup on a page, first perform a Get operation, then modify the returned - # markup, and finally call Update with the entire `ClaimReview` markup as the - # body. + # Update for all `ClaimReview` markup on a page Note that this is a full update. + # To retain the existing `ClaimReview` markup on a page, first perform a Get + # operation, then modify the returned markup, and finally call Update with the + # entire `ClaimReview` markup as the body. # @param [String] name - # The name of this `ClaimReview` markup page resource, in the form of - # `pages/`page_id``. Except for update requests, this field is output-only - # and should not be set by the user. + # The name of this `ClaimReview` markup page resource, in the form of `pages/` + # page_id``. Except for update requests, this field is output-only and should + # not be set by the user. # @param [Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage] google_factchecking_factchecktools_v1alpha1_claim_review_markup_page_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/firebasehosting_v1.rb b/generated/google/apis/firebasehosting_v1.rb index b1e6c4227..b0d94f53c 100644 --- a/generated/google/apis/firebasehosting_v1.rb +++ b/generated/google/apis/firebasehosting_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://firebase.google.com/docs/hosting/ module FirebasehostingV1 VERSION = 'V1' - REVISION = '20200629' + REVISION = '20200731' end end end diff --git a/generated/google/apis/firebasehosting_v1/classes.rb b/generated/google/apis/firebasehosting_v1/classes.rb index 006c9b0c2..903bcdd63 100644 --- a/generated/google/apis/firebasehosting_v1/classes.rb +++ b/generated/google/apis/firebasehosting_v1/classes.rb @@ -35,13 +35,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 @@ -84,47 +82,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::FirebasehostingV1::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 @@ -143,12 +139,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 @@ -157,15 +153,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 diff --git a/generated/google/apis/firebasehosting_v1/service.rb b/generated/google/apis/firebasehosting_v1/service.rb index 7325193a3..e5fcc7639 100644 --- a/generated/google/apis/firebasehosting_v1/service.rb +++ b/generated/google/apis/firebasehosting_v1/service.rb @@ -49,15 +49,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. @@ -91,10 +89,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 @@ -124,15 +122,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 diff --git a/generated/google/apis/firebasehosting_v1beta1.rb b/generated/google/apis/firebasehosting_v1beta1.rb index a17e5cda2..1ae10abd6 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 = '20200729' + REVISION = '20200731' # 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 e6d4a6b0b..c50b17f62 100644 --- a/generated/google/apis/firebasehosting_v1beta1/classes.rb +++ b/generated/google/apis/firebasehosting_v1beta1/classes.rb @@ -22,8 +22,8 @@ module Google module Apis module FirebasehostingV1beta1 - # Contains metadata about the user who performed an action, such as creating - # a release or finalizing a version. + # Contains metadata about the user who performed an action, such as creating a + # release or finalizing a version. class ActingUser include Google::Apis::Core::Hashable @@ -32,8 +32,8 @@ module Google # @return [String] attr_accessor :email - # A profile image URL for the user. May not be present if the user has - # changed their email address or deleted their account. + # A profile image URL for the user. May not be present if the user has changed + # their email address or deleted their account. # Corresponds to the JSON property `imageUrl` # @return [String] attr_accessor :image_url @@ -58,8 +58,8 @@ module Google # @return [String] attr_accessor :domain_name - # The value that must be present as a TXT record on the domain name to - # satisfy the challenge. + # The value that must be present as a TXT record on the domain name to satisfy + # the challenge. # Corresponds to the JSON property `token` # @return [String] attr_accessor :token @@ -79,8 +79,8 @@ module Google class CertHttpChallenge include Google::Apis::Core::Hashable - # The URL path on which to serve the specified token to satisfy the - # certificate challenge. + # The URL path on which to serve the specified token to satisfy the certificate + # challenge. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path @@ -110,8 +110,8 @@ module Google class CloudRunRewrite include Google::Apis::Core::Hashable - # Optional. User-provided region where the Cloud Run service is hosted.
- # Defaults to `us-central1` if not supplied. + # Optional. User-provided region where the Cloud Run service is hosted. Defaults + # to `us-central1` if not supplied. # Corresponds to the JSON property `region` # @return [String] attr_accessor :region @@ -141,9 +141,9 @@ module Google # @return [String] attr_accessor :domain_name - # Defines the behavior of a domain-level redirect. Domain redirects preserve - # the path of the redirect but replace the requested domain with the one - # specified in the redirect configuration. + # Defines the behavior of a domain-level redirect. Domain redirects preserve the + # path of the redirect but replace the requested domain with the one specified + # in the redirect configuration. # Corresponds to the JSON property `domainRedirect` # @return [Google::Apis::FirebasehostingV1beta1::DomainRedirect] attr_accessor :domain_redirect @@ -203,8 +203,8 @@ module Google # @return [Google::Apis::FirebasehostingV1beta1::CertHttpChallenge] attr_accessor :cert_challenge_http - # The certificate provisioning status; updated when Firebase Hosting - # provisions an SSL certificate for the domain. + # The certificate provisioning status; updated when Firebase Hosting provisions + # an SSL certificate for the domain. # Corresponds to the JSON property `certStatus` # @return [String] attr_accessor :cert_status @@ -246,9 +246,9 @@ module Google end end - # Defines the behavior of a domain-level redirect. Domain redirects preserve - # the path of the redirect but replace the requested domain with the one - # specified in the redirect configuration. + # Defines the behavior of a domain-level redirect. Domain redirects preserve the + # path of the redirect but replace the requested domain with the one specified + # in the redirect configuration. class DomainRedirect include Google::Apis::Core::Hashable @@ -273,13 +273,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 @@ -292,15 +290,14 @@ module Google end end - # A [`header`](/docs/hosting/full-config#headers) is an object that specifies - # a URL pattern that, if matched to the request URL path, triggers Hosting to + # A [`header`](/docs/hosting/full-config#headers) is an object that specifies a + # URL pattern that, if matched to the request URL path, triggers Hosting to # apply the specified custom response headers. class Header include Google::Apis::Core::Hashable - # The user-supplied - # [glob](/docs/hosting/full-config#glob_pattern_matching) to match - # against the request URL path. + # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to + # match against the request URL path. # Corresponds to the JSON property `glob` # @return [String] attr_accessor :glob @@ -310,8 +307,7 @@ module Google # @return [Hash] attr_accessor :headers - # The user-supplied RE2 regular expression to match against the request - # URL path. + # The user-supplied RE2 regular expression to match against the request URL path. # Corresponds to the JSON property `regex` # @return [String] attr_accessor :regex @@ -357,10 +353,9 @@ module Google class ListReleasesResponse include Google::Apis::Core::Hashable - # If there are additional releases remaining beyond the ones in this - # response, then supply this token in the next - # [`list`](../sites.versions.files/list) call to continue with the next set - # of releases. + # If there are additional releases remaining beyond the ones in this response, + # then supply this token in the next [`list`](../sites.versions.files/list) call + # to continue with the next set of releases. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -436,47 +431,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::FirebasehostingV1beta1::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 @@ -499,10 +492,10 @@ module Google class PopulateVersionFilesRequest include Google::Apis::Core::Hashable - # A set of file paths to the hashes corresponding to assets that should be - # added to the version. Note that a file path to an empty hash will remove - # the path from the version. Calculate a hash by Gzipping the file then - # taking the SHA256 hash of the newly compressed file. + # A set of file paths to the hashes corresponding to assets that should be added + # to the version. Note that a file path to an empty hash will remove the path + # from the version. Calculate a hash by Gzipping the file then taking the SHA256 + # hash of the newly compressed file. # Corresponds to the JSON property `files` # @return [Hash] attr_accessor :files @@ -527,10 +520,9 @@ module Google # @return [Array] attr_accessor :upload_required_hashes - # The URL to which the files should be uploaded, in the format: - #
"https://upload-firebasehosting.googleapis.com/upload/sites/site-name< - # /var>/versions/versionID/files". - #
Perform a multipart `POST` of the Gzipped file contents to the URL + # The URL to which the files should be uploaded, in the format: "https://upload- + # firebasehosting.googleapis.com/upload/sites/site-name /versions/versionID/ + # files". Perform a multipart `POST` of the Gzipped file contents to the URL # using a forward slash and the hash of the file appended to the end. # Corresponds to the JSON property `uploadUrl` # @return [String] @@ -547,9 +539,8 @@ module Google end end - # Version preview configuration. If active and unexpired, - # this version will be accessible via a custom URL even - # if it is not the currently released version. + # Version preview configuration. If active and unexpired, this version will be + # accessible via a custom URL even if it is not the currently released version. class PreviewConfig include Google::Apis::Core::Hashable @@ -559,8 +550,8 @@ module Google attr_accessor :active alias_method :active?, :active - # Indicates the expiration time for previewing this - # version; preview URL requests received after this time will 404. + # Indicates the expiration time for previewing this version; preview URL + # requests received after this time will 404. # Corresponds to the JSON property `expireTime` # @return [String] attr_accessor :expire_time @@ -577,38 +568,33 @@ module Google end # A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL - # pattern that, if matched to the request URL path, triggers Hosting to - # respond with a redirect to the specified destination path. + # pattern that, if matched to the request URL path, triggers Hosting to respond + # with a redirect to the specified destination path. class Redirect include Google::Apis::Core::Hashable - # The user-supplied - # [glob](/docs/hosting/full-config#glob_pattern_matching) to match - # against the request URL path. + # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to + # match against the request URL path. # Corresponds to the JSON property `glob` # @return [String] attr_accessor :glob - # Required. The value to put in the HTTP location header of the response. - #
The location can contain capture group values from the pattern using - # a `:` prefix to identify the segment and an optional `*` to capture the - # rest of the URL. - # For example: - # "glob": "/:capture*", - #
"statusCode": 301, - #
"location": "https://example.com/foo/:capture" + # Required. The value to put in the HTTP location header of the response. The + # location can contain capture group values from the pattern using a `:` prefix + # to identify the segment and an optional `*` to capture the rest of the URL. + # For example: "glob": "/:capture*", "statusCode": 301, "location": "https:// + # example.com/foo/:capture" # Corresponds to the JSON property `location` # @return [String] attr_accessor :location - # The user-supplied RE2 regular expression to match against the request - # URL path. + # The user-supplied RE2 regular expression to match against the request URL path. # Corresponds to the JSON property `regex` # @return [String] attr_accessor :regex - # Required. The status HTTP code to return in the response. It must be a - # valid 3xx status code. + # Required. The status HTTP code to return in the response. It must be a valid + # 3xx status code. # Corresponds to the JSON property `statusCode` # @return [Fixnum] attr_accessor :status_code @@ -626,22 +612,20 @@ module Google end end - # A `Release` is a particular - # [collection of configurations and files](sites.versions) - # that is set to be public at a particular time. + # A `Release` is a particular [collection of configurations and files](sites. + # versions) that is set to be public at a particular time. class Release include Google::Apis::Core::Hashable # The deploy description when the release was created. The value can be up to - # 512 characters. + # 512 characters. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message - # Output only. The unique identifier for the release, in the format: - # sites/site-name/releases/releaseID - # This name is provided in the response body when you call the - # [`CreateRelease`](sites.releases/create) endpoint. + # Output only. The unique identifier for the release, in the format: sites/ site- + # name/releases/releaseID This name is provided in the response body when you + # call the [`CreateRelease`](sites.releases/create) endpoint. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -651,21 +635,20 @@ module Google # @return [String] attr_accessor :release_time - # Contains metadata about the user who performed an action, such as creating - # a release or finalizing a version. + # Contains metadata about the user who performed an action, such as creating a + # release or finalizing a version. # Corresponds to the JSON property `releaseUser` # @return [Google::Apis::FirebasehostingV1beta1::ActingUser] attr_accessor :release_user - # Explains the reason for the release. - #
Specify a value for this field only when creating a `SITE_DISABLE` - # type release. + # Explains the reason for the release. Specify a value for this field only when + # creating a `SITE_DISABLE` type release. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # A `Version` is the collection of configuration and - # [static files](sites.versions.files) that determine how a site is displayed. + # A `Version` is the collection of configuration and [static files](sites. + # versions.files) that determine how a site is displayed. # Corresponds to the JSON property `version` # @return [Google::Apis::FirebasehostingV1beta1::Version] attr_accessor :version @@ -686,8 +669,8 @@ module Google end # A [`rewrite`](/docs/hosting/full-config#rewrites) object specifies a URL - # pattern that, if matched to the request URL path, triggers Hosting to - # respond as if the service were given the specified destination URL. + # pattern that, if matched to the request URL path, triggers Hosting to respond + # as if the service were given the specified destination URL. class Rewrite include Google::Apis::Core::Hashable @@ -697,15 +680,14 @@ module Google attr_accessor :dynamic_links alias_method :dynamic_links?, :dynamic_links - # The function to proxy requests to. Must match the exported function - # name exactly. + # The function to proxy requests to. Must match the exported function name + # exactly. # Corresponds to the JSON property `function` # @return [String] attr_accessor :function - # The user-supplied - # [glob](/docs/hosting/full-config#glob_pattern_matching) to match - # against the request URL path. + # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to + # match against the request URL path. # Corresponds to the JSON property `glob` # @return [String] attr_accessor :glob @@ -715,8 +697,7 @@ module Google # @return [String] attr_accessor :path - # The user-supplied RE2 regular expression to match against the request - # URL path. + # The user-supplied RE2 regular expression to match against the request URL path. # Corresponds to the JSON property `regex` # @return [String] attr_accessor :regex @@ -748,8 +729,8 @@ module Google # The configuration for how incoming requests to a site should be routed and # processed before serving content. The URL request paths are matched against # the specified URL patterns in the configuration, then Hosting applies the - # applicable configuration according to a specific - # [priority order](/docs/hosting/full-config#hosting_priority_order). + # applicable configuration according to a specific [priority order](/docs/ + # hosting/full-config#hosting_priority_order). class ServingConfig include Google::Apis::Core::Hashable @@ -771,16 +752,16 @@ module Google # @return [Array] attr_accessor :headers - # An array of objects (called redirect rules), where each rule specifies a - # URL pattern that, if matched to the request URL path, triggers Hosting to - # respond with a redirect to the specified destination path. + # An array of objects (called redirect rules), where each rule specifies a URL + # pattern that, if matched to the request URL path, triggers Hosting to respond + # with a redirect to the specified destination path. # Corresponds to the JSON property `redirects` # @return [Array] attr_accessor :redirects # An array of objects (called rewrite rules), where each rule specifies a URL - # pattern that, if matched to the request URL path, triggers Hosting to - # respond as if the service were given the specified destination URL. + # pattern that, if matched to the request URL path, triggers Hosting to respond + # as if the service were given the specified destination URL. # Corresponds to the JSON property `rewrites` # @return [Array] attr_accessor :rewrites @@ -805,23 +786,22 @@ module Google end end - # A `SiteConfig` contains metadata associated with a specific site that - # controls Firebase Hosting serving behavior + # A `SiteConfig` contains metadata associated with a specific site that controls + # Firebase Hosting serving behavior class SiteConfig include Google::Apis::Core::Hashable - # Whether or not web requests made by site visitors are logged via Cloud - # Logging. + # Whether or not web requests made by site visitors are logged via Cloud Logging. # Corresponds to the JSON property `cloudLoggingEnabled` # @return [Boolean] attr_accessor :cloud_logging_enabled alias_method :cloud_logging_enabled?, :cloud_logging_enabled - # The number of FINALIZED versions that will be held for a site before - # automatic deletion. When a new version is deployed, content for versions - # in storage in excess of this number will be deleted, and will no longer be - # billed for storage usage. Oldest versions will be deleted first; sites are - # created with an unlimited number of max_versions by default. + # The number of FINALIZED versions that will be held for a site before automatic + # deletion. When a new version is deployed, content for versions in storage in + # excess of this number will be deleted, and will no longer be billed for + # storage usage. Oldest versions will be deleted first; sites are created with + # an unlimited number of max_versions by default. # Corresponds to the JSON property `maxVersions` # @return [Fixnum] attr_accessor :max_versions @@ -837,12 +817,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 @@ -851,15 +831,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 @@ -876,16 +856,16 @@ module Google end end - # A `Version` is the collection of configuration and - # [static files](sites.versions.files) that determine how a site is displayed. + # A `Version` is the collection of configuration and [static files](sites. + # versions.files) that determine how a site is displayed. class Version include Google::Apis::Core::Hashable # The configuration for how incoming requests to a site should be routed and # processed before serving content. The URL request paths are matched against # the specified URL patterns in the configuration, then Hosting applies the - # applicable configuration according to a specific - # [priority order](/docs/hosting/full-config#hosting_priority_order). + # applicable configuration according to a specific [priority order](/docs/ + # hosting/full-config#hosting_priority_order). # Corresponds to the JSON property `config` # @return [Google::Apis::FirebasehostingV1beta1::ServingConfig] attr_accessor :config @@ -895,8 +875,8 @@ module Google # @return [String] attr_accessor :create_time - # Contains metadata about the user who performed an action, such as creating - # a release or finalizing a version. + # Contains metadata about the user who performed an action, such as creating a + # release or finalizing a version. # Corresponds to the JSON property `createUser` # @return [Google::Apis::FirebasehostingV1beta1::ActingUser] attr_accessor :create_user @@ -906,14 +886,14 @@ module Google # @return [String] attr_accessor :delete_time - # Contains metadata about the user who performed an action, such as creating - # a release or finalizing a version. + # Contains metadata about the user who performed an action, such as creating a + # release or finalizing a version. # Corresponds to the JSON property `deleteUser` # @return [Google::Apis::FirebasehostingV1beta1::ActingUser] attr_accessor :delete_user - # Output only. The total number of files associated with the version. - #
This value is calculated after a version is `FINALIZED`. + # Output only. The total number of files associated with the version. This value + # is calculated after a version is `FINALIZED`. # Corresponds to the JSON property `fileCount` # @return [Fixnum] attr_accessor :file_count @@ -923,8 +903,8 @@ module Google # @return [String] attr_accessor :finalize_time - # Contains metadata about the user who performed an action, such as creating - # a release or finalizing a version. + # Contains metadata about the user who performed an action, such as creating a + # release or finalizing a version. # Corresponds to the JSON property `finalizeUser` # @return [Google::Apis::FirebasehostingV1beta1::ActingUser] attr_accessor :finalize_user @@ -934,41 +914,33 @@ module Google # @return [Hash] attr_accessor :labels - # The unique identifier for a version, in the format: - # sites/site-name/versions/versionID - # This name is provided in the response body when you call the - # [`CreateVersion`](../sites.versions/create) endpoint. + # The unique identifier for a version, in the format: sites/site-name /versions/ + # versionID This name is provided in the response body when you call the [` + # CreateVersion`](../sites.versions/create) endpoint. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Version preview configuration. If active and unexpired, - # this version will be accessible via a custom URL even - # if it is not the currently released version. + # Version preview configuration. If active and unexpired, this version will be + # accessible via a custom URL even if it is not the currently released version. # Corresponds to the JSON property `preview` # @return [Google::Apis::FirebasehostingV1beta1::PreviewConfig] attr_accessor :preview - # The deploy status of a version. - #
- #
For a successful deploy, call the - # [`CreateVersion`](sites.versions/create) endpoint to make a new version - # (`CREATED` status), - # [upload all desired files](sites.versions/populateFiles) to the version, - # then [update](sites.versions/patch) the version to the `FINALIZED` status. - #
- #
Note that if you leave the version in the `CREATED` state for more - # than 12 hours, the system will automatically mark the version as - # `ABANDONED`. - #
- #
You can also change the status of a version to `DELETED` by calling the - # [`DeleteVersion`](sites.versions/delete) endpoint. + # The deploy status of a version. For a successful deploy, call the [` + # CreateVersion`](sites.versions/create) endpoint to make a new version (` + # CREATED` status), [upload all desired files](sites.versions/populateFiles) to + # the version, then [update](sites.versions/patch) the version to the `FINALIZED` + # status. Note that if you leave the version in the `CREATED` state for more + # than 12 hours, the system will automatically mark the version as `ABANDONED`. + # You can also change the status of a version to `DELETED` by calling the [` + # DeleteVersion`](sites.versions/delete) endpoint. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status - # Output only. The total stored bytesize of the version. - #
This value is calculated after a version is `FINALIZED`. + # Output only. The total stored bytesize of the version. This value is + # calculated after a version is `FINALIZED`. # Corresponds to the JSON property `versionBytes` # @return [Fixnum] attr_accessor :version_bytes @@ -1009,9 +981,8 @@ module Google # @return [String] attr_accessor :path - # Output only. The current status of a particular file in the specified - # version. - #
The value will be either `pending upload` or `uploaded`. + # Output only. The current status of a particular file in the specified version. + # The value will be either `pending upload` or `uploaded`. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status diff --git a/generated/google/apis/firebasehosting_v1beta1/service.rb b/generated/google/apis/firebasehosting_v1beta1/service.rb index 5455840db..aee5b5c71 100644 --- a/generated/google/apis/firebasehosting_v1beta1/service.rb +++ b/generated/google/apis/firebasehosting_v1beta1/service.rb @@ -49,9 +49,8 @@ module Google @batch_path = 'batch' 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 @@ -83,8 +82,8 @@ module Google # Gets the Hosting metadata for a specific site. # @param [String] name - # Required. The site for which to get the SiteConfig, in the format: - # sites/site-name/config + # Required. The site for which to get the SiteConfig, in the format: sites/ site- + # name/config # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -114,15 +113,14 @@ module Google # Sets the Hosting metadata for a specific site. # @param [String] name - # Required. The site for which to update the SiteConfig, in the format: - # sites/site-name/config + # Required. The site for which to update the SiteConfig, in the format: sites/ + # site-name/config # @param [Google::Apis::FirebasehostingV1beta1::SiteConfig] site_config_object # @param [String] update_mask - # A set of field names from your [site configuration](../sites.SiteConfig) - # that you want to update. - #
A field will be overwritten if, and only if, it's in the mask. - #
If a mask is not provided then a default mask of only - # [`max_versions`](../sites.SiteConfig.max_versions) will be used. + # A set of field names from your [site configuration](../sites.SiteConfig) that + # you want to update. A field will be overwritten if, and only if, it's in the + # mask. If a mask is not provided then a default mask of only [`max_versions`](.. + # /sites.SiteConfig.max_versions) will be used. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -156,17 +154,14 @@ module Google # Creates a new release which makes the content of the specified version # actively display on the appropriate URL(s). # @param [String] parent - # Required. The site that the release belongs to, in the format: - # sites/site-name + # Required. The site that the release belongs to, in the format: sites/ site- + # name # @param [Google::Apis::FirebasehostingV1beta1::Release] release_object # @param [String] version_name - # The unique identifier for a version, in the format: - # /sites/site-name/versions/versionID - # The site-name in this version identifier must match the - # site-name in the `parent` parameter. - #
- #
This query parameter must be empty if the `type` field in the - # request body is `SITE_DISABLE`. + # The unique identifier for a version, in the format: /sites/site-name /versions/ + # versionID The site-name in this version identifier must match the site-name in + # the `parent` parameter. This query parameter must be empty if the `type` field + # in the request body is `SITE_DISABLE`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -199,8 +194,7 @@ module Google # Lists the releases that have been created on the specified site. # @param [String] parent - # Required. The parent for which to list files, in the format: - # sites/site-name + # Required. The parent for which to list files, in the format: sites/site-name # @param [Fixnum] page_size # The page size to return. Defaults to 100. # @param [String] page_token @@ -237,7 +231,7 @@ module Google # Creates a domain mapping on the specified site. # @param [String] parent # Required. The parent to create the domain association for, in the format: - # sites/site-name + # sites/site-name # @param [Google::Apis::FirebasehostingV1beta1::Domain] domain_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -330,8 +324,8 @@ module Google # Lists the domains for the specified site. # @param [String] parent - # Required. The parent for which to list domains, in the format: - # sites/site-name + # Required. The parent for which to list domains, in the format: sites/ site- + # name # @param [Fixnum] page_size # The page size to return. Defaults to 50. # @param [String] page_token @@ -365,8 +359,8 @@ module Google execute_or_queue_command(command, &block) end - # Updates the specified domain mapping, creating the mapping as if it does - # not exist. + # Updates the specified domain mapping, creating the mapping as if it does not + # exist. # @param [String] name # Required. The name of the domain association to update or create, if an # association doesn't already exist. @@ -403,17 +397,14 @@ module Google # Creates a new release which makes the content of the specified version # actively display on the appropriate URL(s). # @param [String] parent - # Required. The site that the release belongs to, in the format: - # sites/site-name + # Required. The site that the release belongs to, in the format: sites/ site- + # name # @param [Google::Apis::FirebasehostingV1beta1::Release] release_object # @param [String] version_name - # The unique identifier for a version, in the format: - # /sites/site-name/versions/versionID - # The site-name in this version identifier must match the - # site-name in the `parent` parameter. - #
- #
This query parameter must be empty if the `type` field in the - # request body is `SITE_DISABLE`. + # The unique identifier for a version, in the format: /sites/site-name /versions/ + # versionID The site-name in this version identifier must match the site-name in + # the `parent` parameter. This query parameter must be empty if the `type` field + # in the request body is `SITE_DISABLE`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -446,8 +437,7 @@ module Google # Lists the releases that have been created on the specified site. # @param [String] parent - # Required. The parent for which to list files, in the format: - # sites/site-name + # Required. The parent for which to list files, in the format: sites/site-name # @param [Fixnum] page_size # The page size to return. Defaults to 100. # @param [String] page_token @@ -483,8 +473,8 @@ module Google # Creates a new version for a site. # @param [String] parent - # Required. The parent to create the version for, in the format: - # sites/site-name + # Required. The parent to create the version for, in the format: sites/ site- + # name # @param [Google::Apis::FirebasehostingV1beta1::Version] version_object # @param [Fixnum] size_bytes # The self-reported size of the version. This value is used for a pre-emptive @@ -525,8 +515,8 @@ module Google # Deletes the specified version. # @param [String] name - # Required. The name of the version to be deleted, in the format: - # sites/site-name/versions/versionID + # Required. The name of the version to be deleted, in the format: sites/ site- + # name/versions/versionID # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -554,21 +544,18 @@ module Google execute_or_queue_command(command, &block) end - # Lists the versions that have been created on the specified site. - # Will include filtering in the future. + # Lists the versions that have been created on the specified site. Will include + # filtering in the future. # @param [String] parent - # Required. The parent for which to list files, in the format: - # sites/site-name + # Required. The parent for which to list files, in the format: sites/site-name # @param [String] filter # The filter string used to return a subset of versions in the response. - # Currently supported fields for filtering are: name, status, - # and create_time. Filter processing will be implemented in accordance - # with go/filtering. + # Currently supported fields for filtering are: name, status, and create_time. + # Filter processing will be implemented in accordance with go/filtering. # @param [Fixnum] page_size # The maximum number of versions to return. The service may return fewer than - # this value. - # If unspecified, at most 25 versions will be returned. - # The maximum value is 100; values above 100 will be coerced to 100 + # this value. If unspecified, at most 25 versions will be returned. The maximum + # value is 100; values above 100 will be coerced to 100 # @param [String] page_token # The next_page_token from a previous request, if provided. # @param [String] fields @@ -601,24 +588,21 @@ module Google execute_or_queue_command(command, &block) end - # Updates the specified metadata for a version. Note that this method will - # fail with `FAILED_PRECONDITION` in the event of an invalid state - # transition. The only valid transition for a version is currently from a - # `CREATED` status to a `FINALIZED` status. - # Use [`DeleteVersion`](../sites.versions/delete) to set the status of a - # version to `DELETED`. + # Updates the specified metadata for a version. Note that this method will fail + # with `FAILED_PRECONDITION` in the event of an invalid state transition. The + # only valid transition for a version is currently from a `CREATED` status to a ` + # FINALIZED` status. Use [`DeleteVersion`](../sites.versions/delete) to set the + # status of a version to `DELETED`. # @param [String] name - # The unique identifier for a version, in the format: - # sites/site-name/versions/versionID - # This name is provided in the response body when you call the - # [`CreateVersion`](../sites.versions/create) endpoint. + # The unique identifier for a version, in the format: sites/site-name /versions/ + # versionID This name is provided in the response body when you call the [` + # CreateVersion`](../sites.versions/create) endpoint. # @param [Google::Apis::FirebasehostingV1beta1::Version] version_object # @param [String] update_mask - # A set of field names from your [version](../sites.versions) that you want - # to update. - #
A field will be overwritten if, and only if, it's in the mask. - #
If a mask is not provided then a default mask of only - # [`status`](../sites.versions#Version.FIELDS.status) will be used. + # A set of field names from your [version](../sites.versions) that you want to + # update. A field will be overwritten if, and only if, it's in the mask. If a + # mask is not provided then a default mask of only [`status`](../sites.versions# + # Version.FIELDS.status) will be used. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -649,11 +633,10 @@ module Google execute_or_queue_command(command, &block) end - # Adds content files to a version. - # Each file must be under 2 GB. + # Adds content files to a version. Each file must be under 2 GB. # @param [String] parent - # Required. The version to add files to, in the format: - # sites/site-name/versions/versionID + # Required. The version to add files to, in the format: sites/site-name / + # versions/versionID # @param [Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesRequest] populate_version_files_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -686,8 +669,8 @@ module Google # Lists the remaining files to be uploaded for the specified version. # @param [String] parent - # Required. The parent to list files for, in the format: - # sites/site-name/versions/versionID + # Required. The parent to list files for, in the format: sites/site-name / + # versions/versionID # @param [Fixnum] page_size # The page size to return. Defaults to 1000. # @param [String] page_token @@ -727,8 +710,8 @@ module Google # Gets the Hosting metadata for a specific site. # @param [String] name - # Required. The site for which to get the SiteConfig, in the format: - # sites/site-name/config + # Required. The site for which to get the SiteConfig, in the format: sites/ site- + # name/config # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -758,15 +741,14 @@ module Google # Sets the Hosting metadata for a specific site. # @param [String] name - # Required. The site for which to update the SiteConfig, in the format: - # sites/site-name/config + # Required. The site for which to update the SiteConfig, in the format: sites/ + # site-name/config # @param [Google::Apis::FirebasehostingV1beta1::SiteConfig] site_config_object # @param [String] update_mask - # A set of field names from your [site configuration](../sites.SiteConfig) - # that you want to update. - #
A field will be overwritten if, and only if, it's in the mask. - #
If a mask is not provided then a default mask of only - # [`max_versions`](../sites.SiteConfig.max_versions) will be used. + # A set of field names from your [site configuration](../sites.SiteConfig) that + # you want to update. A field will be overwritten if, and only if, it's in the + # mask. If a mask is not provided then a default mask of only [`max_versions`](.. + # /sites.SiteConfig.max_versions) will be used. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -800,17 +782,14 @@ module Google # Creates a new release which makes the content of the specified version # actively display on the appropriate URL(s). # @param [String] parent - # Required. The site that the release belongs to, in the format: - # sites/site-name + # Required. The site that the release belongs to, in the format: sites/ site- + # name # @param [Google::Apis::FirebasehostingV1beta1::Release] release_object # @param [String] version_name - # The unique identifier for a version, in the format: - # /sites/site-name/versions/versionID - # The site-name in this version identifier must match the - # site-name in the `parent` parameter. - #
- #
This query parameter must be empty if the `type` field in the - # request body is `SITE_DISABLE`. + # The unique identifier for a version, in the format: /sites/site-name /versions/ + # versionID The site-name in this version identifier must match the site-name in + # the `parent` parameter. This query parameter must be empty if the `type` field + # in the request body is `SITE_DISABLE`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -843,8 +822,7 @@ module Google # Lists the releases that have been created on the specified site. # @param [String] parent - # Required. The parent for which to list files, in the format: - # sites/site-name + # Required. The parent for which to list files, in the format: sites/site-name # @param [Fixnum] page_size # The page size to return. Defaults to 100. # @param [String] page_token @@ -881,7 +859,7 @@ module Google # Creates a domain mapping on the specified site. # @param [String] parent # Required. The parent to create the domain association for, in the format: - # sites/site-name + # sites/site-name # @param [Google::Apis::FirebasehostingV1beta1::Domain] domain_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -974,8 +952,8 @@ module Google # Lists the domains for the specified site. # @param [String] parent - # Required. The parent for which to list domains, in the format: - # sites/site-name + # Required. The parent for which to list domains, in the format: sites/ site- + # name # @param [Fixnum] page_size # The page size to return. Defaults to 50. # @param [String] page_token @@ -1009,8 +987,8 @@ module Google execute_or_queue_command(command, &block) end - # Updates the specified domain mapping, creating the mapping as if it does - # not exist. + # Updates the specified domain mapping, creating the mapping as if it does not + # exist. # @param [String] name # Required. The name of the domain association to update or create, if an # association doesn't already exist. @@ -1047,17 +1025,14 @@ module Google # Creates a new release which makes the content of the specified version # actively display on the appropriate URL(s). # @param [String] parent - # Required. The site that the release belongs to, in the format: - # sites/site-name + # Required. The site that the release belongs to, in the format: sites/ site- + # name # @param [Google::Apis::FirebasehostingV1beta1::Release] release_object # @param [String] version_name - # The unique identifier for a version, in the format: - # /sites/site-name/versions/versionID - # The site-name in this version identifier must match the - # site-name in the `parent` parameter. - #
- #
This query parameter must be empty if the `type` field in the - # request body is `SITE_DISABLE`. + # The unique identifier for a version, in the format: /sites/site-name /versions/ + # versionID The site-name in this version identifier must match the site-name in + # the `parent` parameter. This query parameter must be empty if the `type` field + # in the request body is `SITE_DISABLE`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1090,8 +1065,7 @@ module Google # Lists the releases that have been created on the specified site. # @param [String] parent - # Required. The parent for which to list files, in the format: - # sites/site-name + # Required. The parent for which to list files, in the format: sites/site-name # @param [Fixnum] page_size # The page size to return. Defaults to 100. # @param [String] page_token @@ -1127,8 +1101,8 @@ module Google # Creates a new version for a site. # @param [String] parent - # Required. The parent to create the version for, in the format: - # sites/site-name + # Required. The parent to create the version for, in the format: sites/ site- + # name # @param [Google::Apis::FirebasehostingV1beta1::Version] version_object # @param [Fixnum] size_bytes # The self-reported size of the version. This value is used for a pre-emptive @@ -1169,8 +1143,8 @@ module Google # Deletes the specified version. # @param [String] name - # Required. The name of the version to be deleted, in the format: - # sites/site-name/versions/versionID + # Required. The name of the version to be deleted, in the format: sites/ site- + # name/versions/versionID # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1198,21 +1172,18 @@ module Google execute_or_queue_command(command, &block) end - # Lists the versions that have been created on the specified site. - # Will include filtering in the future. + # Lists the versions that have been created on the specified site. Will include + # filtering in the future. # @param [String] parent - # Required. The parent for which to list files, in the format: - # sites/site-name + # Required. The parent for which to list files, in the format: sites/site-name # @param [String] filter # The filter string used to return a subset of versions in the response. - # Currently supported fields for filtering are: name, status, - # and create_time. Filter processing will be implemented in accordance - # with go/filtering. + # Currently supported fields for filtering are: name, status, and create_time. + # Filter processing will be implemented in accordance with go/filtering. # @param [Fixnum] page_size # The maximum number of versions to return. The service may return fewer than - # this value. - # If unspecified, at most 25 versions will be returned. - # The maximum value is 100; values above 100 will be coerced to 100 + # this value. If unspecified, at most 25 versions will be returned. The maximum + # value is 100; values above 100 will be coerced to 100 # @param [String] page_token # The next_page_token from a previous request, if provided. # @param [String] fields @@ -1245,24 +1216,21 @@ module Google execute_or_queue_command(command, &block) end - # Updates the specified metadata for a version. Note that this method will - # fail with `FAILED_PRECONDITION` in the event of an invalid state - # transition. The only valid transition for a version is currently from a - # `CREATED` status to a `FINALIZED` status. - # Use [`DeleteVersion`](../sites.versions/delete) to set the status of a - # version to `DELETED`. + # Updates the specified metadata for a version. Note that this method will fail + # with `FAILED_PRECONDITION` in the event of an invalid state transition. The + # only valid transition for a version is currently from a `CREATED` status to a ` + # FINALIZED` status. Use [`DeleteVersion`](../sites.versions/delete) to set the + # status of a version to `DELETED`. # @param [String] name - # The unique identifier for a version, in the format: - # sites/site-name/versions/versionID - # This name is provided in the response body when you call the - # [`CreateVersion`](../sites.versions/create) endpoint. + # The unique identifier for a version, in the format: sites/site-name /versions/ + # versionID This name is provided in the response body when you call the [` + # CreateVersion`](../sites.versions/create) endpoint. # @param [Google::Apis::FirebasehostingV1beta1::Version] version_object # @param [String] update_mask - # A set of field names from your [version](../sites.versions) that you want - # to update. - #
A field will be overwritten if, and only if, it's in the mask. - #
If a mask is not provided then a default mask of only - # [`status`](../sites.versions#Version.FIELDS.status) will be used. + # A set of field names from your [version](../sites.versions) that you want to + # update. A field will be overwritten if, and only if, it's in the mask. If a + # mask is not provided then a default mask of only [`status`](../sites.versions# + # Version.FIELDS.status) will be used. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1293,11 +1261,10 @@ module Google execute_or_queue_command(command, &block) end - # Adds content files to a version. - # Each file must be under 2 GB. + # Adds content files to a version. Each file must be under 2 GB. # @param [String] parent - # Required. The version to add files to, in the format: - # sites/site-name/versions/versionID + # Required. The version to add files to, in the format: sites/site-name / + # versions/versionID # @param [Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesRequest] populate_version_files_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1330,8 +1297,8 @@ module Google # Lists the remaining files to be uploaded for the specified version. # @param [String] parent - # Required. The parent to list files for, in the format: - # sites/site-name/versions/versionID + # Required. The parent to list files for, in the format: sites/site-name / + # versions/versionID # @param [Fixnum] page_size # The page size to return. Defaults to 1000. # @param [String] page_token diff --git a/generated/google/apis/gmailpostmastertools_v1beta1.rb b/generated/google/apis/gmailpostmastertools_v1beta1.rb index fee53a62e..33bb3b098 100644 --- a/generated/google/apis/gmailpostmastertools_v1beta1.rb +++ b/generated/google/apis/gmailpostmastertools_v1beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://developers.google.com/gmail/postmaster module GmailpostmastertoolsV1beta1 VERSION = 'V1beta1' - REVISION = '20200719' + REVISION = '20200801' # See email traffic metrics for the domains you have registered in Gmail Postmaster Tools AUTH_POSTMASTER_READONLY = 'https://www.googleapis.com/auth/postmaster.readonly' diff --git a/generated/google/apis/gmailpostmastertools_v1beta1/classes.rb b/generated/google/apis/gmailpostmastertools_v1beta1/classes.rb index bffb9dee7..8627fd0f8 100644 --- a/generated/google/apis/gmailpostmastertools_v1beta1/classes.rb +++ b/generated/google/apis/gmailpostmastertools_v1beta1/classes.rb @@ -31,8 +31,7 @@ module Google # @return [String] attr_accessor :error_class - # The ratio of messages where the error occurred vs all authenticated - # traffic. + # The ratio of messages where the error occurred vs all authenticated traffic. # Corresponds to the JSON property `errorRatio` # @return [Float] attr_accessor :error_ratio @@ -58,15 +57,14 @@ module Google class Domain include Google::Apis::Core::Hashable - # Timestamp when the user registered this domain. Assigned by - # the server. + # Timestamp when the user registered this domain. Assigned by the server. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time - # The resource name of the Domain. - # Domain names have the form `domains/`domain_name``, where domain_name - # is the fully qualified domain name (i.e., mymail.mydomain.com). + # The resource name of the Domain. Domain names have the form `domains/` + # domain_name``, where domain_name is the fully qualified domain name (i.e., + # mymail.mydomain.com). # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -98,8 +96,8 @@ module Google # @return [String] attr_accessor :id - # The ratio of user marked spam messages with the identifier vs the total - # number of inboxed messages with that identifier. + # The ratio of user marked spam messages with the identifier vs the total number + # of inboxed messages with that identifier. # Corresponds to the JSON property `spamRatio` # @return [Float] attr_accessor :spam_ratio @@ -120,8 +118,8 @@ module Google include Google::Apis::Core::Hashable # Total number of unique IPs in this reputation category. This metric only - # pertains to traffic that passed [SPF](http://www.openspf.org/) or - # [DKIM](http://www.dkim.org/). + # pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http:/ + # /www.dkim.org/). # Corresponds to the JSON property `numIps` # @return [Fixnum] attr_accessor :num_ips @@ -157,8 +155,8 @@ module Google # @return [Array] attr_accessor :domains - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -178,8 +176,8 @@ module Google class ListTrafficStatsResponse include Google::Apis::Core::Hashable - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -210,16 +208,16 @@ module Google # @return [Array] attr_accessor :delivery_errors - # The ratio of mail that successfully authenticated with DKIM vs. all mail - # that attempted to authenticate with [DKIM](http://www.dkim.org/). Spoofed - # mail is excluded. + # The ratio of mail that successfully authenticated with DKIM vs. all mail that + # attempted to authenticate with [DKIM](http://www.dkim.org/). Spoofed mail is + # excluded. # Corresponds to the JSON property `dkimSuccessRatio` # @return [Float] attr_accessor :dkim_success_ratio - # The ratio of mail that passed [DMARC](https://dmarc.org/) alignment checks - # vs all mail received from the domain that successfully authenticated with - # either of [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/). + # The ratio of mail that passed [DMARC](https://dmarc.org/) alignment checks vs + # all mail received from the domain that successfully authenticated with either + # of [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/). # Corresponds to the JSON property `dmarcSuccessRatio` # @return [Float] attr_accessor :dmarc_success_ratio @@ -229,27 +227,26 @@ module Google # @return [String] attr_accessor :domain_reputation - # The ratio of incoming mail (to Gmail), that passed secure transport (TLS) - # vs all mail received from that domain. This metric only pertains to traffic - # that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/). + # The ratio of incoming mail (to Gmail), that passed secure transport (TLS) vs + # all mail received from that domain. This metric only pertains to traffic that + # passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/). # Corresponds to the JSON property `inboundEncryptionRatio` # @return [Float] attr_accessor :inbound_encryption_ratio - # Reputation information pertaining to the IP addresses of the email servers - # for the domain. There is exactly one entry for each reputation category - # except + # Reputation information pertaining to the IP addresses of the email servers for + # the domain. There is exactly one entry for each reputation category except # REPUTATION_CATEGORY_UNSPECIFIED. # Corresponds to the JSON property `ipReputations` # @return [Array] attr_accessor :ip_reputations - # The resource name of the traffic statistics. Traffic statistic names have - # the form `domains/`domain`/trafficStats/`date``, where - # domain_name is the fully qualified domain name (i.e., mymail.mydomain.com) - # of the domain this traffic statistics pertains to and date is the date in - # yyyymmdd format that these statistics corresponds to. - # For example: domains/mymail.mydomain.com/trafficStats/20160807 + # The resource name of the traffic statistics. Traffic statistic names have the + # form `domains/`domain`/trafficStats/`date``, where domain_name is the fully + # qualified domain name (i.e., mymail.mydomain.com) of the domain this traffic + # statistics pertains to and date is the date in yyyymmdd format that these + # statistics corresponds to. For example: domains/mymail.mydomain.com/ + # trafficStats/20160807 # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -260,24 +257,22 @@ module Google # @return [Float] attr_accessor :outbound_encryption_ratio - # Spammy [Feedback loop identifiers] - # (https://support.google.com/mail/answer/6254652) with their individual spam - # rates. This metric only pertains to traffic that is authenticated by - # [DKIM](http://www.dkim.org/). + # Spammy [Feedback loop identifiers] (https://support.google.com/mail/answer/ + # 6254652) with their individual spam rates. This metric only pertains to + # traffic that is authenticated by [DKIM](http://www.dkim.org/). # Corresponds to the JSON property `spammyFeedbackLoops` # @return [Array] attr_accessor :spammy_feedback_loops - # The ratio of mail that successfully authenticated with SPF vs. all mail - # that attempted to authenticate with [SPF](http://www.openspf.org/). Spoofed - # mail is excluded. + # The ratio of mail that successfully authenticated with SPF vs. all mail that + # attempted to authenticate with [SPF](http://www.openspf.org/). Spoofed mail is + # excluded. # Corresponds to the JSON property `spfSuccessRatio` # @return [Float] attr_accessor :spf_success_ratio # The ratio of user-report spam vs. email that was sent to the inbox. This - # metric only pertains to emails authenticated by - # [DKIM](http://www.dkim.org/). + # metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/). # Corresponds to the JSON property `userReportedSpamRatio` # @return [Float] attr_accessor :user_reported_spam_ratio diff --git a/generated/google/apis/gmailpostmastertools_v1beta1/service.rb b/generated/google/apis/gmailpostmastertools_v1beta1/service.rb index 2c6251e8c..995969fac 100644 --- a/generated/google/apis/gmailpostmastertools_v1beta1/service.rb +++ b/generated/google/apis/gmailpostmastertools_v1beta1/service.rb @@ -49,12 +49,11 @@ module Google @batch_path = 'batch' end - # Gets a specific domain registered by the client. - # Returns NOT_FOUND if the domain does not exist. + # Gets a specific domain registered by the client. Returns NOT_FOUND if the + # domain does not exist. # @param [String] name - # The resource name of the domain. It should have the form - # `domains/`domain_name``, where domain_name is the fully qualified - # domain name. + # The resource name of the domain. It should have the form `domains/`domain_name` + # `, where domain_name is the fully qualified domain name. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -86,13 +85,12 @@ module Google # domains in the response is unspecified and non-deterministic. Newly created # domains will not necessarily be added to the end of this list. # @param [Fixnum] page_size - # Requested page size. Server may return fewer domains than requested. - # If unspecified, server will pick an appropriate default. + # Requested page size. Server may return fewer domains than requested. If + # unspecified, server will pick an appropriate default. # @param [String] page_token - # The next_page_token value returned from a previous List request, if any. - # This is the value of - # ListDomainsResponse.next_page_token - # returned from the previous call to `ListDomains` method. + # The next_page_token value returned from a previous List request, if any. This + # is the value of ListDomainsResponse.next_page_token returned from the previous + # call to `ListDomains` method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -121,12 +119,12 @@ module Google execute_or_queue_command(command, &block) end - # Get traffic statistics for a domain on a specific date. - # Returns PERMISSION_DENIED if user does not have permission to access - # TrafficStats for the domain. + # Get traffic statistics for a domain on a specific date. Returns + # PERMISSION_DENIED if user does not have permission to access TrafficStats for + # the domain. # @param [String] name - # The resource name of the traffic statistics to get. - # E.g., domains/mymail.mydomain.com/trafficStats/20160807. + # The resource name of the traffic statistics to get. E.g., domains/mymail. + # mydomain.com/trafficStats/20160807. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -154,41 +152,37 @@ module Google execute_or_queue_command(command, &block) end - # List traffic statistics for all available days. - # Returns PERMISSION_DENIED if user does not have permission to access - # TrafficStats for the domain. + # List traffic statistics for all available days. Returns PERMISSION_DENIED if + # user does not have permission to access TrafficStats for the domain. # @param [String] parent - # The resource name of the domain whose traffic statistics we'd like to list. - # It should have the form `domains/`domain_name``, where domain_name is - # the fully qualified domain name. + # The resource name of the domain whose traffic statistics we'd like to list. It + # should have the form `domains/`domain_name``, where domain_name is the fully + # qualified domain name. # @param [Fixnum] end_date_day - # 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. # @param [Fixnum] end_date_month - # 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. # @param [Fixnum] end_date_year - # 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. # @param [Fixnum] page_size - # Requested page size. Server may return fewer TrafficStats than - # requested. If unspecified, server will pick an appropriate default. + # Requested page size. Server may return fewer TrafficStats than requested. If + # unspecified, server will pick an appropriate default. # @param [String] page_token - # The next_page_token value returned from a previous List request, if any. - # This is the value of - # ListTrafficStatsResponse.next_page_token - # returned from the previous call to `ListTrafficStats` method. + # The next_page_token value returned from a previous List request, if any. This + # is the value of ListTrafficStatsResponse.next_page_token returned from the + # previous call to `ListTrafficStats` method. # @param [Fixnum] start_date_day - # 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. # @param [Fixnum] start_date_month - # 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. # @param [Fixnum] start_date_year - # 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. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/language_v1.rb b/generated/google/apis/language_v1.rb index f2e65bc36..0efda4b43 100644 --- a/generated/google/apis/language_v1.rb +++ b/generated/google/apis/language_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/natural-language/ module LanguageV1 VERSION = 'V1' - REVISION = '20200406' + REVISION = '20200801' # Apply machine learning models to reveal the structure and meaning of text AUTH_CLOUD_LANGUAGE = 'https://www.googleapis.com/auth/cloud-language' diff --git a/generated/google/apis/language_v1/classes.rb b/generated/google/apis/language_v1/classes.rb index 798f8c10e..c9fabe669 100644 --- a/generated/google/apis/language_v1/classes.rb +++ b/generated/google/apis/language_v1/classes.rb @@ -26,8 +26,8 @@ module Google class AnalyzeEntitiesRequest include Google::Apis::Core::Hashable - # ################################################################ # - # Represents the input to API methods. + # ################################################################ # Represents + # the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1::Document] attr_accessor :document @@ -57,9 +57,9 @@ module Google # @return [Array] attr_accessor :entities - # The language of the text, which will be the same as the language specified - # in the request or, if not specified, the automatically-detected language. - # See Document.language field for more details. + # The language of the text, which will be the same as the language specified in + # the request or, if not specified, the automatically-detected language. See + # Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language @@ -79,8 +79,8 @@ module Google class AnalyzeEntitySentimentRequest include Google::Apis::Core::Hashable - # ################################################################ # - # Represents the input to API methods. + # ################################################################ # Represents + # the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1::Document] attr_accessor :document @@ -110,9 +110,9 @@ module Google # @return [Array] attr_accessor :entities - # The language of the text, which will be the same as the language specified - # in the request or, if not specified, the automatically-detected language. - # See Document.language field for more details. + # The language of the text, which will be the same as the language specified in + # the request or, if not specified, the automatically-detected language. See + # Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language @@ -132,8 +132,8 @@ module Google class AnalyzeSentimentRequest include Google::Apis::Core::Hashable - # ################################################################ # - # Represents the input to API methods. + # ################################################################ # Represents + # the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1::Document] attr_accessor :document @@ -158,15 +158,14 @@ module Google class AnalyzeSentimentResponse include Google::Apis::Core::Hashable - # Represents the feeling associated with the entire text or entities in - # the text. + # Represents the feeling associated with the entire text or entities in the text. # Corresponds to the JSON property `documentSentiment` # @return [Google::Apis::LanguageV1::Sentiment] attr_accessor :document_sentiment - # The language of the text, which will be the same as the language specified - # in the request or, if not specified, the automatically-detected language. - # See Document.language field for more details. + # The language of the text, which will be the same as the language specified in + # the request or, if not specified, the automatically-detected language. See + # Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language @@ -192,8 +191,8 @@ module Google class AnalyzeSyntaxRequest include Google::Apis::Core::Hashable - # ################################################################ # - # Represents the input to API methods. + # ################################################################ # Represents + # the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1::Document] attr_accessor :document @@ -218,9 +217,9 @@ module Google class AnalyzeSyntaxResponse include Google::Apis::Core::Hashable - # The language of the text, which will be the same as the language specified - # in the request or, if not specified, the automatically-detected language. - # See Document.language field for more details. + # The language of the text, which will be the same as the language specified in + # the request or, if not specified, the automatically-detected language. See + # Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language @@ -252,8 +251,8 @@ module Google class AnnotateTextRequest include Google::Apis::Core::Hashable - # ################################################################ # - # Represents the input to API methods. + # ################################################################ # Represents + # the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1::Document] attr_accessor :document @@ -263,8 +262,8 @@ module Google # @return [String] attr_accessor :encoding_type - # All available features for sentiment, syntax, and semantic analysis. - # Setting each one to true will enable that specific analysis for the input. + # All available features for sentiment, syntax, and semantic analysis. Setting + # each one to true will enable that specific analysis for the input. # Corresponds to the JSON property `features` # @return [Google::Apis::LanguageV1::Features] attr_accessor :features @@ -290,22 +289,20 @@ module Google # @return [Array] attr_accessor :categories - # Represents the feeling associated with the entire text or entities in - # the text. + # Represents the feeling associated with the entire text or entities in the text. # Corresponds to the JSON property `documentSentiment` # @return [Google::Apis::LanguageV1::Sentiment] attr_accessor :document_sentiment # Entities, along with their semantic information, in the input document. - # Populated if the user enables - # AnnotateTextRequest.Features.extract_entities. + # Populated if the user enables AnnotateTextRequest.Features.extract_entities. # Corresponds to the JSON property `entities` # @return [Array] attr_accessor :entities - # The language of the text, which will be the same as the language specified - # in the request or, if not specified, the automatically-detected language. - # See Document.language field for more details. + # The language of the text, which will be the same as the language specified in + # the request or, if not specified, the automatically-detected language. See + # Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language @@ -317,8 +314,7 @@ module Google attr_accessor :sentences # Tokens, along with their syntactic information, in the input document. - # Populated if the user enables - # AnnotateTextRequest.Features.extract_syntax. + # Populated if the user enables AnnotateTextRequest.Features.extract_syntax. # Corresponds to the JSON property `tokens` # @return [Array] attr_accessor :tokens @@ -342,8 +338,8 @@ module Google class ClassificationCategory include Google::Apis::Core::Hashable - # The classifier's confidence of the category. Number represents how certain - # the classifier is that this category represents the given text. + # The classifier's confidence of the category. Number represents how certain the + # classifier is that this category represents the given text. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -369,8 +365,8 @@ module Google class ClassifyTextRequest include Google::Apis::Core::Hashable - # ################################################################ # - # Represents the input to API methods. + # ################################################################ # Represents + # the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1::Document] attr_accessor :document @@ -405,16 +401,14 @@ module Google end # Represents dependency parse tree information for a token. (For more - # information on dependency labels, see - # http://www.aclweb.org/anthology/P13-2017 + # information on dependency labels, see http://www.aclweb.org/anthology/P13-2017 class DependencyEdge include Google::Apis::Core::Hashable - # Represents the head of this token in the dependency tree. - # This is the index of the token which has an arc going to this token. - # The index is the position of the token in the array of tokens returned - # by the API method. If this token is a root token, then the - # `head_token_index` is its own index. + # Represents the head of this token in the dependency tree. This is the index of + # the token which has an arc going to this token. The index is the position of + # the token in the array of tokens returned by the API method. If this token is + # a root token, then the `head_token_index` is its own index. # Corresponds to the JSON property `headTokenIndex` # @return [Fixnum] attr_accessor :head_token_index @@ -435,39 +429,37 @@ module Google end end - # ################################################################ # - # Represents the input to API methods. + # ################################################################ # Represents + # the input to API methods. class Document include Google::Apis::Core::Hashable - # The content of the input in string format. - # Cloud audit logging exempt since it is based on user data. + # The content of the input in string format. Cloud audit logging exempt since it + # is based on user data. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content - # The Google Cloud Storage URI where the file content is located. - # This URI must be of the form: gs://bucket_name/object_name. For more - # details, see https://cloud.google.com/storage/docs/reference-uris. - # NOTE: Cloud Storage object versioning is not supported. + # The Google Cloud Storage URI where the file content is located. This URI must + # be of the form: gs://bucket_name/object_name. For more details, see https:// + # cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object + # versioning is not supported. # Corresponds to the JSON property `gcsContentUri` # @return [String] attr_accessor :gcs_content_uri - # The language of the document (if not specified, the language is - # automatically detected). Both ISO and BCP-47 language codes are - # accepted.
- # [Language - # Support](https://cloud.google.com/natural-language/docs/languages) lists - # currently supported languages for each API method. If the language (either - # specified by the caller or automatically detected) is not supported by the - # called API method, an `INVALID_ARGUMENT` error is returned. + # The language of the document (if not specified, the language is automatically + # detected). Both ISO and BCP-47 language codes are accepted. [Language Support]( + # https://cloud.google.com/natural-language/docs/languages) lists currently + # supported languages for each API method. If the language (either specified by + # the caller or automatically detected) is not supported by the called API + # method, an `INVALID_ARGUMENT` error is returned. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language - # Required. If the type is not set or is `TYPE_UNSPECIFIED`, - # returns an `INVALID_ARGUMENT` error. + # Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an ` + # INVALID_ARGUMENT` error. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -485,22 +477,22 @@ module Google end end - # Represents a phrase in the text that is a known entity, such as - # a person, an organization, or location. The API associates information, such - # as salience and mentions, with entities. + # Represents a phrase in the text that is a known entity, such as a person, an + # organization, or location. The API associates information, such as salience + # and mentions, with entities. class Entity include Google::Apis::Core::Hashable - # The mentions of this entity in the input document. The API currently - # supports proper noun mentions. + # The mentions of this entity in the input document. The API currently supports + # proper noun mentions. # Corresponds to the JSON property `mentions` # @return [Array] attr_accessor :mentions - # Metadata associated with the entity. - # For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) - # and Knowledge Graph MID (`mid`), if they are available. For the metadata - # associated with other entity types, see the Type table below. + # Metadata associated with the entity. For most entity types, the metadata is a + # Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are + # available. For the metadata associated with other entity types, see the Type + # table below. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata @@ -510,17 +502,15 @@ module Google # @return [String] attr_accessor :name - # The salience score associated with the entity in the [0, 1.0] range. - # The salience score for an entity provides information about the - # importance or centrality of that entity to the entire document text. - # Scores closer to 0 are less salient, while scores closer to 1.0 are highly - # salient. + # The salience score associated with the entity in the [0, 1.0] range. The + # salience score for an entity provides information about the importance or + # centrality of that entity to the entire document text. Scores closer to 0 are + # less salient, while scores closer to 1.0 are highly salient. # Corresponds to the JSON property `salience` # @return [Float] attr_accessor :salience - # Represents the feeling associated with the entire text or entities in - # the text. + # Represents the feeling associated with the entire text or entities in the text. # Corresponds to the JSON property `sentiment` # @return [Google::Apis::LanguageV1::Sentiment] attr_accessor :sentiment @@ -550,8 +540,7 @@ module Google class EntityMention include Google::Apis::Core::Hashable - # Represents the feeling associated with the entire text or entities in - # the text. + # Represents the feeling associated with the entire text or entities in the text. # Corresponds to the JSON property `sentiment` # @return [Google::Apis::LanguageV1::Sentiment] attr_accessor :sentiment @@ -578,8 +567,8 @@ module Google end end - # All available features for sentiment, syntax, and semantic analysis. - # Setting each one to true will enable that specific analysis for the input. + # All available features for sentiment, syntax, and semantic analysis. Setting + # each one to true will enable that specific analysis for the input. class Features include Google::Apis::Core::Hashable @@ -627,9 +616,8 @@ module Google end end - # Represents part of speech information for a token. Parts of speech - # are as defined in - # http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf + # Represents part of speech information for a token. Parts of speech are as + # defined in http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf class PartOfSpeech include Google::Apis::Core::Hashable @@ -718,8 +706,7 @@ module Google class Sentence include Google::Apis::Core::Hashable - # Represents the feeling associated with the entire text or entities in - # the text. + # Represents the feeling associated with the entire text or entities in the text. # Corresponds to the JSON property `sentiment` # @return [Google::Apis::LanguageV1::Sentiment] attr_accessor :sentiment @@ -740,20 +727,17 @@ module Google end end - # Represents the feeling associated with the entire text or entities in - # the text. + # Represents the feeling associated with the entire text or entities in the text. class Sentiment include Google::Apis::Core::Hashable - # A non-negative number in the [0, +inf) range, which represents - # the absolute magnitude of sentiment regardless of score (positive or - # negative). + # A non-negative number in the [0, +inf) range, which represents the absolute + # magnitude of sentiment regardless of score (positive or negative). # Corresponds to the JSON property `magnitude` # @return [Float] attr_accessor :magnitude - # Sentiment score between -1.0 (negative sentiment) and 1.0 - # (positive sentiment). + # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -769,12 +753,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 @@ -783,15 +767,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 @@ -839,8 +823,7 @@ module Google include Google::Apis::Core::Hashable # Represents dependency parse tree information for a token. (For more - # information on dependency labels, see - # http://www.aclweb.org/anthology/P13-2017 + # information on dependency labels, see http://www.aclweb.org/anthology/P13-2017 # Corresponds to the JSON property `dependencyEdge` # @return [Google::Apis::LanguageV1::DependencyEdge] attr_accessor :dependency_edge @@ -850,9 +833,8 @@ module Google # @return [String] attr_accessor :lemma - # Represents part of speech information for a token. Parts of speech - # are as defined in - # http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf + # Represents part of speech information for a token. Parts of speech are as + # defined in http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf # Corresponds to the JSON property `partOfSpeech` # @return [Google::Apis::LanguageV1::PartOfSpeech] attr_accessor :part_of_speech diff --git a/generated/google/apis/language_v1/service.rb b/generated/google/apis/language_v1/service.rb index 34ea5e1ef..67b293c4a 100644 --- a/generated/google/apis/language_v1/service.rb +++ b/generated/google/apis/language_v1/service.rb @@ -50,8 +50,8 @@ module Google end # Finds named entities (currently proper names and common nouns) in the text - # along with entity types, salience, mentions for each entity, and - # other properties. + # along with entity types, salience, mentions for each entity, and other + # properties. # @param [Google::Apis::LanguageV1::AnalyzeEntitiesRequest] analyze_entities_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -81,8 +81,8 @@ module Google execute_or_queue_command(command, &block) end - # Finds entities, similar to AnalyzeEntities in the text and analyzes - # sentiment associated with each entity and its mentions. + # Finds entities, similar to AnalyzeEntities in the text and analyzes sentiment + # associated with each entity and its mentions. # @param [Google::Apis::LanguageV1::AnalyzeEntitySentimentRequest] analyze_entity_sentiment_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/language_v1beta1.rb b/generated/google/apis/language_v1beta1.rb index e58842b24..27de5a086 100644 --- a/generated/google/apis/language_v1beta1.rb +++ b/generated/google/apis/language_v1beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/natural-language/ module LanguageV1beta1 VERSION = 'V1beta1' - REVISION = '20200406' + REVISION = '20200801' # Apply machine learning models to reveal the structure and meaning of text AUTH_CLOUD_LANGUAGE = 'https://www.googleapis.com/auth/cloud-language' diff --git a/generated/google/apis/language_v1beta1/classes.rb b/generated/google/apis/language_v1beta1/classes.rb index 58a44339b..095dbacf1 100644 --- a/generated/google/apis/language_v1beta1/classes.rb +++ b/generated/google/apis/language_v1beta1/classes.rb @@ -26,8 +26,8 @@ module Google class AnalyzeEntitiesRequest include Google::Apis::Core::Hashable - # ################################################################ # - # Represents the input to API methods. + # ################################################################ # Represents + # the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1beta1::Document] attr_accessor :document @@ -57,9 +57,9 @@ module Google # @return [Array] attr_accessor :entities - # The language of the text, which will be the same as the language specified - # in the request or, if not specified, the automatically-detected language. - # See Document.language field for more details. + # The language of the text, which will be the same as the language specified in + # the request or, if not specified, the automatically-detected language. See + # Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language @@ -79,8 +79,8 @@ module Google class AnalyzeSentimentRequest include Google::Apis::Core::Hashable - # ################################################################ # - # Represents the input to API methods. + # ################################################################ # Represents + # the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1beta1::Document] attr_accessor :document @@ -106,15 +106,14 @@ module Google class AnalyzeSentimentResponse include Google::Apis::Core::Hashable - # Represents the feeling associated with the entire text or entities in - # the text. + # Represents the feeling associated with the entire text or entities in the text. # Corresponds to the JSON property `documentSentiment` # @return [Google::Apis::LanguageV1beta1::Sentiment] attr_accessor :document_sentiment - # The language of the text, which will be the same as the language specified - # in the request or, if not specified, the automatically-detected language. - # See Document.language field for more details. + # The language of the text, which will be the same as the language specified in + # the request or, if not specified, the automatically-detected language. See + # Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language @@ -140,8 +139,8 @@ module Google class AnalyzeSyntaxRequest include Google::Apis::Core::Hashable - # ################################################################ # - # Represents the input to API methods. + # ################################################################ # Represents + # the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1beta1::Document] attr_accessor :document @@ -166,9 +165,9 @@ module Google class AnalyzeSyntaxResponse include Google::Apis::Core::Hashable - # The language of the text, which will be the same as the language specified - # in the request or, if not specified, the automatically-detected language. - # See Document.language field for more details. + # The language of the text, which will be the same as the language specified in + # the request or, if not specified, the automatically-detected language. See + # Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language @@ -200,8 +199,8 @@ module Google class AnnotateTextRequest include Google::Apis::Core::Hashable - # ################################################################ # - # Represents the input to API methods. + # ################################################################ # Represents + # the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1beta1::Document] attr_accessor :document @@ -211,8 +210,8 @@ module Google # @return [String] attr_accessor :encoding_type - # All available features for sentiment, syntax, and semantic analysis. - # Setting each one to true will enable that specific analysis for the input. + # All available features for sentiment, syntax, and semantic analysis. Setting + # each one to true will enable that specific analysis for the input. # Corresponds to the JSON property `features` # @return [Google::Apis::LanguageV1beta1::Features] attr_accessor :features @@ -233,22 +232,20 @@ module Google class AnnotateTextResponse include Google::Apis::Core::Hashable - # Represents the feeling associated with the entire text or entities in - # the text. + # Represents the feeling associated with the entire text or entities in the text. # Corresponds to the JSON property `documentSentiment` # @return [Google::Apis::LanguageV1beta1::Sentiment] attr_accessor :document_sentiment # Entities, along with their semantic information, in the input document. - # Populated if the user enables - # AnnotateTextRequest.Features.extract_entities. + # Populated if the user enables AnnotateTextRequest.Features.extract_entities. # Corresponds to the JSON property `entities` # @return [Array] attr_accessor :entities - # The language of the text, which will be the same as the language specified - # in the request or, if not specified, the automatically-detected language. - # See Document.language field for more details. + # The language of the text, which will be the same as the language specified in + # the request or, if not specified, the automatically-detected language. See + # Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language @@ -260,8 +257,7 @@ module Google attr_accessor :sentences # Tokens, along with their syntactic information, in the input document. - # Populated if the user enables - # AnnotateTextRequest.Features.extract_syntax. + # Populated if the user enables AnnotateTextRequest.Features.extract_syntax. # Corresponds to the JSON property `tokens` # @return [Array] attr_accessor :tokens @@ -284,11 +280,10 @@ module Google class DependencyEdge include Google::Apis::Core::Hashable - # Represents the head of this token in the dependency tree. - # This is the index of the token which has an arc going to this token. - # The index is the position of the token in the array of tokens returned - # by the API method. If this token is a root token, then the - # `head_token_index` is its own index. + # Represents the head of this token in the dependency tree. This is the index of + # the token which has an arc going to this token. The index is the position of + # the token in the array of tokens returned by the API method. If this token is + # a root token, then the `head_token_index` is its own index. # Corresponds to the JSON property `headTokenIndex` # @return [Fixnum] attr_accessor :head_token_index @@ -309,39 +304,37 @@ module Google end end - # ################################################################ # - # Represents the input to API methods. + # ################################################################ # Represents + # the input to API methods. class Document include Google::Apis::Core::Hashable - # The content of the input in string format. - # Cloud audit logging exempt since it is based on user data. + # The content of the input in string format. Cloud audit logging exempt since it + # is based on user data. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content - # The Google Cloud Storage URI where the file content is located. - # This URI must be of the form: gs://bucket_name/object_name. For more - # details, see https://cloud.google.com/storage/docs/reference-uris. - # NOTE: Cloud Storage object versioning is not supported. + # The Google Cloud Storage URI where the file content is located. This URI must + # be of the form: gs://bucket_name/object_name. For more details, see https:// + # cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object + # versioning is not supported. # Corresponds to the JSON property `gcsContentUri` # @return [String] attr_accessor :gcs_content_uri - # The language of the document (if not specified, the language is - # automatically detected). Both ISO and BCP-47 language codes are - # accepted.
- # [Language - # Support](https://cloud.google.com/natural-language/docs/languages) lists - # currently supported languages for each API method. If the language (either - # specified by the caller or automatically detected) is not supported by the - # called API method, an `INVALID_ARGUMENT` error is returned. + # The language of the document (if not specified, the language is automatically + # detected). Both ISO and BCP-47 language codes are accepted. [Language Support]( + # https://cloud.google.com/natural-language/docs/languages) lists currently + # supported languages for each API method. If the language (either specified by + # the caller or automatically detected) is not supported by the called API + # method, an `INVALID_ARGUMENT` error is returned. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language - # Required. If the type is not set or is `TYPE_UNSPECIFIED`, - # returns an `INVALID_ARGUMENT` error. + # Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an ` + # INVALID_ARGUMENT` error. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -359,21 +352,21 @@ module Google end end - # Represents a phrase in the text that is a known entity, such as - # a person, an organization, or location. The API associates information, such - # as salience and mentions, with entities. + # Represents a phrase in the text that is a known entity, such as a person, an + # organization, or location. The API associates information, such as salience + # and mentions, with entities. class Entity include Google::Apis::Core::Hashable - # The mentions of this entity in the input document. The API currently - # supports proper noun mentions. + # The mentions of this entity in the input document. The API currently supports + # proper noun mentions. # Corresponds to the JSON property `mentions` # @return [Array] attr_accessor :mentions - # Metadata associated with the entity. - # Currently, Wikipedia URLs and Knowledge Graph MIDs are provided, if - # available. The associated keys are "wikipedia_url" and "mid", respectively. + # Metadata associated with the entity. Currently, Wikipedia URLs and Knowledge + # Graph MIDs are provided, if available. The associated keys are "wikipedia_url" + # and "mid", respectively. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata @@ -383,11 +376,10 @@ module Google # @return [String] attr_accessor :name - # The salience score associated with the entity in the [0, 1.0] range. - # The salience score for an entity provides information about the - # importance or centrality of that entity to the entire document text. - # Scores closer to 0 are less salient, while scores closer to 1.0 are highly - # salient. + # The salience score associated with the entity in the [0, 1.0] range. The + # salience score for an entity provides information about the importance or + # centrality of that entity to the entire document text. Scores closer to 0 are + # less salient, while scores closer to 1.0 are highly salient. # Corresponds to the JSON property `salience` # @return [Float] attr_accessor :salience @@ -437,8 +429,8 @@ module Google end end - # All available features for sentiment, syntax, and semantic analysis. - # Setting each one to true will enable that specific analysis for the input. + # All available features for sentiment, syntax, and semantic analysis. Setting + # each one to true will enable that specific analysis for the input. class Features include Google::Apis::Core::Hashable @@ -561,8 +553,7 @@ module Google class Sentence include Google::Apis::Core::Hashable - # Represents the feeling associated with the entire text or entities in - # the text. + # Represents the feeling associated with the entire text or entities in the text. # Corresponds to the JSON property `sentiment` # @return [Google::Apis::LanguageV1beta1::Sentiment] attr_accessor :sentiment @@ -583,27 +574,24 @@ module Google end end - # Represents the feeling associated with the entire text or entities in - # the text. + # Represents the feeling associated with the entire text or entities in the text. class Sentiment include Google::Apis::Core::Hashable - # A non-negative number in the [0, +inf) range, which represents - # the absolute magnitude of sentiment regardless of score (positive or - # negative). + # A non-negative number in the [0, +inf) range, which represents the absolute + # magnitude of sentiment regardless of score (positive or negative). # Corresponds to the JSON property `magnitude` # @return [Float] attr_accessor :magnitude - # DEPRECATED FIELD - This field is being deprecated in - # favor of score. Please refer to our documentation at - # https://cloud.google.com/natural-language/docs for more information. + # DEPRECATED FIELD - This field is being deprecated in favor of score. Please + # refer to our documentation at https://cloud.google.com/natural-language/docs + # for more information. # Corresponds to the JSON property `polarity` # @return [Float] attr_accessor :polarity - # Sentiment score between -1.0 (negative sentiment) and 1.0 - # (positive sentiment). + # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -620,12 +608,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 @@ -634,15 +622,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 diff --git a/generated/google/apis/language_v1beta1/service.rb b/generated/google/apis/language_v1beta1/service.rb index 8ffe09bac..8c5d9b129 100644 --- a/generated/google/apis/language_v1beta1/service.rb +++ b/generated/google/apis/language_v1beta1/service.rb @@ -50,8 +50,8 @@ module Google end # Finds named entities (currently proper names and common nouns) in the text - # along with entity types, salience, mentions for each entity, and - # other properties. + # along with entity types, salience, mentions for each entity, and other + # properties. # @param [Google::Apis::LanguageV1beta1::AnalyzeEntitiesRequest] analyze_entities_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/language_v1beta2.rb b/generated/google/apis/language_v1beta2.rb index 17ec72fb6..2a15e6f92 100644 --- a/generated/google/apis/language_v1beta2.rb +++ b/generated/google/apis/language_v1beta2.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/natural-language/ module LanguageV1beta2 VERSION = 'V1beta2' - REVISION = '20200406' + REVISION = '20200801' # Apply machine learning models to reveal the structure and meaning of text AUTH_CLOUD_LANGUAGE = 'https://www.googleapis.com/auth/cloud-language' diff --git a/generated/google/apis/language_v1beta2/classes.rb b/generated/google/apis/language_v1beta2/classes.rb index c1a7f7f74..6644b86e5 100644 --- a/generated/google/apis/language_v1beta2/classes.rb +++ b/generated/google/apis/language_v1beta2/classes.rb @@ -26,8 +26,8 @@ module Google class AnalyzeEntitiesRequest include Google::Apis::Core::Hashable - # ################################################################ # - # Represents the input to API methods. + # ################################################################ # Represents + # the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1beta2::Document] attr_accessor :document @@ -57,9 +57,9 @@ module Google # @return [Array] attr_accessor :entities - # The language of the text, which will be the same as the language specified - # in the request or, if not specified, the automatically-detected language. - # See Document.language field for more details. + # The language of the text, which will be the same as the language specified in + # the request or, if not specified, the automatically-detected language. See + # Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language @@ -79,8 +79,8 @@ module Google class AnalyzeEntitySentimentRequest include Google::Apis::Core::Hashable - # ################################################################ # - # Represents the input to API methods. + # ################################################################ # Represents + # the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1beta2::Document] attr_accessor :document @@ -110,9 +110,9 @@ module Google # @return [Array] attr_accessor :entities - # The language of the text, which will be the same as the language specified - # in the request or, if not specified, the automatically-detected language. - # See Document.language field for more details. + # The language of the text, which will be the same as the language specified in + # the request or, if not specified, the automatically-detected language. See + # Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language @@ -132,8 +132,8 @@ module Google class AnalyzeSentimentRequest include Google::Apis::Core::Hashable - # ################################################################ # - # Represents the input to API methods. + # ################################################################ # Represents + # the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1beta2::Document] attr_accessor :document @@ -159,16 +159,15 @@ module Google class AnalyzeSentimentResponse include Google::Apis::Core::Hashable - # Represents the feeling associated with the entire text or entities in - # the text. + # Represents the feeling associated with the entire text or entities in the text. # Next ID: 6 # Corresponds to the JSON property `documentSentiment` # @return [Google::Apis::LanguageV1beta2::Sentiment] attr_accessor :document_sentiment - # The language of the text, which will be the same as the language specified - # in the request or, if not specified, the automatically-detected language. - # See Document.language field for more details. + # The language of the text, which will be the same as the language specified in + # the request or, if not specified, the automatically-detected language. See + # Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language @@ -194,8 +193,8 @@ module Google class AnalyzeSyntaxRequest include Google::Apis::Core::Hashable - # ################################################################ # - # Represents the input to API methods. + # ################################################################ # Represents + # the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1beta2::Document] attr_accessor :document @@ -220,9 +219,9 @@ module Google class AnalyzeSyntaxResponse include Google::Apis::Core::Hashable - # The language of the text, which will be the same as the language specified - # in the request or, if not specified, the automatically-detected language. - # See Document.language field for more details. + # The language of the text, which will be the same as the language specified in + # the request or, if not specified, the automatically-detected language. See + # Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language @@ -254,8 +253,8 @@ module Google class AnnotateTextRequest include Google::Apis::Core::Hashable - # ################################################################ # - # Represents the input to API methods. + # ################################################################ # Represents + # the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1beta2::Document] attr_accessor :document @@ -265,9 +264,8 @@ module Google # @return [String] attr_accessor :encoding_type - # All available features for sentiment, syntax, and semantic analysis. - # Setting each one to true will enable that specific analysis for the input. - # Next ID: 10 + # All available features for sentiment, syntax, and semantic analysis. Setting + # each one to true will enable that specific analysis for the input. Next ID: 10 # Corresponds to the JSON property `features` # @return [Google::Apis::LanguageV1beta2::Features] attr_accessor :features @@ -293,23 +291,21 @@ module Google # @return [Array] attr_accessor :categories - # Represents the feeling associated with the entire text or entities in - # the text. + # Represents the feeling associated with the entire text or entities in the text. # Next ID: 6 # Corresponds to the JSON property `documentSentiment` # @return [Google::Apis::LanguageV1beta2::Sentiment] attr_accessor :document_sentiment # Entities, along with their semantic information, in the input document. - # Populated if the user enables - # AnnotateTextRequest.Features.extract_entities. + # Populated if the user enables AnnotateTextRequest.Features.extract_entities. # Corresponds to the JSON property `entities` # @return [Array] attr_accessor :entities - # The language of the text, which will be the same as the language specified - # in the request or, if not specified, the automatically-detected language. - # See Document.language field for more details. + # The language of the text, which will be the same as the language specified in + # the request or, if not specified, the automatically-detected language. See + # Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language @@ -321,8 +317,7 @@ module Google attr_accessor :sentences # Tokens, along with their syntactic information, in the input document. - # Populated if the user enables - # AnnotateTextRequest.Features.extract_syntax. + # Populated if the user enables AnnotateTextRequest.Features.extract_syntax. # Corresponds to the JSON property `tokens` # @return [Array] attr_accessor :tokens @@ -346,8 +341,8 @@ module Google class ClassificationCategory include Google::Apis::Core::Hashable - # The classifier's confidence of the category. Number represents how certain - # the classifier is that this category represents the given text. + # The classifier's confidence of the category. Number represents how certain the + # classifier is that this category represents the given text. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -373,8 +368,8 @@ module Google class ClassifyTextRequest include Google::Apis::Core::Hashable - # ################################################################ # - # Represents the input to API methods. + # ################################################################ # Represents + # the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1beta2::Document] attr_accessor :document @@ -412,11 +407,10 @@ module Google class DependencyEdge include Google::Apis::Core::Hashable - # Represents the head of this token in the dependency tree. - # This is the index of the token which has an arc going to this token. - # The index is the position of the token in the array of tokens returned - # by the API method. If this token is a root token, then the - # `head_token_index` is its own index. + # Represents the head of this token in the dependency tree. This is the index of + # the token which has an arc going to this token. The index is the position of + # the token in the array of tokens returned by the API method. If this token is + # a root token, then the `head_token_index` is its own index. # Corresponds to the JSON property `headTokenIndex` # @return [Fixnum] attr_accessor :head_token_index @@ -437,52 +431,50 @@ module Google end end - # ################################################################ # - # Represents the input to API methods. + # ################################################################ # Represents + # the input to API methods. class Document include Google::Apis::Core::Hashable - # Indicates how detected boilerplate(e.g. advertisements, copyright - # declarations, banners) should be handled for this document. If not - # specified, boilerplate will be treated the same as content. + # Indicates how detected boilerplate(e.g. advertisements, copyright declarations, + # banners) should be handled for this document. If not specified, boilerplate + # will be treated the same as content. # Corresponds to the JSON property `boilerplateHandling` # @return [String] attr_accessor :boilerplate_handling - # The content of the input in string format. - # Cloud audit logging exempt since it is based on user data. + # The content of the input in string format. Cloud audit logging exempt since it + # is based on user data. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content - # The Google Cloud Storage URI where the file content is located. - # This URI must be of the form: gs://bucket_name/object_name. For more - # details, see https://cloud.google.com/storage/docs/reference-uris. - # NOTE: Cloud Storage object versioning is not supported. + # The Google Cloud Storage URI where the file content is located. This URI must + # be of the form: gs://bucket_name/object_name. For more details, see https:// + # cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object + # versioning is not supported. # Corresponds to the JSON property `gcsContentUri` # @return [String] attr_accessor :gcs_content_uri - # The language of the document (if not specified, the language is - # automatically detected). Both ISO and BCP-47 language codes are - # accepted.
- # [Language - # Support](https://cloud.google.com/natural-language/docs/languages) lists - # currently supported languages for each API method. If the language (either - # specified by the caller or automatically detected) is not supported by the - # called API method, an `INVALID_ARGUMENT` error is returned. + # The language of the document (if not specified, the language is automatically + # detected). Both ISO and BCP-47 language codes are accepted. [Language Support]( + # https://cloud.google.com/natural-language/docs/languages) lists currently + # supported languages for each API method. If the language (either specified by + # the caller or automatically detected) is not supported by the called API + # method, an `INVALID_ARGUMENT` error is returned. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language - # The web URI where the document comes from. This URI is not used for - # fetching the content, but as a hint for analyzing the document. + # The web URI where the document comes from. This URI is not used for fetching + # the content, but as a hint for analyzing the document. # Corresponds to the JSON property `referenceWebUri` # @return [String] attr_accessor :reference_web_uri - # Required. If the type is not set or is `TYPE_UNSPECIFIED`, - # returns an `INVALID_ARGUMENT` error. + # Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an ` + # INVALID_ARGUMENT` error. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -502,22 +494,22 @@ module Google end end - # Represents a phrase in the text that is a known entity, such as - # a person, an organization, or location. The API associates information, such - # as salience and mentions, with entities. + # Represents a phrase in the text that is a known entity, such as a person, an + # organization, or location. The API associates information, such as salience + # and mentions, with entities. class Entity include Google::Apis::Core::Hashable - # The mentions of this entity in the input document. The API currently - # supports proper noun mentions. + # The mentions of this entity in the input document. The API currently supports + # proper noun mentions. # Corresponds to the JSON property `mentions` # @return [Array] attr_accessor :mentions - # Metadata associated with the entity. - # For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) - # and Knowledge Graph MID (`mid`), if they are available. For the metadata - # associated with other entity types, see the Type table below. + # Metadata associated with the entity. For most entity types, the metadata is a + # Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are + # available. For the metadata associated with other entity types, see the Type + # table below. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata @@ -527,17 +519,15 @@ module Google # @return [String] attr_accessor :name - # The salience score associated with the entity in the [0, 1.0] range. - # The salience score for an entity provides information about the - # importance or centrality of that entity to the entire document text. - # Scores closer to 0 are less salient, while scores closer to 1.0 are highly - # salient. + # The salience score associated with the entity in the [0, 1.0] range. The + # salience score for an entity provides information about the importance or + # centrality of that entity to the entire document text. Scores closer to 0 are + # less salient, while scores closer to 1.0 are highly salient. # Corresponds to the JSON property `salience` # @return [Float] attr_accessor :salience - # Represents the feeling associated with the entire text or entities in - # the text. + # Represents the feeling associated with the entire text or entities in the text. # Next ID: 6 # Corresponds to the JSON property `sentiment` # @return [Google::Apis::LanguageV1beta2::Sentiment] @@ -568,8 +558,7 @@ module Google class EntityMention include Google::Apis::Core::Hashable - # Represents the feeling associated with the entire text or entities in - # the text. + # Represents the feeling associated with the entire text or entities in the text. # Next ID: 6 # Corresponds to the JSON property `sentiment` # @return [Google::Apis::LanguageV1beta2::Sentiment] @@ -597,16 +586,14 @@ module Google end end - # All available features for sentiment, syntax, and semantic analysis. - # Setting each one to true will enable that specific analysis for the input. - # Next ID: 10 + # All available features for sentiment, syntax, and semantic analysis. Setting + # each one to true will enable that specific analysis for the input. Next ID: 10 class Features include Google::Apis::Core::Hashable - # Classify the full document into categories. If this is true, - # the API will use the default model which classifies into a - # [predefined - # taxonomy](https://cloud.google.com/natural-language/docs/categories). + # Classify the full document into categories. If this is true, the API will use + # the default model which classifies into a [predefined taxonomy](https://cloud. + # google.com/natural-language/docs/categories). # Corresponds to the JSON property `classifyText` # @return [Boolean] attr_accessor :classify_text @@ -739,8 +726,7 @@ module Google class Sentence include Google::Apis::Core::Hashable - # Represents the feeling associated with the entire text or entities in - # the text. + # Represents the feeling associated with the entire text or entities in the text. # Next ID: 6 # Corresponds to the JSON property `sentiment` # @return [Google::Apis::LanguageV1beta2::Sentiment] @@ -762,21 +748,18 @@ module Google end end - # Represents the feeling associated with the entire text or entities in - # the text. + # Represents the feeling associated with the entire text or entities in the text. # Next ID: 6 class Sentiment include Google::Apis::Core::Hashable - # A non-negative number in the [0, +inf) range, which represents - # the absolute magnitude of sentiment regardless of score (positive or - # negative). + # A non-negative number in the [0, +inf) range, which represents the absolute + # magnitude of sentiment regardless of score (positive or negative). # Corresponds to the JSON property `magnitude` # @return [Float] attr_accessor :magnitude - # Sentiment score between -1.0 (negative sentiment) and 1.0 - # (positive sentiment). + # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -792,12 +775,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 @@ -806,15 +789,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 diff --git a/generated/google/apis/language_v1beta2/service.rb b/generated/google/apis/language_v1beta2/service.rb index fe04f04c8..f54c595d4 100644 --- a/generated/google/apis/language_v1beta2/service.rb +++ b/generated/google/apis/language_v1beta2/service.rb @@ -50,8 +50,8 @@ module Google end # Finds named entities (currently proper names and common nouns) in the text - # along with entity types, salience, mentions for each entity, and - # other properties. + # along with entity types, salience, mentions for each entity, and other + # properties. # @param [Google::Apis::LanguageV1beta2::AnalyzeEntitiesRequest] analyze_entities_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -81,8 +81,8 @@ module Google execute_or_queue_command(command, &block) end - # Finds entities, similar to AnalyzeEntities in the text and analyzes - # sentiment associated with each entity and its mentions. + # Finds entities, similar to AnalyzeEntities in the text and analyzes sentiment + # associated with each entity and its mentions. # @param [Google::Apis::LanguageV1beta2::AnalyzeEntitySentimentRequest] analyze_entity_sentiment_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/libraryagent_v1.rb b/generated/google/apis/libraryagent_v1.rb index c64cb969b..37baa8605 100644 --- a/generated/google/apis/libraryagent_v1.rb +++ b/generated/google/apis/libraryagent_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/docs/quota module LibraryagentV1 VERSION = 'V1' - REVISION = '20200215' + REVISION = '20200801' # 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/libraryagent_v1/classes.rb b/generated/google/apis/libraryagent_v1/classes.rb index 513ebfd5a..a093d33b4 100644 --- a/generated/google/apis/libraryagent_v1/classes.rb +++ b/generated/google/apis/libraryagent_v1/classes.rb @@ -31,9 +31,8 @@ module Google # @return [String] attr_accessor :author - # The resource name of the book. - # Book names have the form `shelves/`shelf_id`/books/`book_id``. - # The name is ignored when creating a book. + # The resource name of the book. Book names have the form `shelves/`shelf_id`/ + # books/`book_id``. The name is ignored when creating a book. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -71,11 +70,9 @@ module Google # @return [Array] attr_accessor :books - # A token to retrieve next page of results. - # Pass this value in the - # ListBooksRequest.page_token - # field in the subsequent call to `ListBooks` method to retrieve the next - # page of results. + # A token to retrieve next page of results. Pass this value in the + # ListBooksRequest.page_token field in the subsequent call to `ListBooks` method + # to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -95,11 +92,9 @@ module Google class GoogleExampleLibraryagentV1ListShelvesResponse include Google::Apis::Core::Hashable - # A token to retrieve next page of results. - # Pass this value in the - # ListShelvesRequest.page_token - # field in the subsequent call to `ListShelves` method to retrieve the next - # page of results. + # A token to retrieve next page of results. Pass this value in the + # ListShelvesRequest.page_token field in the subsequent call to `ListShelves` + # method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -124,9 +119,8 @@ module Google class GoogleExampleLibraryagentV1Shelf include Google::Apis::Core::Hashable - # Output only. The resource name of the shelf. - # Shelf names have the form `shelves/`shelf_id``. - # The name is ignored when creating a shelf. + # Output only. The resource name of the shelf. Shelf names have the form ` + # shelves/`shelf_id``. The name is ignored when creating a shelf. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name diff --git a/generated/google/apis/libraryagent_v1/service.rb b/generated/google/apis/libraryagent_v1/service.rb index e56ff25f0..345d7b00b 100644 --- a/generated/google/apis/libraryagent_v1/service.rb +++ b/generated/google/apis/libraryagent_v1/service.rb @@ -80,13 +80,12 @@ module Google # Lists shelves. The order is unspecified but deterministic. Newly created # shelves will not necessarily be added to the end of this list. # @param [Fixnum] page_size - # Requested page size. Server may return fewer shelves than requested. - # If unspecified, server will pick an appropriate default. + # Requested page size. Server may return fewer shelves than requested. If + # unspecified, server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListShelvesResponse.next_page_token - # returned from the previous call to `ListShelves` method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListShelvesResponse.next_page_token returned from the + # previous call to `ListShelves` method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -179,18 +178,17 @@ module Google end # Lists books in a shelf. The order is unspecified but deterministic. Newly - # created books will not necessarily be added to the end of this list. - # Returns NOT_FOUND if the shelf does not exist. + # created books will not necessarily be added to the end of this list. Returns + # NOT_FOUND if the shelf does not exist. # @param [String] parent # Required. The name of the shelf whose books we'd like to list. # @param [Fixnum] page_size - # Requested page size. Server may return fewer books than requested. - # If unspecified, server will pick an appropriate default. + # Requested page size. Server may return fewer books than requested. If + # unspecified, server will pick an appropriate default. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListBooksResponse.next_page_token. - # returned from the previous call to `ListBooks` method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListBooksResponse.next_page_token. returned from the + # previous call to `ListBooks` method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -221,8 +219,7 @@ module Google end # Return a book to the library. Returns the book if it is returned to the - # library successfully. - # Returns error if the book does not belong to the library + # library successfully. Returns error if the book does not belong to the library # or the users didn't borrow before. # @param [String] name # Required. The name of the book to return. diff --git a/generated/google/apis/managedidentities_v1.rb b/generated/google/apis/managedidentities_v1.rb index d17f336a9..0fcff1729 100644 --- a/generated/google/apis/managedidentities_v1.rb +++ b/generated/google/apis/managedidentities_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/managed-microsoft-ad/ module ManagedidentitiesV1 VERSION = 'V1' - REVISION = '20200622' + REVISION = '20200727' # 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_v1/classes.rb b/generated/google/apis/managedidentities_v1/classes.rb index bd5834213..ade64c72e 100644 --- a/generated/google/apis/managedidentities_v1/classes.rb +++ b/generated/google/apis/managedidentities_v1/classes.rb @@ -22,13 +22,12 @@ module Google module Apis module ManagedidentitiesV1 - # Request message for - # AttachTrust + # Request message for AttachTrust class AttachTrustRequest include Google::Apis::Core::Hashable - # Represents a relationship between two domains. This allows a controller in - # one domain to authenticate a user in another domain. + # Represents a relationship between two domains. This allows a controller in one + # domain to authenticate a user in another domain. # Corresponds to the JSON property `trust` # @return [Google::Apis::ManagedidentitiesV1::TrustProp] attr_accessor :trust_prop @@ -47,69 +46,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::ManagedidentitiesV1::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 @@ -139,13 +126,12 @@ module Google end end - # Request message for - # DetachTrust + # Request message for DetachTrust class DetachTrustRequest include Google::Apis::Core::Hashable - # Represents a relationship between two domains. This allows a controller in - # one domain to authenticate a user in another domain. + # Represents a relationship between two domains. This allows a controller in one + # domain to authenticate a user in another domain. # Corresponds to the JSON property `trust` # @return [Google::Apis::ManagedidentitiesV1::TrustProp] attr_accessor :trust_prop @@ -164,17 +150,17 @@ module Google class Domain include Google::Apis::Core::Hashable - # Optional. The name of delegated administrator account used to perform - # Active Directory operations. If not specified, `setupadmin` will be used. + # Optional. The name of delegated administrator account used to perform Active + # Directory operations. If not specified, `setupadmin` will be used. # Corresponds to the JSON property `admin` # @return [String] attr_accessor :admin - # 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 listed in `authorized_networks`. - # If CIDR subnets overlap between networks, domain creation will fail. + # 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 + # listed in `authorized_networks`. If CIDR subnets overlap between networks, + # domain creation will fail. # Corresponds to the JSON property `authorizedNetworks` # @return [Array] attr_accessor :authorized_networks @@ -196,25 +182,22 @@ module Google # @return [Hash] attr_accessor :labels - # Required. Locations where domain needs to be provisioned. - # regions - # e.g. us-west1 or us-east4 - # Service supports up to 4 locations at once. Each location will use a /26 - # block. + # Required. Locations where domain needs to be provisioned. regions e.g. us- + # west1 or us-east4 Service supports up to 4 locations at once. Each location + # will use a /26 block. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations - # Required. The unique name of the domain using the form: - # `projects/`project_id`/locations/global/domains/`domain_name``. + # Required. The unique name of the domain using the form: `projects/`project_id`/ + # locations/global/domains/`domain_name``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Required. The CIDR range of internal addresses that are reserved for this - # domain. Reserved networks must be /24 or larger. Ranges must be - # unique and non-overlapping with existing subnets in - # [Domain].[authorized_networks]. + # domain. Reserved networks must be /24 or larger. Ranges must be unique and non- + # overlapping with existing subnets in [Domain].[authorized_networks]. # Corresponds to the JSON property `reservedIpRange` # @return [String] attr_accessor :reserved_ip_range @@ -224,8 +207,8 @@ module Google # @return [String] attr_accessor :state - # Output only. Additional information about the current status of this - # domain, if available. + # Output only. Additional information about the current status of this domain, + # if available. # Corresponds to the JSON property `statusMessage` # @return [String] attr_accessor :status_message @@ -261,13 +244,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 @@ -280,52 +261,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 @@ -362,10 +334,10 @@ module Google # @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`. + # 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 @@ -415,10 +387,10 @@ module Google # @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`. + # 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 @@ -468,10 +440,10 @@ module Google # @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`. + # 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 @@ -507,10 +479,9 @@ module Google include Google::Apis::Core::Hashable # consumer_defined_name is the name that is set by the consumer. On the other - # hand Name field represents system-assigned id of an instance so consumers - # are not necessarily aware of it. - # consumer_defined_name is used for notification/UI purposes for consumer to - # recognize their instances. + # hand Name field represents system-assigned id of an instance so consumers are + # not necessarily aware of it. consumer_defined_name is used for notification/UI + # purposes for consumer to recognize their instances. # Corresponds to the JSON property `consumerDefinedName` # @return [String] attr_accessor :consumer_defined_name @@ -520,18 +491,17 @@ module Google # @return [String] attr_accessor :create_time - # Optional. Resource labels to represent user provided metadata. Each label - # is a key-value pair, where both the key and the value are arbitrary strings + # Optional. Resource labels to represent user provided metadata. Each label is a + # key-value pair, where both the key and the value are arbitrary strings # provided by the user. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # The MaintenancePolicies that have been attached to the instance. - # The key must be of the type name of the oneof policy name defined in - # MaintenancePolicy, and the referenced policy must define the same policy - # type. For complete details of MaintenancePolicy, please refer to - # go/cloud-saas-mw-ug. + # The MaintenancePolicies that have been attached to the instance. The key must + # be of the type name of the oneof policy name defined in MaintenancePolicy, and + # the referenced policy must define the same policy type. For complete details + # of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. # Corresponds to the JSON property `maintenancePolicyNames` # @return [Hash] attr_accessor :maintenance_policy_names @@ -548,29 +518,28 @@ module Google # @return [Google::Apis::ManagedidentitiesV1::GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings] attr_accessor :maintenance_settings - # Unique name of the resource. It uses the form: - # `projects/`project_id`/locations/`location_id`/instances/`instance_id`` + # Unique name of the resource. It uses the form: `projects/`project_id`/ + # locations/`location_id`/instances/`instance_id`` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Output only. Custom string attributes used primarily to expose - # producer-specific information in monitoring dashboards. - # See go/get-instance-metadata. + # Output only. Custom string attributes used primarily to expose producer- + # specific information in monitoring dashboards. See go/get-instance-metadata. # Corresponds to the JSON property `producerMetadata` # @return [Hash] attr_accessor :producer_metadata - # Output only. The list of data plane resources provisioned for this - # instance, e.g. compute VMs. See go/get-instance-metadata. + # Output only. The list of data plane resources provisioned for this instance, e. + # g. compute VMs. See go/get-instance-metadata. # Corresponds to the JSON property `provisionedResources` # @return [Array] attr_accessor :provisioned_resources - # Link to the SLM instance template. Only populated when updating SLM - # instances via SSA's Actuation service adaptor. - # Service producers with custom control plane (e.g. Cloud SQL) doesn't - # need to populate this field. Instead they should use software_versions. + # Link to the SLM instance template. Only populated when updating SLM instances + # via SSA's Actuation service adaptor. Service producers with custom control + # plane (e.g. Cloud SQL) doesn't need to populate this field. Instead they + # should use software_versions. # Corresponds to the JSON property `slmInstanceTemplate` # @return [String] attr_accessor :slm_instance_template @@ -581,8 +550,8 @@ module Google # @return [Google::Apis::ManagedidentitiesV1::GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata] attr_accessor :slo_metadata - # Software versions that are used to deploy this instance. This can be - # mutated by rollout services. + # Software versions that are used to deploy this instance. This can be mutated + # by rollout services. # Corresponds to the JSON property `softwareVersions` # @return [Hash] attr_accessor :software_versions @@ -593,8 +562,8 @@ module Google # @return [String] attr_accessor :state - # Output only. ID of the associated GCP tenant project. - # See go/get-instance-metadata. + # Output only. ID of the associated GCP tenant project. See go/get-instance- + # metadata. # Corresponds to the JSON property `tenantProjectId` # @return [String] attr_accessor :tenant_project_id @@ -633,9 +602,9 @@ module Google class GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule include Google::Apis::Core::Hashable - # Can this scheduled update be rescheduled? - # By default, it's true and API needs to do explicitly check whether it's - # set, if it's set as false explicitly, it's false + # Can this scheduled update be rescheduled? By default, it's true and API needs + # to do explicitly check whether it's set, if it's set as false explicitly, it's + # false # Corresponds to the JSON property `canReschedule` # @return [Boolean] attr_accessor :can_reschedule @@ -646,9 +615,9 @@ module Google # @return [String] attr_accessor :end_time - # The rollout management policy this maintenance schedule is associated - # with. When doing reschedule update request, the reschedule should be - # against this given policy. + # The rollout management policy this maintenance schedule is associated with. + # When doing reschedule update request, the reschedule should be against this + # given policy. # Corresponds to the JSON property `rolloutManagementPolicy` # @return [String] attr_accessor :rollout_management_policy @@ -677,8 +646,7 @@ module Google include Google::Apis::Core::Hashable # Optional. Exclude instance from maintenance. When true, rollout service will - # not - # attempt maintenance on the instance. Rollout service will include the + # not attempt maintenance on the instance. Rollout service will include the # instance in reported rollout progress as not attempted. # Corresponds to the JSON property `exclude` # @return [Boolean] @@ -695,18 +663,17 @@ module Google end end - # Node information for custom per-node SLO implementations. - # SSA does not support per-node SLO, but producers can populate per-node - # information in SloMetadata for custom precomputations. - # SSA Eligibility Exporter will emit per-node metric based on this information. + # Node information for custom per-node SLO implementations. SSA does not support + # per-node SLO, but producers can populate per-node information in SloMetadata + # for custom precomputations. SSA Eligibility Exporter will emit per-node metric + # based on this information. class GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata include Google::Apis::Core::Hashable - # By default node is eligible if instance is eligible. - # But individual node might be excluded from SLO by adding entry here. - # For semantic see SloMetadata.exclusions. - # If both instance and node level exclusions are present for time period, - # the node level's reason will be reported by Eligibility Exporter. + # By default node is eligible if instance is eligible. But individual node might + # be excluded from SLO by adding entry here. For semantic see SloMetadata. + # exclusions. If both instance and node level exclusions are present for time + # period, the node level's reason will be reported by Eligibility Exporter. # Corresponds to the JSON property `exclusions` # @return [Array] attr_accessor :exclusions @@ -716,8 +683,7 @@ module Google # @return [String] attr_accessor :location - # The id of the node. - # This should be equal to SaasInstanceNode.node_id. + # The id of the node. This should be equal to SaasInstanceNode.node_id. # Corresponds to the JSON property `nodeId` # @return [String] attr_accessor :node_id @@ -738,18 +704,17 @@ module Google class GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource include Google::Apis::Core::Hashable - # Type of the resource. This can be either a GCP resource or a custom one - # (e.g. another cloud provider's VM). For GCP compute resources use singular - # form of the names listed in GCP compute API documentation - # (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with - # 'compute-', for example: 'compute-instance', 'compute-disk', - # 'compute-autoscaler'. + # Type of the resource. This can be either a GCP resource or a custom one (e.g. + # another cloud provider's VM). For GCP compute resources use singular form of + # the names listed in GCP compute API documentation (https://cloud.google.com/ + # compute/docs/reference/rest/v1/), prefixed with 'compute-', for example: ' + # compute-instance', 'compute-disk', 'compute-autoscaler'. # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type - # URL identifying the resource, e.g. - # "https://www.googleapis.com/compute/v1/projects/...)". + # URL identifying the resource, e.g. "https://www.googleapis.com/compute/v1/ + # projects/...)". # Corresponds to the JSON property `resourceUrl` # @return [String] attr_accessor :resource_url @@ -765,9 +730,9 @@ module Google end end - # SloEligibility is a tuple containing eligibility value: true if an instance - # is eligible for SLO calculation or false if it should be excluded from all - # SLO-related calculations along with a user-defined reason. + # SloEligibility is a tuple containing eligibility value: true if an instance is + # eligible for SLO calculation or false if it should be excluded from all SLO- + # related calculations along with a user-defined reason. class GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility include Google::Apis::Core::Hashable @@ -778,8 +743,7 @@ module Google alias_method :eligible?, :eligible # User-defined reason for the current value of instance eligibility. Usually, - # this can be directly mapped to the internal state. An empty reason is - # allowed. + # this can be directly mapped to the internal state. An empty reason is allowed. # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -799,28 +763,27 @@ module Google class GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion include Google::Apis::Core::Hashable - # Exclusion duration. No restrictions on the possible values. - # When an ongoing operation is taking longer than initially expected, - # an existing entry in the exclusion list can be updated by extending the - # duration. This is supported by the subsystem exporting eligibility data - # as long as such extension is committed at least 10 minutes before the - # original exclusion expiration - otherwise it is possible that there will - # be "gaps" in the exclusion application in the exported timeseries. + # Exclusion duration. No restrictions on the possible values. When an ongoing + # operation is taking longer than initially expected, an existing entry in the + # exclusion list can be updated by extending the duration. This is supported by + # the subsystem exporting eligibility data as long as such extension is + # committed at least 10 minutes before the original exclusion expiration - + # otherwise it is possible that there will be "gaps" in the exclusion + # application in the exported timeseries. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration - # Human-readable reason for the exclusion. - # This should be a static string (e.g. "Disruptive update in progress") - # and should not contain dynamically generated data (e.g. instance name). - # Can be left empty. + # Human-readable reason for the exclusion. This should be a static string (e.g. " + # Disruptive update in progress") and should not contain dynamically generated + # data (e.g. instance name). Can be left empty. # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason - # Name of an SLI that this exclusion applies to. Can be left empty, - # signaling that the instance should be excluded from all SLIs defined - # in the service SLO configuration. + # Name of an SLI that this exclusion applies to. Can be left empty, signaling + # that the instance should be excluded from all SLIs defined in the service SLO + # configuration. # Corresponds to the JSON property `sliName` # @return [String] attr_accessor :sli_name @@ -848,40 +811,38 @@ module Google class GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata include Google::Apis::Core::Hashable - # SloEligibility is a tuple containing eligibility value: true if an instance - # is eligible for SLO calculation or false if it should be excluded from all - # SLO-related calculations along with a user-defined reason. + # SloEligibility is a tuple containing eligibility value: true if an instance is + # eligible for SLO calculation or false if it should be excluded from all SLO- + # related calculations along with a user-defined reason. # Corresponds to the JSON property `eligibility` # @return [Google::Apis::ManagedidentitiesV1::GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility] attr_accessor :eligibility - # List of SLO exclusion windows. When multiple entries in the list match - # (matching the exclusion time-window against current time point) - # the exclusion reason used in the first matching entry will be published. - # It is not needed to include expired exclusion in this list, as only the - # currently applicable exclusions are taken into account by the eligibility - # exporting subsystem (the historical state of exclusions will be reflected - # in the historically produced timeseries regardless of the current state). - # This field can be used to mark the instance as temporary ineligible - # for the purpose of SLO calculation. For permanent instance SLO exclusion, - # use of custom instance eligibility is recommended. See 'eligibility' field - # below. + # List of SLO exclusion windows. When multiple entries in the list match ( + # matching the exclusion time-window against current time point) the exclusion + # reason used in the first matching entry will be published. It is not needed to + # include expired exclusion in this list, as only the currently applicable + # exclusions are taken into account by the eligibility exporting subsystem (the + # historical state of exclusions will be reflected in the historically produced + # timeseries regardless of the current state). This field can be used to mark + # the instance as temporary ineligible for the purpose of SLO calculation. For + # permanent instance SLO exclusion, use of custom instance eligibility is + # recommended. See 'eligibility' field below. # Corresponds to the JSON property `exclusions` # @return [Array] attr_accessor :exclusions - # Optional. List of nodes. - # Some producers need to use per-node metadata to calculate SLO. - # This field allows such producers to publish per-node SLO meta data, - # which will be consumed by SSA Eligibility Exporter and published in the + # Optional. List of nodes. Some producers need to use per-node metadata to + # calculate SLO. This field allows such producers to publish per-node SLO meta + # data, which will be consumed by SSA Eligibility Exporter and published in the # form of per node metric to Monarch. # Corresponds to the JSON property `nodes` # @return [Array] attr_accessor :nodes # Name of the SLO tier the Instance belongs to. This name will be expected to - # match the tiers specified in the service SLO configuration. - # Field is mandatory and must not be empty. + # match the tiers specified in the service SLO configuration. Field is mandatory + # and must not be empty. # Corresponds to the JSON property `tier` # @return [String] attr_accessor :tier @@ -899,8 +860,7 @@ module Google end end - # Response message for - # ListDomains + # Response message for ListDomains class ListDomainsResponse include Google::Apis::Core::Hashable @@ -986,14 +946,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 @@ -1009,8 +969,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 @@ -1034,47 +994,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::ManagedidentitiesV1::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 @@ -1102,10 +1060,10 @@ module Google # @return [String] attr_accessor :api_version - # [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`. + # [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 `cancelRequested` # @return [Boolean] attr_accessor :cancel_requested @@ -1153,111 +1111,73 @@ 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 - # 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 @@ -1274,21 +1194,18 @@ module Google end end - # Request message for - # ReconfigureTrust + # Request message for ReconfigureTrust class ReconfigureTrustRequest include Google::Apis::Core::Hashable # Required. The target DNS server IP addresses to resolve the remote domain - # involved - # in the trust. + # involved in the trust. # Corresponds to the JSON property `targetDnsIpAddresses` # @return [Array] attr_accessor :target_dns_ip_addresses # Required. The fully-qualified target domain name which will be in trust with - # current - # domain. + # current domain. # Corresponds to the JSON property `targetDomainName` # @return [String] attr_accessor :target_domain_name @@ -1304,8 +1221,7 @@ module Google end end - # Request message for - # ResetAdminPassword + # Request message for ResetAdminPassword class ResetAdminPasswordRequest include Google::Apis::Core::Hashable @@ -1318,8 +1234,7 @@ module Google end end - # Response message for - # ResetAdminPassword + # Response message for ResetAdminPassword class ResetAdminPasswordResponse include Google::Apis::Core::Hashable @@ -1343,66 +1258,32 @@ 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::ManagedidentitiesV1::Policy] attr_accessor :policy @@ -1417,12 +1298,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 @@ -1431,15 +1312,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 @@ -1460,10 +1341,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 @@ -1482,8 +1362,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 @@ -1498,8 +1377,8 @@ module Google end end - # Represents a relationship between two domains. This allows a controller in - # one domain to authenticate a user in another domain. + # Represents a relationship between two domains. This allows a controller in one + # domain to authenticate a user in another domain. class TrustProp include Google::Apis::Core::Hashable @@ -1514,8 +1393,7 @@ module Google attr_accessor :last_trust_heartbeat_time # Optional. The trust authentication type, which decides whether the trusted - # side has - # forest/domain wide access or selective access to an approved set of + # side has forest/domain wide access or selective access to an approved set of # resources. # Corresponds to the JSON property `selectiveAuthentication` # @return [Boolean] @@ -1534,15 +1412,13 @@ module Google attr_accessor :state_description # Required. The target DNS server IP addresses which can resolve the remote - # domain - # involved in the trust. + # domain involved in the trust. # Corresponds to the JSON property `targetDnsIpAddresses` # @return [Array] attr_accessor :target_dns_ip_addresses # Required. The fully qualified target domain name which will be in trust with - # the - # current domain. + # the current domain. # Corresponds to the JSON property `targetDomainName` # @return [String] attr_accessor :target_domain_name @@ -1554,8 +1430,7 @@ module Google attr_accessor :trust_direction # Required. The trust secret used for the handshake with the target domain. This - # will - # not be stored. + # will not be stored. # Corresponds to the JSON property `trustHandshakeSecret` # @return [String] attr_accessor :trust_handshake_secret @@ -1590,13 +1465,12 @@ module Google end end - # Request message for - # ValidateTrust + # Request message for ValidateTrust class ValidateTrustRequest include Google::Apis::Core::Hashable - # Represents a relationship between two domains. This allows a controller in - # one domain to authenticate a user in another domain. + # Represents a relationship between two domains. This allows a controller in one + # domain to authenticate a user in another domain. # Corresponds to the JSON property `trust` # @return [Google::Apis::ManagedidentitiesV1::TrustProp] attr_accessor :trust_prop diff --git a/generated/google/apis/managedidentities_v1/service.rb b/generated/google/apis/managedidentities_v1/service.rb index 7960aed79..b8bf38da7 100644 --- a/generated/google/apis/managedidentities_v1/service.rb +++ b/generated/google/apis/managedidentities_v1/service.rb @@ -84,8 +84,7 @@ module Google # @param [String] filter # The standard list filter. # @param [Boolean] include_unrevealed_locations - # If true, the returned list will include locations which are not yet - # revealed. + # If true, the returned list will include locations which are not yet revealed. # @param [Fixnum] page_size # The standard list page size. # @param [String] page_token @@ -123,8 +122,8 @@ module Google # Adds an AD trust to a domain. # @param [String] name - # Required. The resource domain name, project name and location using the form: - # `projects/`project_id`/locations/global/domains/`domain_name`` + # Required. The resource domain name, project name and location using the form: ` + # projects/`project_id`/locations/global/domains/`domain_name`` # @param [Google::Apis::ManagedidentitiesV1::AttachTrustRequest] attach_trust_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -157,21 +156,17 @@ module Google # Creates a Microsoft AD domain. # @param [String] parent - # Required. The resource project name and location using the form: - # `projects/`project_id`/locations/global` + # Required. The resource project name and location using the form: `projects/` + # project_id`/locations/global` # @param [Google::Apis::ManagedidentitiesV1::Domain] domain_object # @param [String] domain_name - # Required. The fully qualified domain name. - # e.g. mydomain.myorganization.com, with the following restrictions: - # * Must contain only lowercase letters, numbers, periods and hyphens. - # * Must start with a letter. - # * Must contain between 2-64 characters. - # * Must end with a number or a letter. - # * Must not start with period. - # * First segement length (mydomain form example above) shouldn't exceed - # 15 chars. - # * The last segment cannot be fully numeric. - # * Must be unique within the customer project. + # Required. The fully qualified domain name. e.g. mydomain.myorganization.com, + # with the following restrictions: * Must contain only lowercase letters, + # numbers, periods and hyphens. * Must start with a letter. * Must contain + # between 2-64 characters. * Must end with a number or a letter. * Must not + # start with period. * First segement length (mydomain form example above) + # shouldn't exceed 15 chars. * The last segment cannot be fully numeric. * Must + # be unique within the customer project. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -204,8 +199,8 @@ module Google # Deletes a domain. # @param [String] name - # Required. The domain resource name using the form: - # `projects/`project_id`/locations/global/domains/`domain_name`` + # Required. The domain resource name using the form: `projects/`project_id`/ + # locations/global/domains/`domain_name`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -269,8 +264,8 @@ module Google # Gets information about a domain. # @param [String] name - # Required. The domain resource name using the form: - # `projects/`project_id`/locations/global/domains/`domain_name`` + # Required. The domain resource name using the form: `projects/`project_id`/ + # locations/global/domains/`domain_name`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -298,22 +293,19 @@ 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. + # 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. + # 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). + # 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 @@ -344,27 +336,22 @@ module Google # Lists domains in a project. # @param [String] parent - # Required. The resource name of the domain location using the form: - # `projects/`project_id`/locations/global` + # Required. The resource name of the domain location using the form: `projects/` + # project_id`/locations/global` # @param [String] filter - # Optional. A filter specifying constraints of a list operation. - # For example, `Domain.fqdn="mydomain.myorginization"`. + # Optional. A filter specifying constraints of a list operation. For example, ` + # Domain.fqdn="mydomain.myorginization"`. # @param [String] order_by - # Optional. Specifies the ordering of results. See - # [Sorting - # order](https://cloud.google.com/apis/design/design_patterns#sorting_order) - # for more information. + # Optional. Specifies the ordering of results. See [Sorting order](https://cloud. + # google.com/apis/design/design_patterns#sorting_order) for more information. # @param [Fixnum] page_size - # Optional. The maximum number of items to return. - # If not specified, a default value of 1000 will be used. - # Regardless of the page_size value, the response may include a partial list. - # Callers should rely on a response's - # next_page_token - # to determine if there are additional results to list. + # Optional. The maximum number of items to return. If not specified, a default + # value of 1000 will be used. Regardless of the page_size value, the response + # may include a partial list. Callers should rely on a response's + # next_page_token to determine if there are additional results to list. # @param [String] page_token # Optional. The `next_page_token` value returned from a previous - # ListDomainsRequest - # request, if any. + # ListDomainsRequest request, if any. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -398,16 +385,13 @@ module Google # Updates the metadata and configuration of a domain. # @param [String] name - # Required. The unique name of the domain using the form: - # `projects/`project_id`/locations/global/domains/`domain_name``. + # Required. The unique name of the domain using the form: `projects/`project_id`/ + # locations/global/domains/`domain_name``. # @param [Google::Apis::ManagedidentitiesV1::Domain] domain_object # @param [String] update_mask # Required. Mask of fields to update. At least one path must be supplied in this - # field. The elements of the repeated paths field may only include - # fields from Domain: - # * `labels` - # * `locations` - # * `authorized_networks` + # field. The elements of the repeated paths field may only include fields from + # Domain: * `labels` * `locations` * `authorized_networks` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -440,8 +424,8 @@ module Google # Updates the DNS conditional forwarder. # @param [String] name - # Required. The resource domain name, project name and location using the form: - # `projects/`project_id`/locations/global/domains/`domain_name`` + # Required. The resource domain name, project name and location using the form: ` + # projects/`project_id`/locations/global/domains/`domain_name`` # @param [Google::Apis::ManagedidentitiesV1::ReconfigureTrustRequest] reconfigure_trust_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -474,8 +458,8 @@ module Google # Resets a domain's administrator password. # @param [String] name - # Required. The domain resource name using the form: - # `projects/`project_id`/locations/global/domains/`domain_name`` + # Required. The domain resource name using the form: `projects/`project_id`/ + # locations/global/domains/`domain_name`` # @param [Google::Apis::ManagedidentitiesV1::ResetAdminPasswordRequest] reset_admin_password_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -507,11 +491,11 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. - # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + # 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. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::ManagedidentitiesV1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -542,15 +526,14 @@ module Google 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. + # 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. + # 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::ManagedidentitiesV1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -616,15 +599,13 @@ module Google 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, + # 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. @@ -658,10 +639,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 @@ -691,9 +672,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 @@ -723,15 +703,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 diff --git a/generated/google/apis/managedidentities_v1alpha1.rb b/generated/google/apis/managedidentities_v1alpha1.rb index 76e0e86b3..91be2b31e 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 = '20200622' + REVISION = '20200727' # 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 606253815..5637b694f 100644 --- a/generated/google/apis/managedidentities_v1alpha1/classes.rb +++ b/generated/google/apis/managedidentities_v1alpha1/classes.rb @@ -26,11 +26,10 @@ module Google class AttachTrustRequest include Google::Apis::Core::Hashable - # Represents a relationship between two domains which makes it possible - # for users in one domain to be authenticated by a dc in another domain. - # Refer - # https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows- - # server-2008-R2-and-2008/cc731335(v%3dws.10) + # Represents a relationship between two domains which makes it possible for + # users in one domain to be authenticated by a dc in another domain. Refer https: + # //docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server- + # 2008-R2-and-2008/cc731335(v%3dws.10) # Corresponds to the JSON property `trust` # @return [Google::Apis::ManagedidentitiesV1alpha1::TrustProp] attr_accessor :trust_prop @@ -49,69 +48,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::ManagedidentitiesV1alpha1::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 @@ -145,11 +132,10 @@ module Google class DetachTrustRequest include Google::Apis::Core::Hashable - # Represents a relationship between two domains which makes it possible - # for users in one domain to be authenticated by a dc in another domain. - # Refer - # https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows- - # server-2008-R2-and-2008/cc731335(v%3dws.10) + # Represents a relationship between two domains which makes it possible for + # users in one domain to be authenticated by a dc in another domain. Refer https: + # //docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server- + # 2008-R2-and-2008/cc731335(v%3dws.10) # Corresponds to the JSON property `trust` # @return [Google::Apis::ManagedidentitiesV1alpha1::TrustProp] attr_accessor :trust_prop @@ -168,25 +154,24 @@ module Google class Domain include Google::Apis::Core::Hashable - # 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 part of authorized_networks. - # Caller needs to make sure that CIDR subnets do not overlap between - # networks, else domain creation will fail. + # 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 + # part of authorized_networks. Caller needs to make sure that CIDR subnets do + # not overlap between networks, else domain creation will fail. # Corresponds to the JSON property `authorizedNetworks` # @return [Array] attr_accessor :authorized_networks - # Output only. The time the instance was created. Synthetic field is - # populated automatically by CCFE. go/ccfe-synthetic-field-user-guide + # Output only. The time the instance was created. Synthetic field is populated + # automatically by CCFE. go/ccfe-synthetic-field-user-guide # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time - # Output only. Fully-qualified domain name of the exposed domain used by - # clients to connect to the service. Similar to what would be chosen for an - # Active Directory that is set up on an internal network. + # Output only. Fully-qualified domain name of the exposed domain used by clients + # to connect to the service. Similar to what would be chosen for an Active + # Directory that is set up on an internal network. # Corresponds to the JSON property `fqdn` # @return [String] attr_accessor :fqdn @@ -196,11 +181,9 @@ module Google # @return [Hash] attr_accessor :labels - # Required. Locations where domain needs to be provisioned. - # regions - # e.g. us-west1 or us-east4 - # Service supports up to 4 locations at once. Each location will use a /26 - # block. + # Required. Locations where domain needs to be provisioned. regions e.g. us- + # west1 or us-east4 Service supports up to 4 locations at once. Each location + # will use a /26 block. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations @@ -212,16 +195,15 @@ module Google attr_accessor :managed_identities_admin_name # Output only. Unique name of the domain in this scope including projects and - # location using the form: - # `projects/`project_id`/locations/global/domains/`domain_name``. + # location using the form: `projects/`project_id`/locations/global/domains/` + # domain_name``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Required. The CIDR range of internal addresses that are reserved for this - # domain. Reserved networks must be /24 or larger. Ranges must be - # unique and non-overlapping with existing subnets in - # [Domain].[authorized_networks]. + # domain. Reserved networks must be /24 or larger. Ranges must be unique and non- + # overlapping with existing subnets in [Domain].[authorized_networks]. # Corresponds to the JSON property `reservedIpRange` # @return [String] attr_accessor :reserved_ip_range @@ -231,8 +213,8 @@ module Google # @return [String] attr_accessor :state - # Output only. Additional information about the current status of this - # domain, if available. + # Output only. Additional information about the current status of this domain, + # if available. # Corresponds to the JSON property `statusMessage` # @return [String] attr_accessor :status_message @@ -242,8 +224,8 @@ module Google # @return [Array] attr_accessor :trusts - # Output only. Last update time. Synthetic field is populated automatically - # by CCFE. + # Output only. Last update time. Synthetic field is populated automatically by + # CCFE. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -269,13 +251,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 @@ -288,52 +268,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 @@ -370,10 +341,10 @@ module Google # @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`. + # 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 @@ -423,10 +394,10 @@ module Google # @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`. + # 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 @@ -476,10 +447,10 @@ module Google # @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`. + # 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 @@ -515,10 +486,9 @@ module Google include Google::Apis::Core::Hashable # consumer_defined_name is the name that is set by the consumer. On the other - # hand Name field represents system-assigned id of an instance so consumers - # are not necessarily aware of it. - # consumer_defined_name is used for notification/UI purposes for consumer to - # recognize their instances. + # hand Name field represents system-assigned id of an instance so consumers are + # not necessarily aware of it. consumer_defined_name is used for notification/UI + # purposes for consumer to recognize their instances. # Corresponds to the JSON property `consumerDefinedName` # @return [String] attr_accessor :consumer_defined_name @@ -528,18 +498,17 @@ module Google # @return [String] attr_accessor :create_time - # Optional. Resource labels to represent user provided metadata. Each label - # is a key-value pair, where both the key and the value are arbitrary strings + # Optional. Resource labels to represent user provided metadata. Each label is a + # key-value pair, where both the key and the value are arbitrary strings # provided by the user. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # The MaintenancePolicies that have been attached to the instance. - # The key must be of the type name of the oneof policy name defined in - # MaintenancePolicy, and the referenced policy must define the same policy - # type. For complete details of MaintenancePolicy, please refer to - # go/cloud-saas-mw-ug. + # The MaintenancePolicies that have been attached to the instance. The key must + # be of the type name of the oneof policy name defined in MaintenancePolicy, and + # the referenced policy must define the same policy type. For complete details + # of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. # Corresponds to the JSON property `maintenancePolicyNames` # @return [Hash] attr_accessor :maintenance_policy_names @@ -556,29 +525,28 @@ module Google # @return [Google::Apis::ManagedidentitiesV1alpha1::GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings] attr_accessor :maintenance_settings - # Unique name of the resource. It uses the form: - # `projects/`project_id`/locations/`location_id`/instances/`instance_id`` + # Unique name of the resource. It uses the form: `projects/`project_id`/ + # locations/`location_id`/instances/`instance_id`` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Output only. Custom string attributes used primarily to expose - # producer-specific information in monitoring dashboards. - # See go/get-instance-metadata. + # Output only. Custom string attributes used primarily to expose producer- + # specific information in monitoring dashboards. See go/get-instance-metadata. # Corresponds to the JSON property `producerMetadata` # @return [Hash] attr_accessor :producer_metadata - # Output only. The list of data plane resources provisioned for this - # instance, e.g. compute VMs. See go/get-instance-metadata. + # Output only. The list of data plane resources provisioned for this instance, e. + # g. compute VMs. See go/get-instance-metadata. # Corresponds to the JSON property `provisionedResources` # @return [Array] attr_accessor :provisioned_resources - # Link to the SLM instance template. Only populated when updating SLM - # instances via SSA's Actuation service adaptor. - # Service producers with custom control plane (e.g. Cloud SQL) doesn't - # need to populate this field. Instead they should use software_versions. + # Link to the SLM instance template. Only populated when updating SLM instances + # via SSA's Actuation service adaptor. Service producers with custom control + # plane (e.g. Cloud SQL) doesn't need to populate this field. Instead they + # should use software_versions. # Corresponds to the JSON property `slmInstanceTemplate` # @return [String] attr_accessor :slm_instance_template @@ -589,8 +557,8 @@ module Google # @return [Google::Apis::ManagedidentitiesV1alpha1::GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata] attr_accessor :slo_metadata - # Software versions that are used to deploy this instance. This can be - # mutated by rollout services. + # Software versions that are used to deploy this instance. This can be mutated + # by rollout services. # Corresponds to the JSON property `softwareVersions` # @return [Hash] attr_accessor :software_versions @@ -601,8 +569,8 @@ module Google # @return [String] attr_accessor :state - # Output only. ID of the associated GCP tenant project. - # See go/get-instance-metadata. + # Output only. ID of the associated GCP tenant project. See go/get-instance- + # metadata. # Corresponds to the JSON property `tenantProjectId` # @return [String] attr_accessor :tenant_project_id @@ -641,9 +609,9 @@ module Google class GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule include Google::Apis::Core::Hashable - # Can this scheduled update be rescheduled? - # By default, it's true and API needs to do explicitly check whether it's - # set, if it's set as false explicitly, it's false + # Can this scheduled update be rescheduled? By default, it's true and API needs + # to do explicitly check whether it's set, if it's set as false explicitly, it's + # false # Corresponds to the JSON property `canReschedule` # @return [Boolean] attr_accessor :can_reschedule @@ -654,9 +622,9 @@ module Google # @return [String] attr_accessor :end_time - # The rollout management policy this maintenance schedule is associated - # with. When doing reschedule update request, the reschedule should be - # against this given policy. + # The rollout management policy this maintenance schedule is associated with. + # When doing reschedule update request, the reschedule should be against this + # given policy. # Corresponds to the JSON property `rolloutManagementPolicy` # @return [String] attr_accessor :rollout_management_policy @@ -685,8 +653,7 @@ module Google include Google::Apis::Core::Hashable # Optional. Exclude instance from maintenance. When true, rollout service will - # not - # attempt maintenance on the instance. Rollout service will include the + # not attempt maintenance on the instance. Rollout service will include the # instance in reported rollout progress as not attempted. # Corresponds to the JSON property `exclude` # @return [Boolean] @@ -703,18 +670,17 @@ module Google end end - # Node information for custom per-node SLO implementations. - # SSA does not support per-node SLO, but producers can populate per-node - # information in SloMetadata for custom precomputations. - # SSA Eligibility Exporter will emit per-node metric based on this information. + # Node information for custom per-node SLO implementations. SSA does not support + # per-node SLO, but producers can populate per-node information in SloMetadata + # for custom precomputations. SSA Eligibility Exporter will emit per-node metric + # based on this information. class GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata include Google::Apis::Core::Hashable - # By default node is eligible if instance is eligible. - # But individual node might be excluded from SLO by adding entry here. - # For semantic see SloMetadata.exclusions. - # If both instance and node level exclusions are present for time period, - # the node level's reason will be reported by Eligibility Exporter. + # By default node is eligible if instance is eligible. But individual node might + # be excluded from SLO by adding entry here. For semantic see SloMetadata. + # exclusions. If both instance and node level exclusions are present for time + # period, the node level's reason will be reported by Eligibility Exporter. # Corresponds to the JSON property `exclusions` # @return [Array] attr_accessor :exclusions @@ -724,8 +690,7 @@ module Google # @return [String] attr_accessor :location - # The id of the node. - # This should be equal to SaasInstanceNode.node_id. + # The id of the node. This should be equal to SaasInstanceNode.node_id. # Corresponds to the JSON property `nodeId` # @return [String] attr_accessor :node_id @@ -746,18 +711,17 @@ module Google class GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource include Google::Apis::Core::Hashable - # Type of the resource. This can be either a GCP resource or a custom one - # (e.g. another cloud provider's VM). For GCP compute resources use singular - # form of the names listed in GCP compute API documentation - # (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with - # 'compute-', for example: 'compute-instance', 'compute-disk', - # 'compute-autoscaler'. + # Type of the resource. This can be either a GCP resource or a custom one (e.g. + # another cloud provider's VM). For GCP compute resources use singular form of + # the names listed in GCP compute API documentation (https://cloud.google.com/ + # compute/docs/reference/rest/v1/), prefixed with 'compute-', for example: ' + # compute-instance', 'compute-disk', 'compute-autoscaler'. # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type - # URL identifying the resource, e.g. - # "https://www.googleapis.com/compute/v1/projects/...)". + # URL identifying the resource, e.g. "https://www.googleapis.com/compute/v1/ + # projects/...)". # Corresponds to the JSON property `resourceUrl` # @return [String] attr_accessor :resource_url @@ -773,9 +737,9 @@ module Google end end - # SloEligibility is a tuple containing eligibility value: true if an instance - # is eligible for SLO calculation or false if it should be excluded from all - # SLO-related calculations along with a user-defined reason. + # SloEligibility is a tuple containing eligibility value: true if an instance is + # eligible for SLO calculation or false if it should be excluded from all SLO- + # related calculations along with a user-defined reason. class GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility include Google::Apis::Core::Hashable @@ -786,8 +750,7 @@ module Google alias_method :eligible?, :eligible # User-defined reason for the current value of instance eligibility. Usually, - # this can be directly mapped to the internal state. An empty reason is - # allowed. + # this can be directly mapped to the internal state. An empty reason is allowed. # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -807,28 +770,27 @@ module Google class GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion include Google::Apis::Core::Hashable - # Exclusion duration. No restrictions on the possible values. - # When an ongoing operation is taking longer than initially expected, - # an existing entry in the exclusion list can be updated by extending the - # duration. This is supported by the subsystem exporting eligibility data - # as long as such extension is committed at least 10 minutes before the - # original exclusion expiration - otherwise it is possible that there will - # be "gaps" in the exclusion application in the exported timeseries. + # Exclusion duration. No restrictions on the possible values. When an ongoing + # operation is taking longer than initially expected, an existing entry in the + # exclusion list can be updated by extending the duration. This is supported by + # the subsystem exporting eligibility data as long as such extension is + # committed at least 10 minutes before the original exclusion expiration - + # otherwise it is possible that there will be "gaps" in the exclusion + # application in the exported timeseries. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration - # Human-readable reason for the exclusion. - # This should be a static string (e.g. "Disruptive update in progress") - # and should not contain dynamically generated data (e.g. instance name). - # Can be left empty. + # Human-readable reason for the exclusion. This should be a static string (e.g. " + # Disruptive update in progress") and should not contain dynamically generated + # data (e.g. instance name). Can be left empty. # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason - # Name of an SLI that this exclusion applies to. Can be left empty, - # signaling that the instance should be excluded from all SLIs defined - # in the service SLO configuration. + # Name of an SLI that this exclusion applies to. Can be left empty, signaling + # that the instance should be excluded from all SLIs defined in the service SLO + # configuration. # Corresponds to the JSON property `sliName` # @return [String] attr_accessor :sli_name @@ -856,40 +818,38 @@ module Google class GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata include Google::Apis::Core::Hashable - # SloEligibility is a tuple containing eligibility value: true if an instance - # is eligible for SLO calculation or false if it should be excluded from all - # SLO-related calculations along with a user-defined reason. + # SloEligibility is a tuple containing eligibility value: true if an instance is + # eligible for SLO calculation or false if it should be excluded from all SLO- + # related calculations along with a user-defined reason. # Corresponds to the JSON property `eligibility` # @return [Google::Apis::ManagedidentitiesV1alpha1::GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility] attr_accessor :eligibility - # List of SLO exclusion windows. When multiple entries in the list match - # (matching the exclusion time-window against current time point) - # the exclusion reason used in the first matching entry will be published. - # It is not needed to include expired exclusion in this list, as only the - # currently applicable exclusions are taken into account by the eligibility - # exporting subsystem (the historical state of exclusions will be reflected - # in the historically produced timeseries regardless of the current state). - # This field can be used to mark the instance as temporary ineligible - # for the purpose of SLO calculation. For permanent instance SLO exclusion, - # use of custom instance eligibility is recommended. See 'eligibility' field - # below. + # List of SLO exclusion windows. When multiple entries in the list match ( + # matching the exclusion time-window against current time point) the exclusion + # reason used in the first matching entry will be published. It is not needed to + # include expired exclusion in this list, as only the currently applicable + # exclusions are taken into account by the eligibility exporting subsystem (the + # historical state of exclusions will be reflected in the historically produced + # timeseries regardless of the current state). This field can be used to mark + # the instance as temporary ineligible for the purpose of SLO calculation. For + # permanent instance SLO exclusion, use of custom instance eligibility is + # recommended. See 'eligibility' field below. # Corresponds to the JSON property `exclusions` # @return [Array] attr_accessor :exclusions - # Optional. List of nodes. - # Some producers need to use per-node metadata to calculate SLO. - # This field allows such producers to publish per-node SLO meta data, - # which will be consumed by SSA Eligibility Exporter and published in the + # Optional. List of nodes. Some producers need to use per-node metadata to + # calculate SLO. This field allows such producers to publish per-node SLO meta + # data, which will be consumed by SSA Eligibility Exporter and published in the # form of per node metric to Monarch. # Corresponds to the JSON property `nodes` # @return [Array] attr_accessor :nodes # Name of the SLO tier the Instance belongs to. This name will be expected to - # match the tiers specified in the service SLO configuration. - # Field is mandatory and must not be empty. + # match the tiers specified in the service SLO configuration. Field is mandatory + # and must not be empty. # Corresponds to the JSON property `tier` # @return [String] attr_accessor :tier @@ -993,14 +953,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 @@ -1016,8 +976,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 @@ -1041,47 +1001,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::ManagedidentitiesV1alpha1::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 @@ -1109,10 +1067,10 @@ module Google # @return [String] attr_accessor :api_version - # [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`. + # [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 `cancelRequested` # @return [Boolean] attr_accessor :cancel_requested @@ -1160,111 +1118,73 @@ 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 - # 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 @@ -1285,11 +1205,10 @@ module Google class ReconfigureTrustRequest include Google::Apis::Core::Hashable - # Represents a relationship between two domains which makes it possible - # for users in one domain to be authenticated by a dc in another domain. - # Refer - # https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows- - # server-2008-R2-and-2008/cc731335(v%3dws.10) + # Represents a relationship between two domains which makes it possible for + # users in one domain to be authenticated by a dc in another domain. Refer https: + # //docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server- + # 2008-R2-and-2008/cc731335(v%3dws.10) # Corresponds to the JSON property `trust` # @return [Google::Apis::ManagedidentitiesV1alpha1::TrustProp] attr_accessor :trust_prop @@ -1341,66 +1260,32 @@ 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::ManagedidentitiesV1alpha1::Policy] attr_accessor :policy @@ -1415,12 +1300,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 @@ -1429,15 +1314,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 @@ -1458,10 +1343,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 @@ -1480,8 +1364,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 @@ -1496,11 +1379,10 @@ module Google end end - # Represents a relationship between two domains which makes it possible - # for users in one domain to be authenticated by a dc in another domain. - # Refer - # https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows- - # server-2008-R2-and-2008/cc731335(v%3dws.10) + # Represents a relationship between two domains which makes it possible for + # users in one domain to be authenticated by a dc in another domain. Refer https: + # //docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server- + # 2008-R2-and-2008/cc731335(v%3dws.10) class TrustProp include Google::Apis::Core::Hashable @@ -1509,8 +1391,7 @@ module Google # @return [String] attr_accessor :create_time - # Output only. The last heartbeat time when the trust was known to be - # connected. + # Output only. The last heartbeat time when the trust was known to be connected. # Corresponds to the JSON property `lastKnownTrustConnectedHeartbeatTime` # @return [String] attr_accessor :last_known_trust_connected_heartbeat_time @@ -1527,8 +1408,8 @@ module Google # @return [String] attr_accessor :state - # Output only. Additional information about the current state of this - # trust, if available. + # Output only. Additional information about the current state of this trust, if + # available. # Corresponds to the JSON property `stateDescription` # @return [String] attr_accessor :state_description @@ -1545,14 +1426,13 @@ module Google # @return [String] attr_accessor :target_domain_name - # The trust direction decides the current domain is trusted, trusting or - # both. + # The trust direction decides the current domain is trusted, trusting or both. # Corresponds to the JSON property `trustDirection` # @return [String] attr_accessor :trust_direction - # Input only, and will not be stored. The trust secret used for handshake - # with target domain. + # Input only, and will not be stored. The trust secret used for handshake with + # target domain. # Corresponds to the JSON property `trustHandshakeSecret` # @return [String] attr_accessor :trust_handshake_secret @@ -1591,11 +1471,10 @@ module Google class ValidateTrustRequest include Google::Apis::Core::Hashable - # Represents a relationship between two domains which makes it possible - # for users in one domain to be authenticated by a dc in another domain. - # Refer - # https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows- - # server-2008-R2-and-2008/cc731335(v%3dws.10) + # Represents a relationship between two domains which makes it possible for + # users in one domain to be authenticated by a dc in another domain. Refer https: + # //docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server- + # 2008-R2-and-2008/cc731335(v%3dws.10) # Corresponds to the JSON property `trust` # @return [Google::Apis::ManagedidentitiesV1alpha1::TrustProp] attr_accessor :trust_prop diff --git a/generated/google/apis/managedidentities_v1alpha1/service.rb b/generated/google/apis/managedidentities_v1alpha1/service.rb index c42584910..b9cf2cbd7 100644 --- a/generated/google/apis/managedidentities_v1alpha1/service.rb +++ b/generated/google/apis/managedidentities_v1alpha1/service.rb @@ -84,8 +84,7 @@ module Google # @param [String] filter # The standard list filter. # @param [Boolean] include_unrevealed_locations - # If true, the returned list will include locations which are not yet - # revealed. + # If true, the returned list will include locations which are not yet revealed. # @param [Fixnum] page_size # The standard list page size. # @param [String] page_token @@ -121,11 +120,10 @@ module Google execute_or_queue_command(command, &block) end - # Adds AD trust in a given domain. - # Operation + # Adds AD trust in a given domain. Operation # @param [String] name - # The resource domain name, project name and location using the form: - # `projects/`project_id`/locations/global/domains/`domain_name`` + # The resource domain name, project name and location using the form: `projects/` + # project_id`/locations/global/domains/`domain_name`` # @param [Google::Apis::ManagedidentitiesV1alpha1::AttachTrustRequest] attach_trust_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -156,24 +154,19 @@ module Google execute_or_queue_command(command, &block) end - # Creates a Microsoft AD Domain in a given project. - # Operation + # Creates a Microsoft AD Domain in a given project. Operation # @param [String] parent - # Resource project name and location using the form: - # `projects/`project_id`/locations/global` + # Resource project name and location using the form: `projects/`project_id`/ + # locations/global` # @param [Google::Apis::ManagedidentitiesV1alpha1::Domain] domain_object # @param [String] domain_name - # The fully qualified domain name. - # e.g. mydomain.myorganization.com, with the following restrictions: - # * Must contain only lowercase letters, numbers, periods and hyphens. - # * Must start with a letter. - # * Must contain between 2-64 characters. - # * Must end with a number or a letter. - # * Must not start with period. - # * Must be unique within the project. - # * First segement length (mydomain form example above) shouldn't exceed - # 15 chars. - # * The last segment cannot be fully numeric. + # The fully qualified domain name. e.g. mydomain.myorganization.com, with the + # following restrictions: * Must contain only lowercase letters, numbers, + # periods and hyphens. * Must start with a letter. * Must contain between 2-64 + # characters. * Must end with a number or a letter. * Must not start with period. + # * Must be unique within the project. * First segement length (mydomain form + # example above) shouldn't exceed 15 chars. * The last segment cannot be fully + # numeric. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -204,11 +197,10 @@ module Google execute_or_queue_command(command, &block) end - # Deletes identified domain. - # Operation + # Deletes identified domain. Operation # @param [String] name - # Domain resource name using the form: - # `projects/`project_id`/locations/global/domains/`domain_name`` + # Domain resource name using the form: `projects/`project_id`/locations/global/ + # domains/`domain_name`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -236,11 +228,10 @@ module Google execute_or_queue_command(command, &block) end - # Removes identified trust. - # Operation + # Removes identified trust. Operation # @param [String] name - # The resource domain name, project name, and location using the form: - # `projects/`project_id`/locations/global/domains/`domain_name`` + # The resource domain name, project name, and location using the form: `projects/ + # `project_id`/locations/global/domains/`domain_name`` # @param [Google::Apis::ManagedidentitiesV1alpha1::DetachTrustRequest] detach_trust_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -273,8 +264,8 @@ module Google # Gets details of a single Domain. # @param [String] name - # Domain resource name using the form: - # `projects/`project_id`/locations/global/domains/`domain_name`` + # Domain resource name using the form: `projects/`project_id`/locations/global/ + # domains/`domain_name`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -302,22 +293,19 @@ 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. + # 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. + # 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). + # 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 @@ -348,20 +336,19 @@ module Google # Lists Domains in a given project. # @param [String] parent - # Required. The resource name of the domain location using the form: - # `projects/`project_id`/locations/global` + # Required. The resource name of the domain location using the form: `projects/` + # project_id`/locations/global` # @param [String] filter - # Optional. Filter specifying constraints of a list operation. - # For example, `Domain.fqdn="mydomain.myorginization"`. + # Optional. Filter specifying constraints of a list operation. For example, ` + # Domain.fqdn="mydomain.myorginization"`. # @param [String] order_by - # Optional. Specifies the ordering of results following syntax at - # https://cloud.google.com/apis/design/design_patterns#sorting_order. + # Optional. Specifies the ordering of results following syntax at https://cloud. + # google.com/apis/design/design_patterns#sorting_order. # @param [Fixnum] page_size # If not specified, a default value of 1000 will be used by the service. - # Regardless of the page_size value, the response may include a partial list - # and a caller should only rely on response's - # next_page_token - # to determine if there are more instances left to be queried. + # Regardless of the page_size value, the response may include a partial list and + # a caller should only rely on response's next_page_token to determine if there + # are more instances left to be queried. # @param [String] page_token # The next_page_token value returned from a previous List request, if any. # @param [String] fields @@ -395,20 +382,16 @@ module Google execute_or_queue_command(command, &block) end - # Updates the metadata and configuration of a specified domain. - # Operation + # Updates the metadata and configuration of a specified domain. Operation # @param [String] name # Output only. Unique name of the domain in this scope including projects and - # location using the form: - # `projects/`project_id`/locations/global/domains/`domain_name``. + # location using the form: `projects/`project_id`/locations/global/domains/` + # domain_name``. # @param [Google::Apis::ManagedidentitiesV1alpha1::Domain] domain_object # @param [String] update_mask - # Mask of fields to update. At least one path must be supplied in this - # field. The elements of the repeated paths field may only include these - # fields from Domain: - # * `labels` - # * `locations` - # * `authorized_networks` + # Mask of fields to update. At least one path must be supplied in this field. + # The elements of the repeated paths field may only include these fields from + # Domain: * `labels` * `locations` * `authorized_networks` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -439,11 +422,10 @@ module Google execute_or_queue_command(command, &block) end - # Updates the dns conditional forwarder. - # Operation + # Updates the dns conditional forwarder. Operation # @param [String] name - # The resource domain name, project name and location using the form: - # `projects/`project_id`/locations/global/domains/`domain_name`` + # The resource domain name, project name and location using the form: `projects/` + # project_id`/locations/global/domains/`domain_name`` # @param [Google::Apis::ManagedidentitiesV1alpha1::ReconfigureTrustRequest] reconfigure_trust_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -477,8 +459,8 @@ module Google # Resets managed identities admin password identified by # managed_identities_admin_name # @param [String] name - # The domain resource name using the form: - # `projects/`project_id`/locations/global/domains/`domain_name`` + # The domain resource name using the form: `projects/`project_id`/locations/ + # global/domains/`domain_name`` # @param [Google::Apis::ManagedidentitiesV1alpha1::ResetAdminPasswordRequest] reset_admin_password_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -510,11 +492,11 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. - # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + # 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. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::ManagedidentitiesV1alpha1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -545,15 +527,14 @@ module Google 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. + # 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. + # 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::ManagedidentitiesV1alpha1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -584,11 +565,10 @@ module Google execute_or_queue_command(command, &block) end - # Validate the trust state - # Operation + # Validate the trust state Operation # @param [String] name - # The resource domain name, project name, and location using the form: - # `projects/`project_id`/locations/global/domains/`domain_name`` + # The resource domain name, project name, and location using the form: `projects/ + # `project_id`/locations/global/domains/`domain_name`` # @param [Google::Apis::ManagedidentitiesV1alpha1::ValidateTrustRequest] validate_trust_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -619,15 +599,13 @@ module Google 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, + # 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. @@ -661,10 +639,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 @@ -694,9 +672,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 @@ -726,15 +703,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 diff --git a/generated/google/apis/managedidentities_v1beta1.rb b/generated/google/apis/managedidentities_v1beta1.rb index 5c8275060..235e88e2d 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 = '20200622' + REVISION = '20200727' # 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 b48f57ca4..cf672f01c 100644 --- a/generated/google/apis/managedidentities_v1beta1/classes.rb +++ b/generated/google/apis/managedidentities_v1beta1/classes.rb @@ -22,13 +22,12 @@ module Google module Apis module ManagedidentitiesV1beta1 - # Request message for - # AttachTrust + # Request message for AttachTrust class AttachTrustRequest include Google::Apis::Core::Hashable - # Represents a relationship between two domains. This allows a controller in - # one domain to authenticate a user in another domain. + # Represents a relationship between two domains. This allows a controller in one + # domain to authenticate a user in another domain. # Corresponds to the JSON property `trust` # @return [Google::Apis::ManagedidentitiesV1beta1::TrustProp] attr_accessor :trust_prop @@ -47,69 +46,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::ManagedidentitiesV1beta1::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 @@ -139,13 +126,12 @@ module Google end end - # Request message for - # DetachTrust + # Request message for DetachTrust class DetachTrustRequest include Google::Apis::Core::Hashable - # Represents a relationship between two domains. This allows a controller in - # one domain to authenticate a user in another domain. + # Represents a relationship between two domains. This allows a controller in one + # domain to authenticate a user in another domain. # Corresponds to the JSON property `trust` # @return [Google::Apis::ManagedidentitiesV1beta1::TrustProp] attr_accessor :trust_prop @@ -164,17 +150,17 @@ module Google class Domain include Google::Apis::Core::Hashable - # Optional. The name of delegated administrator account used to perform - # Active Directory operations. If not specified, `setupadmin` will be used. + # Optional. The name of delegated administrator account used to perform Active + # Directory operations. If not specified, `setupadmin` will be used. # Corresponds to the JSON property `admin` # @return [String] attr_accessor :admin - # 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 listed in `authorized_networks`. - # If CIDR subnets overlap between networks, domain creation will fail. + # 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 + # listed in `authorized_networks`. If CIDR subnets overlap between networks, + # domain creation will fail. # Corresponds to the JSON property `authorizedNetworks` # @return [Array] attr_accessor :authorized_networks @@ -196,25 +182,22 @@ module Google # @return [Hash] attr_accessor :labels - # Required. Locations where domain needs to be provisioned. - # regions - # e.g. us-west1 or us-east4 - # Service supports up to 4 locations at once. Each location will use a /26 - # block. + # Required. Locations where domain needs to be provisioned. regions e.g. us- + # west1 or us-east4 Service supports up to 4 locations at once. Each location + # will use a /26 block. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations - # Output only. The unique name of the domain using the form: - # `projects/`project_id`/locations/global/domains/`domain_name``. + # Output only. The unique name of the domain using the form: `projects/` + # project_id`/locations/global/domains/`domain_name``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Required. The CIDR range of internal addresses that are reserved for this - # domain. Reserved networks must be /24 or larger. Ranges must be - # unique and non-overlapping with existing subnets in - # [Domain].[authorized_networks]. + # domain. Reserved networks must be /24 or larger. Ranges must be unique and non- + # overlapping with existing subnets in [Domain].[authorized_networks]. # Corresponds to the JSON property `reservedIpRange` # @return [String] attr_accessor :reserved_ip_range @@ -224,8 +207,8 @@ module Google # @return [String] attr_accessor :state - # Output only. Additional information about the current status of this - # domain, if available. + # Output only. Additional information about the current status of this domain, + # if available. # Corresponds to the JSON property `statusMessage` # @return [String] attr_accessor :status_message @@ -261,13 +244,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 @@ -280,52 +261,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 @@ -362,10 +334,10 @@ module Google # @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`. + # 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 @@ -415,10 +387,10 @@ module Google # @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`. + # 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 @@ -468,10 +440,10 @@ module Google # @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`. + # 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 @@ -507,10 +479,9 @@ module Google include Google::Apis::Core::Hashable # consumer_defined_name is the name that is set by the consumer. On the other - # hand Name field represents system-assigned id of an instance so consumers - # are not necessarily aware of it. - # consumer_defined_name is used for notification/UI purposes for consumer to - # recognize their instances. + # hand Name field represents system-assigned id of an instance so consumers are + # not necessarily aware of it. consumer_defined_name is used for notification/UI + # purposes for consumer to recognize their instances. # Corresponds to the JSON property `consumerDefinedName` # @return [String] attr_accessor :consumer_defined_name @@ -520,18 +491,17 @@ module Google # @return [String] attr_accessor :create_time - # Optional. Resource labels to represent user provided metadata. Each label - # is a key-value pair, where both the key and the value are arbitrary strings + # Optional. Resource labels to represent user provided metadata. Each label is a + # key-value pair, where both the key and the value are arbitrary strings # provided by the user. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # The MaintenancePolicies that have been attached to the instance. - # The key must be of the type name of the oneof policy name defined in - # MaintenancePolicy, and the referenced policy must define the same policy - # type. For complete details of MaintenancePolicy, please refer to - # go/cloud-saas-mw-ug. + # The MaintenancePolicies that have been attached to the instance. The key must + # be of the type name of the oneof policy name defined in MaintenancePolicy, and + # the referenced policy must define the same policy type. For complete details + # of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. # Corresponds to the JSON property `maintenancePolicyNames` # @return [Hash] attr_accessor :maintenance_policy_names @@ -548,29 +518,28 @@ module Google # @return [Google::Apis::ManagedidentitiesV1beta1::GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings] attr_accessor :maintenance_settings - # Unique name of the resource. It uses the form: - # `projects/`project_id`/locations/`location_id`/instances/`instance_id`` + # Unique name of the resource. It uses the form: `projects/`project_id`/ + # locations/`location_id`/instances/`instance_id`` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Output only. Custom string attributes used primarily to expose - # producer-specific information in monitoring dashboards. - # See go/get-instance-metadata. + # Output only. Custom string attributes used primarily to expose producer- + # specific information in monitoring dashboards. See go/get-instance-metadata. # Corresponds to the JSON property `producerMetadata` # @return [Hash] attr_accessor :producer_metadata - # Output only. The list of data plane resources provisioned for this - # instance, e.g. compute VMs. See go/get-instance-metadata. + # Output only. The list of data plane resources provisioned for this instance, e. + # g. compute VMs. See go/get-instance-metadata. # Corresponds to the JSON property `provisionedResources` # @return [Array] attr_accessor :provisioned_resources - # Link to the SLM instance template. Only populated when updating SLM - # instances via SSA's Actuation service adaptor. - # Service producers with custom control plane (e.g. Cloud SQL) doesn't - # need to populate this field. Instead they should use software_versions. + # Link to the SLM instance template. Only populated when updating SLM instances + # via SSA's Actuation service adaptor. Service producers with custom control + # plane (e.g. Cloud SQL) doesn't need to populate this field. Instead they + # should use software_versions. # Corresponds to the JSON property `slmInstanceTemplate` # @return [String] attr_accessor :slm_instance_template @@ -581,8 +550,8 @@ module Google # @return [Google::Apis::ManagedidentitiesV1beta1::GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata] attr_accessor :slo_metadata - # Software versions that are used to deploy this instance. This can be - # mutated by rollout services. + # Software versions that are used to deploy this instance. This can be mutated + # by rollout services. # Corresponds to the JSON property `softwareVersions` # @return [Hash] attr_accessor :software_versions @@ -593,8 +562,8 @@ module Google # @return [String] attr_accessor :state - # Output only. ID of the associated GCP tenant project. - # See go/get-instance-metadata. + # Output only. ID of the associated GCP tenant project. See go/get-instance- + # metadata. # Corresponds to the JSON property `tenantProjectId` # @return [String] attr_accessor :tenant_project_id @@ -633,9 +602,9 @@ module Google class GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule include Google::Apis::Core::Hashable - # Can this scheduled update be rescheduled? - # By default, it's true and API needs to do explicitly check whether it's - # set, if it's set as false explicitly, it's false + # Can this scheduled update be rescheduled? By default, it's true and API needs + # to do explicitly check whether it's set, if it's set as false explicitly, it's + # false # Corresponds to the JSON property `canReschedule` # @return [Boolean] attr_accessor :can_reschedule @@ -646,9 +615,9 @@ module Google # @return [String] attr_accessor :end_time - # The rollout management policy this maintenance schedule is associated - # with. When doing reschedule update request, the reschedule should be - # against this given policy. + # The rollout management policy this maintenance schedule is associated with. + # When doing reschedule update request, the reschedule should be against this + # given policy. # Corresponds to the JSON property `rolloutManagementPolicy` # @return [String] attr_accessor :rollout_management_policy @@ -677,8 +646,7 @@ module Google include Google::Apis::Core::Hashable # Optional. Exclude instance from maintenance. When true, rollout service will - # not - # attempt maintenance on the instance. Rollout service will include the + # not attempt maintenance on the instance. Rollout service will include the # instance in reported rollout progress as not attempted. # Corresponds to the JSON property `exclude` # @return [Boolean] @@ -695,18 +663,17 @@ module Google end end - # Node information for custom per-node SLO implementations. - # SSA does not support per-node SLO, but producers can populate per-node - # information in SloMetadata for custom precomputations. - # SSA Eligibility Exporter will emit per-node metric based on this information. + # Node information for custom per-node SLO implementations. SSA does not support + # per-node SLO, but producers can populate per-node information in SloMetadata + # for custom precomputations. SSA Eligibility Exporter will emit per-node metric + # based on this information. class GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata include Google::Apis::Core::Hashable - # By default node is eligible if instance is eligible. - # But individual node might be excluded from SLO by adding entry here. - # For semantic see SloMetadata.exclusions. - # If both instance and node level exclusions are present for time period, - # the node level's reason will be reported by Eligibility Exporter. + # By default node is eligible if instance is eligible. But individual node might + # be excluded from SLO by adding entry here. For semantic see SloMetadata. + # exclusions. If both instance and node level exclusions are present for time + # period, the node level's reason will be reported by Eligibility Exporter. # Corresponds to the JSON property `exclusions` # @return [Array] attr_accessor :exclusions @@ -716,8 +683,7 @@ module Google # @return [String] attr_accessor :location - # The id of the node. - # This should be equal to SaasInstanceNode.node_id. + # The id of the node. This should be equal to SaasInstanceNode.node_id. # Corresponds to the JSON property `nodeId` # @return [String] attr_accessor :node_id @@ -738,18 +704,17 @@ module Google class GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource include Google::Apis::Core::Hashable - # Type of the resource. This can be either a GCP resource or a custom one - # (e.g. another cloud provider's VM). For GCP compute resources use singular - # form of the names listed in GCP compute API documentation - # (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with - # 'compute-', for example: 'compute-instance', 'compute-disk', - # 'compute-autoscaler'. + # Type of the resource. This can be either a GCP resource or a custom one (e.g. + # another cloud provider's VM). For GCP compute resources use singular form of + # the names listed in GCP compute API documentation (https://cloud.google.com/ + # compute/docs/reference/rest/v1/), prefixed with 'compute-', for example: ' + # compute-instance', 'compute-disk', 'compute-autoscaler'. # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type - # URL identifying the resource, e.g. - # "https://www.googleapis.com/compute/v1/projects/...)". + # URL identifying the resource, e.g. "https://www.googleapis.com/compute/v1/ + # projects/...)". # Corresponds to the JSON property `resourceUrl` # @return [String] attr_accessor :resource_url @@ -765,9 +730,9 @@ module Google end end - # SloEligibility is a tuple containing eligibility value: true if an instance - # is eligible for SLO calculation or false if it should be excluded from all - # SLO-related calculations along with a user-defined reason. + # SloEligibility is a tuple containing eligibility value: true if an instance is + # eligible for SLO calculation or false if it should be excluded from all SLO- + # related calculations along with a user-defined reason. class GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility include Google::Apis::Core::Hashable @@ -778,8 +743,7 @@ module Google alias_method :eligible?, :eligible # User-defined reason for the current value of instance eligibility. Usually, - # this can be directly mapped to the internal state. An empty reason is - # allowed. + # this can be directly mapped to the internal state. An empty reason is allowed. # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -799,28 +763,27 @@ module Google class GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion include Google::Apis::Core::Hashable - # Exclusion duration. No restrictions on the possible values. - # When an ongoing operation is taking longer than initially expected, - # an existing entry in the exclusion list can be updated by extending the - # duration. This is supported by the subsystem exporting eligibility data - # as long as such extension is committed at least 10 minutes before the - # original exclusion expiration - otherwise it is possible that there will - # be "gaps" in the exclusion application in the exported timeseries. + # Exclusion duration. No restrictions on the possible values. When an ongoing + # operation is taking longer than initially expected, an existing entry in the + # exclusion list can be updated by extending the duration. This is supported by + # the subsystem exporting eligibility data as long as such extension is + # committed at least 10 minutes before the original exclusion expiration - + # otherwise it is possible that there will be "gaps" in the exclusion + # application in the exported timeseries. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration - # Human-readable reason for the exclusion. - # This should be a static string (e.g. "Disruptive update in progress") - # and should not contain dynamically generated data (e.g. instance name). - # Can be left empty. + # Human-readable reason for the exclusion. This should be a static string (e.g. " + # Disruptive update in progress") and should not contain dynamically generated + # data (e.g. instance name). Can be left empty. # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason - # Name of an SLI that this exclusion applies to. Can be left empty, - # signaling that the instance should be excluded from all SLIs defined - # in the service SLO configuration. + # Name of an SLI that this exclusion applies to. Can be left empty, signaling + # that the instance should be excluded from all SLIs defined in the service SLO + # configuration. # Corresponds to the JSON property `sliName` # @return [String] attr_accessor :sli_name @@ -848,40 +811,38 @@ module Google class GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata include Google::Apis::Core::Hashable - # SloEligibility is a tuple containing eligibility value: true if an instance - # is eligible for SLO calculation or false if it should be excluded from all - # SLO-related calculations along with a user-defined reason. + # SloEligibility is a tuple containing eligibility value: true if an instance is + # eligible for SLO calculation or false if it should be excluded from all SLO- + # related calculations along with a user-defined reason. # Corresponds to the JSON property `eligibility` # @return [Google::Apis::ManagedidentitiesV1beta1::GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility] attr_accessor :eligibility - # List of SLO exclusion windows. When multiple entries in the list match - # (matching the exclusion time-window against current time point) - # the exclusion reason used in the first matching entry will be published. - # It is not needed to include expired exclusion in this list, as only the - # currently applicable exclusions are taken into account by the eligibility - # exporting subsystem (the historical state of exclusions will be reflected - # in the historically produced timeseries regardless of the current state). - # This field can be used to mark the instance as temporary ineligible - # for the purpose of SLO calculation. For permanent instance SLO exclusion, - # use of custom instance eligibility is recommended. See 'eligibility' field - # below. + # List of SLO exclusion windows. When multiple entries in the list match ( + # matching the exclusion time-window against current time point) the exclusion + # reason used in the first matching entry will be published. It is not needed to + # include expired exclusion in this list, as only the currently applicable + # exclusions are taken into account by the eligibility exporting subsystem (the + # historical state of exclusions will be reflected in the historically produced + # timeseries regardless of the current state). This field can be used to mark + # the instance as temporary ineligible for the purpose of SLO calculation. For + # permanent instance SLO exclusion, use of custom instance eligibility is + # recommended. See 'eligibility' field below. # Corresponds to the JSON property `exclusions` # @return [Array] attr_accessor :exclusions - # Optional. List of nodes. - # Some producers need to use per-node metadata to calculate SLO. - # This field allows such producers to publish per-node SLO meta data, - # which will be consumed by SSA Eligibility Exporter and published in the + # Optional. List of nodes. Some producers need to use per-node metadata to + # calculate SLO. This field allows such producers to publish per-node SLO meta + # data, which will be consumed by SSA Eligibility Exporter and published in the # form of per node metric to Monarch. # Corresponds to the JSON property `nodes` # @return [Array] attr_accessor :nodes # Name of the SLO tier the Instance belongs to. This name will be expected to - # match the tiers specified in the service SLO configuration. - # Field is mandatory and must not be empty. + # match the tiers specified in the service SLO configuration. Field is mandatory + # and must not be empty. # Corresponds to the JSON property `tier` # @return [String] attr_accessor :tier @@ -899,8 +860,7 @@ module Google end end - # Response message for - # ListDomains + # Response message for ListDomains class ListDomainsResponse include Google::Apis::Core::Hashable @@ -986,14 +946,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 @@ -1009,8 +969,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 @@ -1034,47 +994,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::ManagedidentitiesV1beta1::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 @@ -1102,10 +1060,10 @@ module Google # @return [String] attr_accessor :api_version - # [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`. + # [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 `cancelRequested` # @return [Boolean] attr_accessor :cancel_requested @@ -1153,111 +1111,73 @@ 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 - # 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 @@ -1274,21 +1194,18 @@ module Google end end - # Request message for - # ReconfigureTrust + # Request message for ReconfigureTrust class ReconfigureTrustRequest include Google::Apis::Core::Hashable # Required. The target DNS server IP addresses to resolve the remote domain - # involved - # in the trust. + # involved in the trust. # Corresponds to the JSON property `targetDnsIpAddresses` # @return [Array] attr_accessor :target_dns_ip_addresses # Required. The fully-qualified target domain name which will be in trust with - # current - # domain. + # current domain. # Corresponds to the JSON property `targetDomainName` # @return [String] attr_accessor :target_domain_name @@ -1304,8 +1221,7 @@ module Google end end - # Request message for - # ResetAdminPassword + # Request message for ResetAdminPassword class ResetAdminPasswordRequest include Google::Apis::Core::Hashable @@ -1318,8 +1234,7 @@ module Google end end - # Response message for - # ResetAdminPassword + # Response message for ResetAdminPassword class ResetAdminPasswordResponse include Google::Apis::Core::Hashable @@ -1343,66 +1258,32 @@ 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::ManagedidentitiesV1beta1::Policy] attr_accessor :policy @@ -1417,12 +1298,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 @@ -1431,15 +1312,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 @@ -1460,10 +1341,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 @@ -1482,8 +1362,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 @@ -1498,8 +1377,8 @@ module Google end end - # Represents a relationship between two domains. This allows a controller in - # one domain to authenticate a user in another domain. + # Represents a relationship between two domains. This allows a controller in one + # domain to authenticate a user in another domain. class TrustProp include Google::Apis::Core::Hashable @@ -1508,15 +1387,13 @@ module Google # @return [String] attr_accessor :create_time - # Output only. The last heartbeat time when the trust was known to be - # connected. + # Output only. The last heartbeat time when the trust was known to be connected. # Corresponds to the JSON property `lastTrustHeartbeatTime` # @return [String] attr_accessor :last_trust_heartbeat_time # The trust authentication type, which decides whether the trusted side has - # forest/domain wide access or selective access to an approved set of - # resources. + # forest/domain wide access or selective access to an approved set of resources. # Corresponds to the JSON property `selectiveAuthentication` # @return [Boolean] attr_accessor :selective_authentication @@ -1527,8 +1404,8 @@ module Google # @return [String] attr_accessor :state - # Output only. Additional information about the current state of the - # trust, if available. + # Output only. Additional information about the current state of the trust, if + # available. # Corresponds to the JSON property `stateDescription` # @return [String] attr_accessor :state_description @@ -1539,20 +1416,20 @@ module Google # @return [Array] attr_accessor :target_dns_ip_addresses - # The fully qualified target domain name which will be in trust with the - # current domain. + # The fully qualified target domain name which will be in trust with the current + # domain. # Corresponds to the JSON property `targetDomainName` # @return [String] attr_accessor :target_domain_name - # The trust direction, which decides if the current domain is trusted, - # trusting, or both. + # The trust direction, which decides if the current domain is trusted, trusting, + # or both. # Corresponds to the JSON property `trustDirection` # @return [String] attr_accessor :trust_direction - # Input only, and will not be stored. The trust secret used for the handshake - # with the target domain. + # Input only. The trust secret used for the handshake with the target domain. It + # will not be stored. # Corresponds to the JSON property `trustHandshakeSecret` # @return [String] attr_accessor :trust_handshake_secret @@ -1587,13 +1464,12 @@ module Google end end - # Request message for - # ValidateTrust + # Request message for ValidateTrust class ValidateTrustRequest include Google::Apis::Core::Hashable - # Represents a relationship between two domains. This allows a controller in - # one domain to authenticate a user in another domain. + # Represents a relationship between two domains. This allows a controller in one + # domain to authenticate a user in another domain. # Corresponds to the JSON property `trust` # @return [Google::Apis::ManagedidentitiesV1beta1::TrustProp] attr_accessor :trust_prop diff --git a/generated/google/apis/managedidentities_v1beta1/service.rb b/generated/google/apis/managedidentities_v1beta1/service.rb index 32187d9bd..f8af1f1ce 100644 --- a/generated/google/apis/managedidentities_v1beta1/service.rb +++ b/generated/google/apis/managedidentities_v1beta1/service.rb @@ -84,8 +84,7 @@ module Google # @param [String] filter # The standard list filter. # @param [Boolean] include_unrevealed_locations - # If true, the returned list will include locations which are not yet - # revealed. + # If true, the returned list will include locations which are not yet revealed. # @param [Fixnum] page_size # The standard list page size. # @param [String] page_token @@ -123,8 +122,8 @@ module Google # Adds an AD trust to a domain. # @param [String] name - # Required. The resource domain name, project name and location using the form: - # `projects/`project_id`/locations/global/domains/`domain_name`` + # Required. The resource domain name, project name and location using the form: ` + # projects/`project_id`/locations/global/domains/`domain_name`` # @param [Google::Apis::ManagedidentitiesV1beta1::AttachTrustRequest] attach_trust_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -157,21 +156,17 @@ module Google # Creates a Microsoft AD domain. # @param [String] parent - # Required. The resource project name and location using the form: - # `projects/`project_id`/locations/global` + # Required. The resource project name and location using the form: `projects/` + # project_id`/locations/global` # @param [Google::Apis::ManagedidentitiesV1beta1::Domain] domain_object # @param [String] domain_name # Required. A domain name, e.g. mydomain.myorg.com, with the following - # restrictions: - # * Must contain only lowercase letters, numbers, periods and hyphens. - # * Must start with a letter. - # * Must contain between 2-64 characters. - # * Must end with a number or a letter. - # * Must not start with period. - # * First segement length (mydomain form example above) shouldn't exceed - # 15 chars. - # * The last segment cannot be fully numeric. - # * Must be unique within the customer project. + # restrictions: * Must contain only lowercase letters, numbers, periods and + # hyphens. * Must start with a letter. * Must contain between 2-64 characters. * + # Must end with a number or a letter. * Must not start with period. * First + # segement length (mydomain form example above) shouldn't exceed 15 chars. * The + # last segment cannot be fully numeric. * Must be unique within the customer + # project. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -204,8 +199,8 @@ module Google # Deletes a domain. # @param [String] name - # Required. The domain resource name using the form: - # `projects/`project_id`/locations/global/domains/`domain_name`` + # Required. The domain resource name using the form: `projects/`project_id`/ + # locations/global/domains/`domain_name`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -269,8 +264,8 @@ module Google # Gets information about a domain. # @param [String] name - # Required. The domain resource name using the form: - # `projects/`project_id`/locations/global/domains/`domain_name`` + # Required. The domain resource name using the form: `projects/`project_id`/ + # locations/global/domains/`domain_name`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -298,22 +293,19 @@ 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. + # 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. + # 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). + # 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 @@ -344,23 +336,19 @@ module Google # Lists domains in a project. # @param [String] parent - # Required. The resource name of the domain location using the form: - # `projects/`project_id`/locations/global` + # Required. The resource name of the domain location using the form: `projects/` + # project_id`/locations/global` # @param [String] filter - # Optional. A filter specifying constraints of a list operation. - # For example, `Domain.fqdn="mydomain.myorginization"`. + # Optional. A filter specifying constraints of a list operation. For example, ` + # Domain.fqdn="mydomain.myorginization"`. # @param [String] order_by - # Optional. Specifies the ordering of results. See - # [Sorting - # order](https://cloud.google.com/apis/design/design_patterns#sorting_order) - # for more information. + # Optional. Specifies the ordering of results. See [Sorting order](https://cloud. + # google.com/apis/design/design_patterns#sorting_order) for more information. # @param [Fixnum] page_size - # Optional. The maximum number of items to return. - # If not specified, a default value of 1000 will be used. - # Regardless of the page_size value, the response may include a partial list. - # Callers should rely on a response's - # next_page_token - # to determine if there are additional results to list. + # Optional. The maximum number of items to return. If not specified, a default + # value of 1000 will be used. Regardless of the page_size value, the response + # may include a partial list. Callers should rely on a response's + # next_page_token to determine if there are additional results to list. # @param [String] page_token # The `next_page_token` value returned from a previous ListDomainsRequest # request, if any. @@ -397,16 +385,13 @@ module Google # Updates the metadata and configuration of a domain. # @param [String] name - # Output only. The unique name of the domain using the form: - # `projects/`project_id`/locations/global/domains/`domain_name``. + # Output only. The unique name of the domain using the form: `projects/` + # project_id`/locations/global/domains/`domain_name``. # @param [Google::Apis::ManagedidentitiesV1beta1::Domain] domain_object # @param [String] update_mask # Required. Mask of fields to update. At least one path must be supplied in this - # field. The elements of the repeated paths field may only include - # fields from Domain: - # * `labels` - # * `locations` - # * `authorized_networks` + # field. The elements of the repeated paths field may only include fields from + # Domain: * `labels` * `locations` * `authorized_networks` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -439,8 +424,8 @@ module Google # Updates the DNS conditional forwarder. # @param [String] name - # Required. The resource domain name, project name and location using the form: - # `projects/`project_id`/locations/global/domains/`domain_name`` + # Required. The resource domain name, project name and location using the form: ` + # projects/`project_id`/locations/global/domains/`domain_name`` # @param [Google::Apis::ManagedidentitiesV1beta1::ReconfigureTrustRequest] reconfigure_trust_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -473,8 +458,8 @@ module Google # Resets a domain's administrator password. # @param [String] name - # Required. The domain resource name using the form: - # `projects/`project_id`/locations/global/domains/`domain_name`` + # Required. The domain resource name using the form: `projects/`project_id`/ + # locations/global/domains/`domain_name`` # @param [Google::Apis::ManagedidentitiesV1beta1::ResetAdminPasswordRequest] reset_admin_password_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -506,11 +491,11 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. - # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + # 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. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::ManagedidentitiesV1beta1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -541,15 +526,14 @@ module Google 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. + # 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. + # 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::ManagedidentitiesV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -615,15 +599,13 @@ module Google 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, + # 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. @@ -657,10 +639,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 @@ -690,9 +672,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 @@ -722,15 +703,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 diff --git a/generated/google/apis/playcustomapp_v1.rb b/generated/google/apis/playcustomapp_v1.rb index 8aa7d3974..c028940bb 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 = '20200611' + REVISION = '20200801' # View and manage your Google Play Developer account AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher' diff --git a/generated/google/apis/playcustomapp_v1/classes.rb b/generated/google/apis/playcustomapp_v1/classes.rb index a7a06fb5b..2d7c7c935 100644 --- a/generated/google/apis/playcustomapp_v1/classes.rb +++ b/generated/google/apis/playcustomapp_v1/classes.rb @@ -31,8 +31,8 @@ module Google # @return [String] attr_accessor :language_code - # Output only. Package name of the created Android app. - # Only present in the API response. + # Output only. Package name of the created Android app. Only present in the API + # response. # Corresponds to the JSON property `packageName` # @return [String] attr_accessor :package_name diff --git a/generated/google/apis/prod_tt_sasportal_v1alpha1.rb b/generated/google/apis/prod_tt_sasportal_v1alpha1.rb index 01ed22dc8..286b2e4a5 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 = '20200722' + REVISION = '20200801' # 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 7d059dfb4..bf04144bb 100644 --- a/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb +++ b/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb @@ -26,12 +26,10 @@ module Google class SasPortalAssignment include Google::Apis::Core::Hashable - # The identities the role is assigned to. It can have the following - # values: - # * ``user_email``: An email address that represents a specific - # Google account. For example: `alice@gmail.com`. - # * ``group_email``: An email address that represents a Google - # group. For example, `viewers@gmail.com`. + # The identities the role is assigned to. It can have the following values: * `` + # user_email``: An email address that represents a specific Google account. For + # example: `alice@gmail.com`. * ``group_email``: An email address that + # represents a Google group. For example, `viewers@gmail.com`. # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members @@ -56,8 +54,8 @@ module Google class SasPortalBulkCreateDeviceRequest include Google::Apis::Core::Hashable - # Required. A csv with each row representing a [device]. Each row must - # conform to the regulations described on CreateDeviceRequest's device field. + # Required. A csv with each row representing a [device]. Each row must conform + # to the regulations described on CreateDeviceRequest's device field. # Corresponds to the JSON property `csv` # @return [String] attr_accessor :csv @@ -95,8 +93,8 @@ module Google class SasPortalCreateSignedDeviceRequest include Google::Apis::Core::Hashable - # Required. JSON Web Token signed using a CPI private key. Payload - # must be the JSON encoding of the [Device]. The user_id field must be set. + # Required. JSON Web Token signed using a CPI private key. Payload must be the + # JSON encoding of the [Device]. The user_id field must be set. # Corresponds to the JSON property `encodedDevice` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -189,8 +187,7 @@ module Google # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDeviceConfig] attr_accessor :preloaded_config - # A serial number assigned to the device by the device - # manufacturer. + # A serial number assigned to the device by the device manufacturer. # Corresponds to the JSON property `serialNumber` # @return [String] attr_accessor :serial_number @@ -230,8 +227,7 @@ module Google # This field is related to the radioTechnology field and provides the air # interface specification that the CBSD is compliant with at the time of - # registration. - # Optional + # registration. Optional # Corresponds to the JSON property `supportedSpec` # @return [String] attr_accessor :supported_spec @@ -321,9 +317,9 @@ module Google end end - # Device grant. It is an authorization provided by the Spectrum - # Access System to a device to transmit using specified operating - # parameters after a successful heartbeat by the device. + # Device grant. It is an authorization provided by the Spectrum Access System to + # a device to transmit using specified operating parameters after a successful + # heartbeat by the device. class SasPortalDeviceGrant include Google::Apis::Core::Hashable @@ -342,10 +338,10 @@ module Google # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalFrequencyRange] attr_accessor :frequency_range - # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted - # by the grant. The maximum EIRP is in units of dBm/MHz. The - # value of maxEirp represents the average (RMS) EIRP that would be - # measured by the procedure defined in FCC part 96.41(e)(3). + # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. + # The maximum EIRP is in units of dBm/MHz. The value of maxEirp represents the + # average (RMS) EIRP that would be measured by the procedure defined in FCC part + # 96.41(e)(3). # Corresponds to the JSON property `maxEirp` # @return [Float] attr_accessor :max_eirp @@ -462,13 +458,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 SasPortalEmpty include Google::Apis::Core::Hashable @@ -506,8 +500,8 @@ module Google end end - # Request for GenerateSecret method] - # [spectrum.sas.portal.v1alpha1.DeviceManager.GenerateSecret]. + # Request for GenerateSecret method] [spectrum.sas.portal.v1alpha1.DeviceManager. + # GenerateSecret]. class SasPortalGenerateSecretRequest include Google::Apis::Core::Hashable @@ -524,8 +518,7 @@ module Google class SasPortalGenerateSecretResponse include Google::Apis::Core::Hashable - # The secret generated by the string and used by - # [ValidateInstaller] method. + # The secret generated by the string and used by [ValidateInstaller] method. # Corresponds to the JSON property `secret` # @return [String] attr_accessor :secret @@ -563,41 +556,39 @@ module Google class SasPortalInstallationParams include Google::Apis::Core::Hashable - # Boresight direction of the horizontal plane of the antenna in - # degrees with respect to true north. The value of this parameter - # is an integer with a value between 0 and 359 inclusive. A value - # of 0 degrees means true north; a value of 90 degrees means - # east. This parameter is optional for Category A devices and + # Boresight direction of the horizontal plane of the antenna in degrees with + # respect to true north. The value of this parameter is an integer with a value + # between 0 and 359 inclusive. A value of 0 degrees means true north; a value of + # 90 degrees means east. This parameter is optional for Category A devices and # conditional for Category B devices. # Corresponds to the JSON property `antennaAzimuth` # @return [Fixnum] attr_accessor :antenna_azimuth - # 3-dB antenna beamwidth of the antenna in the horizontal-plane in - # degrees. This parameter is an unsigned integer having a value - # between 0 and 360 (degrees) inclusive; it is optional for - # Category A devices and conditional for Category B devices. + # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This + # parameter is an unsigned integer having a value between 0 and 360 (degrees) + # inclusive; it is optional for Category A devices and conditional for Category + # B devices. # Corresponds to the JSON property `antennaBeamwidth` # @return [Fixnum] attr_accessor :antenna_beamwidth - # Antenna downtilt in degrees and is an integer with a value - # between -90 and +90 inclusive; a negative value means the antenna - # is tilted up (above horizontal). This parameter is optional for - # Category A devices and conditional for Category B devices. + # Antenna downtilt in degrees and is an integer with a value between -90 and +90 + # inclusive; a negative value means the antenna is tilted up (above horizontal). + # This parameter is optional for Category A devices and conditional for Category + # B devices. # Corresponds to the JSON property `antennaDowntilt` # @return [Fixnum] attr_accessor :antenna_downtilt - # Peak antenna gain in dBi. This parameter is an integer with a - # value between -127 and +128 (dBi) inclusive. + # Peak antenna gain in dBi. This parameter is an integer with a value between - + # 127 and +128 (dBi) inclusive. # Corresponds to the JSON property `antennaGain` # @return [Fixnum] attr_accessor :antenna_gain - # If an external antenna is used, the antenna model is optionally - # provided in this field. The string has a maximum length of 128 - # octets. + # If an external antenna is used, the antenna model is optionally provided in + # this field. The string has a maximum length of 128 octets. # Corresponds to the JSON property `antennaModel` # @return [String] attr_accessor :antenna_model @@ -608,18 +599,17 @@ module Google attr_accessor :cpe_cbsd_indication alias_method :cpe_cbsd_indication?, :cpe_cbsd_indication - # This parameter is the maximum device EIRP in units of dBm/10MHz - # and is an integer with a value between -127 and +47 (dBm/10 MHz) - # inclusive. If not included, SAS interprets it as maximum - # allowable EIRP in units of dBm/10MHz for device category. + # This parameter is the maximum device EIRP in units of dBm/10MHz and is an + # integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not + # included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz + # for device category. # Corresponds to the JSON property `eirpCapability` # @return [Fixnum] attr_accessor :eirp_capability - # Device antenna height in meters. When the heightType parameter - # value is "AGL", the antenna height should be given relative to - # ground level. When the heightType parameter value is "AMSL", it - # is given with respect to WGS84 datum. + # Device antenna height in meters. When the heightType parameter value is "AGL", + # the antenna height should be given relative to ground level. When the + # heightType parameter value is "AMSL", it is given with respect to WGS84 datum. # Corresponds to the JSON property `height` # @return [Float] attr_accessor :height @@ -629,42 +619,37 @@ module Google # @return [String] attr_accessor :height_type - # A positive number in meters to indicate accuracy of the device - # antenna horizontal location. This optional parameter should only - # be present if its value is less than the FCC requirement of 50 - # meters. + # A positive number in meters to indicate accuracy of the device antenna + # horizontal location. This optional parameter should only be present if its + # value is less than the FCC requirement of 50 meters. # Corresponds to the JSON property `horizontalAccuracy` # @return [Float] attr_accessor :horizontal_accuracy - # Whether the device antenna is indoor or not. True: indoor. False: - # outdoor. + # Whether the device antenna is indoor or not. True: indoor. False: outdoor. # Corresponds to the JSON property `indoorDeployment` # @return [Boolean] attr_accessor :indoor_deployment alias_method :indoor_deployment?, :indoor_deployment - # Latitude of the device antenna location in degrees relative to - # the WGS 84 datum. The allowed range is from -90.000000 to - # +90.000000. Positive values represent latitudes north of the - # equator; negative values south of the equator. + # Latitude of the device antenna location in degrees relative to the WGS 84 + # datum. The allowed range is from -90.000000 to +90.000000. Positive values + # represent latitudes north of the equator; negative values south of the equator. # Corresponds to the JSON property `latitude` # @return [Float] attr_accessor :latitude - # Longitude of the device antenna location. in degrees relative to - # the WGS 84 datum. The allowed range is from -180.000000 to - # +180.000000. Positive values represent longitudes east of the - # prime meridian; negative values west of the prime - # meridian. + # Longitude of the device antenna location. in degrees relative to the WGS 84 + # datum. The allowed range is from -180.000000 to +180.000000. Positive values + # represent longitudes east of the prime meridian; negative values west of the + # prime meridian. # Corresponds to the JSON property `longitude` # @return [Float] attr_accessor :longitude - # A positive number in meters to indicate accuracy of the device - # antenna vertical location. This optional parameter should only be - # present if its value is less than the FCC requirement of 3 - # meters. + # A positive number in meters to indicate accuracy of the device antenna + # vertical location. This optional parameter should only be present if its value + # is less than the FCC requirement of 3 meters. # Corresponds to the JSON property `verticalAccuracy` # @return [Float] attr_accessor :vertical_accuracy @@ -696,16 +681,14 @@ module Google class SasPortalListCustomersResponse include Google::Apis::Core::Hashable - # The list of customers that - # match the request. + # The list of customers that match the request. # Corresponds to the JSON property `customers` # @return [Array] attr_accessor :customers # A pagination token returned from a previous call to ListCustomers method that - # indicates from - # where listing should continue. If the field is missing or empty, it means - # there are no more customers. + # indicates from where listing should continue. If the field is missing or empty, + # it means there are no more customers. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -730,9 +713,9 @@ module Google # @return [Array] attr_accessor :devices - # A pagination token returned from a previous call to ListDevices method - # that indicates from where listing should continue. If the field - # is missing or empty, it means there is no more devices. + # A pagination token returned from a previous call to ListDevices method that + # indicates from where listing should continue. If the field is missing or empty, + # it means there is no more devices. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -752,10 +735,9 @@ module Google class SasPortalListNodesResponse include Google::Apis::Core::Hashable - # A pagination token returned from a previous call to - # ListNodes method - # that indicates from where listing should continue. If the field is missing - # or empty, it means there is no more nodes. + # A pagination token returned from a previous call to ListNodes method that + # indicates from where listing should continue. If the field is missing or empty, + # it means there is no more nodes. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -780,8 +762,8 @@ module Google class SasPortalMoveDeviceRequest include Google::Apis::Core::Hashable - # Required. The name of the new parent resource (Node or Customer) to - # reparent the device under. + # Required. The name of the new parent resource (Node or Customer) to reparent + # the device under. # Corresponds to the JSON property `destination` # @return [String] attr_accessor :destination @@ -852,47 +834,45 @@ module Google class SasPortalOperation 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::ProdTtSasportalV1alpha1::SasPortalStatus] 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 @@ -920,16 +900,14 @@ module Google # @return [Array] attr_accessor :assignments - # The [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 [GetPolicy], and systems are expected to put - # that etag in the request to [SetPolicy] to ensure that their - # change will be applied to the same version of the policy. - # If no [etag] is provided in the call to [SetPolicy], then the - # existing policy is overwritten blindly. + # The [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 [GetPolicy], and systems are expected to put that + # etag in the request to [SetPolicy] to ensure that their change will be applied + # to the same version of the policy. If no [etag] is provided in the call to [ + # SetPolicy], then the existing policy is overwritten blindly. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -976,9 +954,8 @@ module Google class SasPortalSignDeviceRequest include Google::Apis::Core::Hashable - # Required. The device to sign. - # The device fields name, fcc_id and serial_number must be set. - # The user_id field must be set. + # Required. The device to sign. The device fields name, fcc_id and serial_number + # must be set. The user_id field must be set. # Corresponds to the JSON property `device` # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] attr_accessor :device @@ -993,12 +970,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 SasPortalStatus include Google::Apis::Core::Hashable @@ -1007,15 +984,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 @@ -1080,9 +1057,8 @@ module Google class SasPortalUpdateSignedDeviceRequest include Google::Apis::Core::Hashable - # Required. The JSON Web Token signed using a CPI private key. Payload - # must be the JSON encoding - # of the device. The user_id field must be set. + # Required. The JSON Web Token signed using a CPI private key. Payload must be + # the JSON encoding of the device. The user_id field must be set. # Corresponds to the JSON property `encodedDevice` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1109,14 +1085,14 @@ module Google class SasPortalValidateInstallerRequest include Google::Apis::Core::Hashable - # Required. JSON Web Token signed using a CPI private key. Payload - # must include a "secret" claim whose value is the secret. + # Required. JSON Web Token signed using a CPI private key. Payload must include + # a "secret" claim whose value is the secret. # Corresponds to the JSON property `encodedSecret` # @return [String] attr_accessor :encoded_secret - # Required. Unique installer id (cpiId) from the Certified - # Professional Installers database. + # Required. Unique installer id (cpiId) from the Certified Professional + # Installers database. # Corresponds to the JSON property `installerId` # @return [String] attr_accessor :installer_id @@ -1138,8 +1114,8 @@ module Google end end - # Response for ValidateInstaller method] - # [spectrum.sas.portal.v1alpha1.DeviceManager.ValidateInstaller]. + # Response for ValidateInstaller method] [spectrum.sas.portal.v1alpha1. + # DeviceManager.ValidateInstaller]. class SasPortalValidateInstallerResponse include Google::Apis::Core::Hashable diff --git a/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb b/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb index 7e4912296..ab84a066f 100644 --- a/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb +++ b/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb @@ -79,12 +79,10 @@ module Google # Returns a list of requested customers. # @param [Fixnum] page_size - # The maximum number of customers - # to return in the response. + # The maximum number of customers to return in the response. # @param [String] page_token # A pagination token returned from a previous call to ListCustomers method that - # indicates where - # this listing should continue from. + # indicates where this listing should continue from. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -215,8 +213,7 @@ module Google execute_or_queue_command(command, &block) end - # Creates a signed device under a - # node or customer. + # 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 @@ -313,16 +310,15 @@ module Google # @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. + # 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]. + # 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. + # 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 @@ -587,8 +583,8 @@ module Google # @param [Fixnum] page_size # The maximum number of nodes to return in the response. # @param [String] page_token - # A pagination token returned from a previous call to ListNodes method - # that indicates where this listing should continue from. + # A pagination token returned from a previous call to ListNodes method 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 @@ -620,8 +616,7 @@ module Google # Moves a node under another node or customer. # @param [String] name - # Required. The name of the node to - # move. + # Required. The name of the node to move. # @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalMoveNodeRequest] sas_portal_move_node_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -727,8 +722,8 @@ module Google # @param [Fixnum] page_size # The maximum number of nodes to return in the response. # @param [String] page_token - # A pagination token returned from a previous call to ListNodes method - # that indicates where this listing should continue from. + # A pagination token returned from a previous call to ListNodes method 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 @@ -914,8 +909,7 @@ module Google execute_or_queue_command(command, &block) end - # Creates a signed device under a - # node or customer. + # 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 @@ -1012,16 +1006,15 @@ module Google # @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. + # 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]. + # 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. + # 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 @@ -1286,8 +1279,8 @@ module Google # @param [Fixnum] page_size # The maximum number of nodes to return in the response. # @param [String] page_token - # A pagination token returned from a previous call to ListNodes method - # that indicates where this listing should continue from. + # A pagination token returned from a previous call to ListNodes method 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 @@ -1319,8 +1312,7 @@ module Google # Moves a node under another node or customer. # @param [String] name - # Required. The name of the node to - # move. + # Required. The name of the node to move. # @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalMoveNodeRequest] sas_portal_move_node_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1453,8 +1445,7 @@ module Google execute_or_queue_command(command, &block) end - # Creates a signed device under a - # node or customer. + # 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 @@ -1491,16 +1482,15 @@ module Google # @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. + # 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]. + # 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. + # 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 @@ -1570,8 +1560,8 @@ module Google # @param [Fixnum] page_size # The maximum number of nodes to return in the response. # @param [String] page_token - # A pagination token returned from a previous call to ListNodes method - # that indicates where this listing should continue from. + # A pagination token returned from a previous call to ListNodes method 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 @@ -1601,9 +1591,8 @@ 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. + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. # @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalGetPolicyRequest] sas_portal_get_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/realtimebidding_v1.rb b/generated/google/apis/realtimebidding_v1.rb index 387a16f99..747968847 100644 --- a/generated/google/apis/realtimebidding_v1.rb +++ b/generated/google/apis/realtimebidding_v1.rb @@ -28,7 +28,7 @@ module Google # @see https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/ module RealtimebiddingV1 VERSION = 'V1' - REVISION = '20200730' + REVISION = '20200803' # See, create, edit, and delete your Authorized Buyers and Open Bidding account entities AUTH_REALTIME_BIDDING = 'https://www.googleapis.com/auth/realtime-bidding' diff --git a/generated/google/apis/realtimebidding_v1/classes.rb b/generated/google/apis/realtimebidding_v1/classes.rb index 6ea008d02..6cc6ae8cd 100644 --- a/generated/google/apis/realtimebidding_v1/classes.rb +++ b/generated/google/apis/realtimebidding_v1/classes.rb @@ -26,31 +26,25 @@ module Google class AdTechnologyProviders include Google::Apis::Core::Hashable - # The detected ad technology provider IDs for this creative. - # See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for - # mapping of provider ID to provided name, a privacy policy URL, and a list - # of domains which can be attributed to the provider. - # If the creative contains provider IDs that are outside of those listed in - # the `BidRequest.adslot.consented_providers_settings.consented_providers` - # field on the [Google bid - # protocol](https://developers.google.com/authorized-buyers/rtb/downloads/ - # realtime-bidding-proto) - # and the - # `BidRequest.user.ext.consented_providers_settings.consented_providers` - # field on the [OpenRTB - # protocol](https://developers.google.com/authorized-buyers/rtb/downloads/ - # openrtb-adx-proto), - # and a bid is submitted with that creative for an impression - # that will serve to an EEA user, the bid will be filtered before the + # The detected ad technology provider IDs for this creative. See https://storage. + # googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID + # to provided name, a privacy policy URL, and a list of domains which can be + # attributed to the provider. If the creative contains provider IDs that are + # outside of those listed in the `BidRequest.adslot.consented_providers_settings. + # consented_providers` field on the [Google bid protocol](https://developers. + # google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) and the ` + # BidRequest.user.ext.consented_providers_settings.consented_providers` field on + # the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/ + # downloads/openrtb-adx-proto), and a bid is submitted with that creative for an + # impression that will serve to an EEA user, the bid will be filtered before the # auction. # Corresponds to the JSON property `detectedProviderIds` # @return [Array] attr_accessor :detected_provider_ids - # Whether the creative contains an unidentified ad technology provider. - # If true for a given creative, any bid submitted with that creative for an - # impression that will serve to an EEA user will be filtered before the - # auction. + # Whether the creative contains an unidentified ad technology provider. If true + # for a given creative, any bid submitted with that creative for an impression + # that will serve to an EEA user will be filtered before the auction. # Corresponds to the JSON property `hasUnidentifiedProvider` # @return [Boolean] attr_accessor :has_unidentified_provider @@ -71,37 +65,27 @@ module Google class AdvertiserAndBrand include Google::Apis::Core::Hashable - # See https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt - # for the list of possible values. - # Can be used to filter the response of the - # creatives.list - # method. + # See https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt for + # the list of possible values. Can be used to filter the response of the + # creatives.list method. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id - # Advertiser name. - # Can be used to filter the response of the - # creatives.list + # Advertiser name. Can be used to filter the response of the creatives.list # method. # Corresponds to the JSON property `advertiserName` # @return [String] attr_accessor :advertiser_name - # Detected brand ID or zero if no brand has been detected. - # See https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt for - # the list of possible values. - # Can be used to filter the response of the - # creatives.list - # method. + # Detected brand ID or zero if no brand has been detected. See https://storage. + # googleapis.com/adx-rtb-dictionaries/brands.txt for the list of possible values. + # Can be used to filter the response of the creatives.list method. # Corresponds to the JSON property `brandId` # @return [Fixnum] attr_accessor :brand_id - # Brand name. - # Can be used to filter the response of the - # creatives.list - # method. + # Brand name. Can be used to filter the response of the creatives.list method. # Corresponds to the JSON property `brandName` # @return [String] attr_accessor :brand_name @@ -136,24 +120,20 @@ module Google class Creative include Google::Apis::Core::Hashable - # Output only. ID of the buyer account that this creative is owned by. - # Can be used to filter the response of the - # creatives.list - # method with equality and inequality check. + # Output only. ID of the buyer account that this creative is owned by. Can be + # used to filter the response of the creatives.list method with equality and + # inequality check. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id - # The link to AdChoices destination page. This is only supported for native - # ads. + # The link to AdChoices destination page. This is only supported for native ads. # Corresponds to the JSON property `adChoicesDestinationUrl` # @return [String] attr_accessor :ad_choices_destination_url - # The name of the company being advertised in the creative. - # Can be used to filter the response of the - # creatives.list - # method. + # The name of the company being advertised in the creative. Can be used to + # filter the response of the creatives.list method. # Corresponds to the JSON property `advertiserName` # @return [String] attr_accessor :advertiser_name @@ -168,20 +148,16 @@ module Google # @return [String] attr_accessor :api_update_time - # Output only. The format of this creative. - # Can be used to filter the response of the - # creatives.list - # method. + # Output only. The format of this creative. Can be used to filter the response + # of the creatives.list method. # Corresponds to the JSON property `creativeFormat` # @return [String] attr_accessor :creative_format # Buyer-specific creative ID that references this creative in bid responses. - # This field is Ignored in update operations. Can be used to filter the - # response of the - # creatives.list - # method. - # The maximum length of the creative ID is 128 bytes. + # This field is Ignored in update operations. Can be used to filter the response + # of the creatives.list method. The maximum length of the creative ID is 128 + # bytes. # Corresponds to the JSON property `creativeId` # @return [String] attr_accessor :creative_id @@ -191,51 +167,37 @@ module Google # @return [Google::Apis::RealtimebiddingV1::CreativeServingDecision] attr_accessor :creative_serving_decision - # Output only. IDs of all of the deals with which this creative has been used - # in bidding. - # Can be used to filter the response of the - # creatives.list - # method. + # Output only. IDs of all of the deals with which this creative has been used in + # bidding. Can be used to filter the response of the creatives.list method. # Corresponds to the JSON property `dealIds` # @return [Array] attr_accessor :deal_ids - # All declared attributes for the ads that may be shown from this creative. - # Can be used to filter the response of the - # creatives.list - # method. - # If the `excluded_attribute` field of a [bid - # request](https://developers.google.com/authorized-buyers/rtb/downloads/ - # realtime-bidding-proto") - # contains one of the attributes that were declared or detected for a given - # creative, and a bid is submitted with that creative, the bid will be - # filtered before the auction. + # All declared attributes for the ads that may be shown from this creative. Can + # be used to filter the response of the creatives.list method. If the ` + # excluded_attribute` field of a [bid request](https://developers.google.com/ + # authorized-buyers/rtb/downloads/realtime-bidding-proto") contains one of the + # attributes that were declared or detected for a given creative, and a bid is + # submitted with that creative, the bid will be filtered before the auction. # Corresponds to the JSON property `declaredAttributes` # @return [Array] attr_accessor :declared_attributes - # The set of declared destination URLs for the creative. - # Can be used to filter the response of the - # creatives.list - # method. + # The set of declared destination URLs for the creative. Can be used to filter + # the response of the creatives.list method. # Corresponds to the JSON property `declaredClickThroughUrls` # @return [Array] attr_accessor :declared_click_through_urls # All declared restricted categories for the ads that may be shown from this - # creative. Can be used to filter the response of the - # creatives.list - # method. + # creative. Can be used to filter the response of the creatives.list method. # Corresponds to the JSON property `declaredRestrictedCategories` # @return [Array] attr_accessor :declared_restricted_categories - # IDs for the declared ad technology vendors that may be used by this - # creative. See - # https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for - # possible values. - # Can be used to filter the response of the - # creatives.list + # IDs for the declared ad technology vendors that may be used by this creative. + # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for + # possible values. Can be used to filter the response of the creatives.list # method. # Corresponds to the JSON property `declaredVendorIds` # @return [Array] @@ -251,11 +213,10 @@ module Google # @return [Array] attr_accessor :impression_tracking_urls - # Output only. Name of the creative. - # Follows the pattern `buyers/`buyer`/creatives/`creative``, where - # ``buyer`` represents the account ID of the buyer who owns the creative, - # and ``creative`` is the buyer-specific creative ID that references this - # creative in the bid response. + # Output only. Name of the creative. Follows the pattern `buyers/`buyer`/ + # creatives/`creative``, where ``buyer`` represents the account ID of the buyer + # who owns the creative, and ``creative`` is the buyer-specific creative ID that + # references this creative in the bid response. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -270,9 +231,8 @@ module Google # @return [Array] attr_accessor :restricted_categories - # Output only. The version of this creative. - # Version for a new creative is 1 and it increments during subsequent - # creative updates. + # Output only. The version of this creative. Version for a new creative is 1 and + # it increments during subsequent creative updates. # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -335,24 +295,18 @@ module Google # @return [Array] attr_accessor :detected_advertisers - # Publisher-excludable attributes that were detected for this creative. - # Can be used to filter the response of the - # creatives.list - # method. - # If the `excluded_attribute` field of a [bid - # request](https://developers.google.com/authorized-buyers/rtb/downloads/ - # realtime-bidding-proto) - # contains one of the attributes that were declared or detected for a given - # creative, and a bid is submitted with that creative, the bid will be - # filtered before the auction. + # Publisher-excludable attributes that were detected for this creative. Can be + # used to filter the response of the creatives.list method. If the ` + # excluded_attribute` field of a [bid request](https://developers.google.com/ + # authorized-buyers/rtb/downloads/realtime-bidding-proto) contains one of the + # attributes that were declared or detected for a given creative, and a bid is + # submitted with that creative, the bid will be filtered before the auction. # Corresponds to the JSON property `detectedAttributes` # @return [Array] attr_accessor :detected_attributes - # The set of detected destination URLs for the creative. - # Can be used to filter the response of the - # creatives.list - # method. + # The set of detected destination URLs for the creative. Can be used to filter + # the response of the creatives.list method. # Corresponds to the JSON property `detectedClickThroughUrls` # @return [Array] attr_accessor :detected_click_through_urls @@ -362,58 +316,43 @@ module Google # @return [Array] attr_accessor :detected_domains - # The detected languages for this creative. The order is - # arbitrary. The codes are 2 or 5 characters and are documented at - # https://developers.google.com/adwords/api/docs/appendix/languagecodes. - # Can be used to filter the response of the - # creatives.list - # method. + # The detected languages for this creative. The order is arbitrary. The codes + # are 2 or 5 characters and are documented at https://developers.google.com/ + # adwords/api/docs/appendix/languagecodes. Can be used to filter the response of + # the creatives.list method. # Corresponds to the JSON property `detectedLanguages` # @return [Array] attr_accessor :detected_languages - # Detected product categories, if any. - # See the ad-product-categories.txt file in the technical documentation - # for a list of IDs. - # Can be used to filter the response of the - # creatives.list - # method. + # Detected product categories, if any. See the ad-product-categories.txt file in + # the technical documentation for a list of IDs. Can be used to filter the + # response of the creatives.list method. # Corresponds to the JSON property `detectedProductCategories` # @return [Array] attr_accessor :detected_product_categories - # Detected sensitive categories, if any. - # Can be used to filter the response of the - # creatives.list - # method. - # See the ad-sensitive-categories.txt file in the technical documentation - # for a list of IDs. You should use these IDs along with the - # excluded-sensitive-category field in the bid request to filter your bids. + # Detected sensitive categories, if any. Can be used to filter the response of + # the creatives.list method. See the ad-sensitive-categories.txt file in the + # technical documentation for a list of IDs. You should use these IDs along with + # the excluded-sensitive-category field in the bid request to filter your bids. # Corresponds to the JSON property `detectedSensitiveCategories` # @return [Array] attr_accessor :detected_sensitive_categories - # IDs of the ad technology vendors that were detected to be - # used by this creative. See - # https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for - # possible values. - # Can be used to filter the response of the - # creatives.list - # method. - # If the `allowed_vendor_type` field of a [bid - # request](https://developers.google.com/authorized-buyers/rtb/downloads/ - # realtime-bidding-proto) - # does not contain one of the vendor type IDs that were declared or - # detected for a given creative, and a bid is submitted with that creative, - # the bid will be filtered before the auction. + # IDs of the ad technology vendors that were detected to be used by this + # creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt + # for possible values. Can be used to filter the response of the creatives.list + # method. If the `allowed_vendor_type` field of a [bid request](https:// + # developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) + # does not contain one of the vendor type IDs that were declared or detected for + # a given creative, and a bid is submitted with that creative, the bid will be + # filtered before the auction. # Corresponds to the JSON property `detectedVendorIds` # @return [Array] attr_accessor :detected_vendor_ids - # The last time the creative status was updated. - # Can be used to filter the response of the - # creatives.list - # method. + # The last time the creative status was updated. Can be used to filter the + # response of the creatives.list method. # Corresponds to the JSON property `lastStatusUpdate` # @return [String] attr_accessor :last_status_update @@ -453,30 +392,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 @@ -524,8 +462,8 @@ module Google end end - # Evidence of the creative's destination URL not functioning properly or - # having been incorrectly set up. + # Evidence of the creative's destination URL not functioning properly or having + # been incorrectly set up. class DestinationNotWorkingEvidence include Google::Apis::Core::Hashable @@ -544,8 +482,8 @@ module Google # @return [Fixnum] attr_accessor :http_error - # Page was crawled successfully, but was detected as either a page with - # no content or an error page. + # Page was crawled successfully, but was detected as either a page with no + # content or an error page. # Corresponds to the JSON property `invalidPage` # @return [String] attr_accessor :invalid_page @@ -615,8 +553,8 @@ module Google # @return [Array] attr_accessor :top_http_call_domains - # The total number of HTTP calls made by the creative, including but not - # limited to the number of calls in the top_http_call_domains. + # The total number of HTTP calls made by the creative, including but not limited + # to the number of calls in the top_http_call_domains. # Corresponds to the JSON property `totalHttpCallCount` # @return [Fixnum] attr_accessor :total_http_call_count @@ -657,8 +595,8 @@ module Google end end - # Total download size and URL-level download size breakdown for resources in - # a creative. + # Total download size and URL-level download size breakdown for resources in a + # creative. class DownloadSizeEvidence include Google::Apis::Core::Hashable @@ -687,10 +625,10 @@ module Google class GetRemarketingTagResponse include Google::Apis::Core::Hashable - # A HTML tag that can be placed on the advertiser's page to add users to a - # user list. For more information and code samples on using snippet on your - # website refer to [Tag your site for remarketing]( - # https://support.google.com/google-ads/answer/2476688). + # A HTML tag that can be placed on the advertiser's page to add users to a user + # list. For more information and code samples on using snippet on your website + # refer to [Tag your site for remarketing]( https://support.google.com/google- + # ads/answer/2476688). # Corresponds to the JSON property `snippet` # @return [String] attr_accessor :snippet @@ -709,10 +647,8 @@ module Google class HtmlContent include Google::Apis::Core::Hashable - # The height of the HTML snippet in pixels. - # Can be used to filter the response of the - # creatives.list - # method. + # The height of the HTML snippet in pixels. Can be used to filter the response + # of the creatives.list method. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height @@ -722,10 +658,8 @@ module Google # @return [String] attr_accessor :snippet - # The width of the HTML snippet in pixels. - # Can be used to filter the response of the - # creatives.list - # method. + # The width of the HTML snippet in pixels. Can be used to filter the response of + # the creatives.list method. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width @@ -765,18 +699,18 @@ module Google class HttpCookieEvidence include Google::Apis::Core::Hashable - # Names of cookies that violate Google policies. - # For TOO_MANY_COOKIES policy, this will be the cookie names of top domains - # with the largest number of cookies. For other policies, this will be all - # the cookie names that violate the policy. + # Names of cookies that violate Google policies. For TOO_MANY_COOKIES policy, + # this will be the cookie names of top domains with the largest number of + # cookies. For other policies, this will be all the cookie names that violate + # the policy. # Corresponds to the JSON property `cookieNames` # @return [Array] attr_accessor :cookie_names # The largest number of cookies set by a creative. If this field is set, - # cookie_names above will be set to the cookie names of top domains with - # the largest number of cookies. - # This field will only be set for TOO_MANY_COOKIES policy. + # cookie_names above will be set to the cookie names of top domains with the + # largest number of cookies. This field will only be set for TOO_MANY_COOKIES + # policy. # Corresponds to the JSON property `maxCookieCount` # @return [Fixnum] attr_accessor :max_cookie_count @@ -792,8 +726,8 @@ module Google end end - # An image resource. You may provide a larger image than was requested, - # so long as the aspect ratio is preserved. + # An image resource. You may provide a larger image than was requested, so long + # as the aspect ratio is preserved. class Image include Google::Apis::Core::Hashable @@ -833,11 +767,9 @@ module Google # @return [Array] attr_accessor :creatives - # A token to retrieve the next page of results. - # Pass this value in the - # ListCreativesRequest.pageToken - # field in the subsequent call to the `ListCreatives` method to retrieve the - # next page of results. + # A token to retrieve the next page of results. Pass this value in the + # ListCreativesRequest.pageToken field in the subsequent call to the ` + # ListCreatives` method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -857,11 +789,10 @@ module Google class ListUserListsResponse include Google::Apis::Core::Hashable - # The continuation page token to send back to the server in a subsequent - # request. + # The continuation page token to send back to the server in a subsequent request. # Due to a currently known issue, it is recommended that the caller keep - # invoking the list method till the time a next page token is not returned - # (even if the result set is empty). + # invoking the list method till the time a next page token is not returned (even + # if the result set is empty). # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -886,18 +817,14 @@ module Google class MediaFile include Google::Apis::Core::Hashable - # Bitrate of the video file, in Kbps. - # Can be used to filter the response of the - # creatives.list - # method. + # Bitrate of the video file, in Kbps. Can be used to filter the response of the + # creatives.list method. # Corresponds to the JSON property `bitrate` # @return [Fixnum] attr_accessor :bitrate - # The MIME type of this media file. - # Can be used to filter the response of the - # creatives.list - # method. + # The MIME type of this media file. Can be used to filter the response of the + # creatives.list method. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type @@ -922,8 +849,8 @@ module Google # @return [String] attr_accessor :advertiser_name - # An image resource. You may provide a larger image than was requested, - # so long as the aspect ratio is preserved. + # An image resource. You may provide a larger image than was requested, so long + # as the aspect ratio is preserved. # Corresponds to the JSON property `appIcon` # @return [Google::Apis::RealtimebiddingV1::Image] attr_accessor :app_icon @@ -953,14 +880,14 @@ module Google # @return [String] attr_accessor :headline - # An image resource. You may provide a larger image than was requested, - # so long as the aspect ratio is preserved. + # An image resource. You may provide a larger image than was requested, so long + # as the aspect ratio is preserved. # Corresponds to the JSON property `image` # @return [Google::Apis::RealtimebiddingV1::Image] attr_accessor :image - # An image resource. You may provide a larger image than was requested, - # so long as the aspect ratio is preserved. + # An image resource. You may provide a larger image than was requested, so long + # as the aspect ratio is preserved. # Corresponds to the JSON property `logo` # @return [Google::Apis::RealtimebiddingV1::Image] attr_accessor :logo @@ -1030,13 +957,10 @@ module Google # @return [String] attr_accessor :help_center_url - # Policy topic this entry refers to. For example, "ALCOHOL", - # "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible - # policy topics is not fixed for a particular API version and may change at - # any time. - # Can be used to filter the response of the - # creatives.list - # method + # Policy topic this entry refers to. For example, "ALCOHOL", " + # TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible + # policy topics is not fixed for a particular API version and may change at any + # time. Can be used to filter the response of the creatives.list method # Corresponds to the JSON property `policyTopic` # @return [String] attr_accessor :policy_topic @@ -1062,8 +986,8 @@ module Google # @return [Google::Apis::RealtimebiddingV1::DestinationNotCrawlableEvidence] attr_accessor :destination_not_crawlable - # Evidence of the creative's destination URL not functioning properly or - # having been incorrectly set up. + # Evidence of the creative's destination URL not functioning properly or having + # been incorrectly set up. # Corresponds to the JSON property `destinationNotWorking` # @return [Google::Apis::RealtimebiddingV1::DestinationNotWorkingEvidence] attr_accessor :destination_not_working @@ -1078,8 +1002,8 @@ module Google # @return [Google::Apis::RealtimebiddingV1::DomainCallEvidence] attr_accessor :domain_call - # Total download size and URL-level download size breakdown for resources in - # a creative. + # Total download size and URL-level download size breakdown for resources in a + # creative. # Corresponds to the JSON property `downloadSize` # @return [Google::Apis::RealtimebiddingV1::DownloadSizeEvidence] attr_accessor :download_size @@ -1114,18 +1038,16 @@ module Google class ServingStatus include Google::Apis::Core::Hashable - # Serving status for the given transaction type (e.g., open auction, - # deals) or region (e.g., China, Russia). - # Can be used to filter the response of the - # creatives.list - # method. + # Serving status for the given transaction type (e.g., open auction, deals) or + # region (e.g., China, Russia). Can be used to filter the response of the + # creatives.list method. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status - # Policy topics related to the serving decision for this transaction type - # (e.g., open auction, deals) or region (e.g., China, Russia). - # Topics may be present only if status is DISAPPROVED. + # Policy topics related to the serving decision for this transaction type (e.g., + # open auction, deals) or region (e.g., China, Russia). Topics may be present + # only if status is DISAPPROVED. # Corresponds to the JSON property `topics` # @return [Array] attr_accessor :topics @@ -1173,12 +1095,12 @@ 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`. # Corresponds to the JSON property `endDate` # @return [Google::Apis::RealtimebiddingV1::Date] attr_accessor :end_date @@ -1190,12 +1112,12 @@ 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`. # Corresponds to the JSON property `startDate` # @return [Google::Apis::RealtimebiddingV1::Date] attr_accessor :start_date @@ -1218,11 +1140,10 @@ module Google end end - # Represents an Authorized Buyers user list. Authorized Buyers can - # create/update/list user lists. Once a user list is created - # in the system, Authorized Buyers can add users to the user list using - # the bulk uploader API. Alternatively, users can be added by hosting a - # tag on the advertiser's page. + # Represents an Authorized Buyers user list. Authorized Buyers can create/update/ + # list user lists. Once a user list is created in the system, Authorized Buyers + # can add users to the user list using the bulk uploader API. Alternatively, + # users can be added by hosting a tag on the advertiser's page. class UserList include Google::Apis::Core::Hashable @@ -1232,24 +1153,23 @@ module Google attr_accessor :description # Required. Display name of the user list. This must be unique across all user - # lists - # for a given account. + # lists for a given account. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Required. The number of days a user's cookie stays on the user list. - # The field must be between 0 and 540 inclusive. + # Required. The number of days a user's cookie stays on the user list. The field + # must be between 0 and 540 inclusive. # Corresponds to the JSON property `membershipDurationDays` # @return [Fixnum] attr_accessor :membership_duration_days - # Output only. Name of the user list that must follow the pattern - # `buyers/`buyer`/userLists/`user_list``, where ``buyer`` represents - # the account ID of the buyer who owns the user list. For a bidder accessing - # user lists on behalf of a child seat buyer, ``buyer`` represents - # the account ID of the child seat buyer. ``user_list`` is an int64 - # identifier assigned by Google to uniquely identify a user list. + # Output only. Name of the user list that must follow the pattern `buyers/`buyer` + # /userLists/`user_list``, where ``buyer`` represents the account ID of the + # buyer who owns the user list. For a bidder accessing user lists on behalf of a + # child seat buyer, ``buyer`` represents the account ID of the child seat buyer. + # ``user_list`` is an int64 identifier assigned by Google to uniquely identify a + # user list. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1294,8 +1214,8 @@ module Google # @return [String] attr_accessor :video_url - # The contents of a VAST document for a video ad. - # This document should conform to the VAST 2.0 or 3.0 standard. + # The contents of a VAST document for a video ad. This document should conform + # to the VAST 2.0 or 3.0 standard. # Corresponds to the JSON property `videoVastXml` # @return [String] attr_accessor :video_vast_xml @@ -1316,53 +1236,43 @@ module Google class VideoMetadata include Google::Apis::Core::Hashable - # The duration of the ad. - # Can be used to filter the response of the - # creatives.list - # method. + # The duration of the ad. Can be used to filter the response of the creatives. + # list method. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration - # Is this a valid VAST ad? - # Can be used to filter the response of the - # creatives.list - # method. + # Is this a valid VAST ad? Can be used to filter the response of the creatives. + # list method. # Corresponds to the JSON property `isValidVast` # @return [Boolean] attr_accessor :is_valid_vast alias_method :is_valid_vast?, :is_valid_vast - # Is this a VPAID ad? - # Can be used to filter the response of the - # creatives.list + # Is this a VPAID ad? Can be used to filter the response of the creatives.list # method. # Corresponds to the JSON property `isVpaid` # @return [Boolean] attr_accessor :is_vpaid alias_method :is_vpaid?, :is_vpaid - # The list of all media files declared in the VAST. If there are multiple - # VASTs in a wrapper chain, this includes the media files from the deepest - # one in the chain. + # The list of all media files declared in the VAST. If there are multiple VASTs + # in a wrapper chain, this includes the media files from the deepest one in the + # chain. # Corresponds to the JSON property `mediaFiles` # @return [Array] attr_accessor :media_files - # The minimum duration that the user has to watch before being able to - # skip this ad. If the field is not set, the ad is not skippable. If - # the field is set, the ad is skippable. - # Can be used to filter the response of the - # creatives.list + # The minimum duration that the user has to watch before being able to skip this + # ad. If the field is not set, the ad is not skippable. If the field is set, the + # ad is skippable. Can be used to filter the response of the creatives.list # method. # Corresponds to the JSON property `skipOffset` # @return [String] attr_accessor :skip_offset - # The maximum VAST version across all wrapped VAST documents. - # Can be used to filter the response of the - # creatives.list - # method. + # The maximum VAST version across all wrapped VAST documents. Can be used to + # filter the response of the creatives.list method. # Corresponds to the JSON property `vastVersion` # @return [String] attr_accessor :vast_version @@ -1382,8 +1292,8 @@ module Google end end - # A request to receive push notifications when any of the creatives belonging - # to the bidder changes status. + # A request to receive push notifications when any of the creatives belonging to + # the bidder changes status. class WatchCreativesRequest include Google::Apis::Core::Hashable @@ -1402,21 +1312,18 @@ module Google include Google::Apis::Core::Hashable # The Pub/Sub subscription that can be used to pull creative status - # notifications. This would be of the format - # `projects/`project_id`/subscriptions/`subscription_id``. - # Subscription is created with pull delivery. All service accounts belonging - # to the bidder will have read access to this subscription. - # Subscriptions that are inactive for more than 90 days will be disabled. - # Please use - # watchCreatives to - # re-enable the subscription. + # notifications. This would be of the format `projects/`project_id`/ + # subscriptions/`subscription_id``. Subscription is created with pull delivery. + # All service accounts belonging to the bidder will have read access to this + # subscription. Subscriptions that are inactive for more than 90 days will be + # disabled. Please use watchCreatives to re-enable the subscription. # Corresponds to the JSON property `subscription` # @return [String] attr_accessor :subscription - # The Pub/Sub topic that will be used to publish creative serving - # status notifications. This would be of the format - # `projects/`project_id`/topics/`topic_id``. + # The Pub/Sub topic that will be used to publish creative serving status + # notifications. This would be of the format `projects/`project_id`/topics/` + # topic_id``. # Corresponds to the JSON property `topic` # @return [String] attr_accessor :topic diff --git a/generated/google/apis/realtimebidding_v1/service.rb b/generated/google/apis/realtimebidding_v1/service.rb index dd8188541..ffe671855 100644 --- a/generated/google/apis/realtimebidding_v1/service.rb +++ b/generated/google/apis/realtimebidding_v1/service.rb @@ -52,44 +52,36 @@ module Google # Lists creatives. # @param [String] parent - # Required. Name of the parent buyer that owns the creatives. - # The pattern for this resource is either `buyers/`buyerAccountId`` or - # `bidders/`bidderAccountId``. - # For `buyers/`buyerAccountId``, the `buyerAccountId` can be one of the - # following: - # 1. The ID of the buyer that is accessing their own creatives. - # 2. The ID of the child seat buyer under a bidder account. - # So for listing creatives pertaining to the child seat buyer (`456`) - # under bidder account (`123`), you would use the pattern: `buyers/456`. - # 3. The ID of the bidder itself. - # So for listing creatives pertaining to bidder (`123`), - # you would use `buyers/123`. - # If you want to access all creatives pertaining to both the bidder and all - # of its child seat accounts, you would use `bidders/`bidderAccountId``, - # e.g., for all creatives pertaining to bidder (`123`), use `bidders/123`. + # Required. Name of the parent buyer that owns the creatives. The pattern for + # this resource is either `buyers/`buyerAccountId`` or `bidders/`bidderAccountId` + # `. For `buyers/`buyerAccountId``, the `buyerAccountId` can be one of the + # following: 1. The ID of the buyer that is accessing their own creatives. 2. + # The ID of the child seat buyer under a bidder account. So for listing + # creatives pertaining to the child seat buyer (`456`) under bidder account (` + # 123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself. + # So for listing creatives pertaining to bidder (`123`), you would use `buyers/ + # 123`. If you want to access all creatives pertaining to both the bidder and + # all of its child seat accounts, you would use `bidders/`bidderAccountId``, e.g. + # , for all creatives pertaining to bidder (`123`), use `bidders/123`. # @param [String] filter - # Query string to filter creatives. If no filter is specified, - # all active creatives will be returned. - # Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND - # disapprovalReason:UNACCEPTABLE_CONTENT) OR - # declaredAttributes:IS_COOKIE_TARGETED' + # Query string to filter creatives. If no filter is specified, all active + # creatives will be returned. Example: 'accountId=12345 AND (dealsStatus: + # DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes: + # IS_COOKIE_TARGETED' # @param [Fixnum] page_size - # Requested page size. The server may return fewer creatives than requested - # (due to timeout constraint) even if more are available via another call. - # If unspecified, server will pick an appropriate default. - # Acceptable values are 1 to 1000, inclusive. + # Requested page size. The server may return fewer creatives than requested (due + # to timeout constraint) even if more are available via another call. If + # unspecified, server will pick an appropriate default. Acceptable values are 1 + # to 1000, inclusive. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListCreativesResponse.nextPageToken - # returned from the previous call to the 'ListCreatives' method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListCreativesResponse.nextPageToken returned from the + # previous call to the 'ListCreatives' method. # @param [String] view - # Controls the amount of information included in the response. - # By default only - # creativeServingDecision - # is included. To retrieve the entire creative - # resource (including the declared - # fields and the creative content) specify the view as "FULL". + # Controls the amount of information included in the response. By default only + # creativeServingDecision is included. To retrieve the entire creative resource ( + # including the declared fields and the creative content) specify the view as " + # FULL". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -121,17 +113,15 @@ module Google execute_or_queue_command(command, &block) end - # Watches all creatives pertaining to a bidder. It is sufficient to invoke - # this endpoint once per bidder. A Pub/Sub topic will be created and - # notifications will be pushed to the topic when any of the bidder's - # creatives change status. All of the bidder's service accounts will have - # access to read from the topic. - # Subsequent invocations of this method will return the existing - # Pub/Sub configuration. + # Watches all creatives pertaining to a bidder. It is sufficient to invoke this + # endpoint once per bidder. A Pub/Sub topic will be created and notifications + # will be pushed to the topic when any of the bidder's creatives change status. + # All of the bidder's service accounts will have access to read from the topic. + # Subsequent invocations of this method will return the existing Pub/Sub + # configuration. # @param [String] parent # Required. To watch all creatives pertaining to the bidder and all its child - # seat - # accounts, the bidder must follow the pattern `bidders/`bidderAccountId``. + # seat accounts, the bidder must follow the pattern `bidders/`bidderAccountId``. # @param [Google::Apis::RealtimebiddingV1::WatchCreativesRequest] watch_creatives_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -162,21 +152,16 @@ module Google execute_or_queue_command(command, &block) end - # Gets remarketing tag for a buyer. A remarketing tag is a piece of - # JavaScript code that can be placed on a web page. When a user - # visits a page containing a remarketing tag, Google adds the user to a user - # list. + # Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript + # code that can be placed on a web page. When a user visits a page containing a + # remarketing tag, Google adds the user to a user list. # @param [String] name # Required. To fetch remarketing tag for an account, name must follow the - # pattern - # `buyers/`accountId`` where ``accountId`` - # represents ID of a buyer that owns the remarketing tag. For a - # bidder accessing remarketing tag on behalf of a child seat buyer, - # ``accountId`` should represent the ID of the child seat buyer. - # To fetch remarketing tag for a specific user list, name - # must follow the pattern - # `buyers/`accountId`/userLists/`userListId``. See - # UserList.name. + # pattern `buyers/`accountId`` where ``accountId`` represents ID of a buyer that + # owns the remarketing tag. For a bidder accessing remarketing tag on behalf of + # a child seat buyer, ``accountId`` should represent the ID of the child seat + # buyer. To fetch remarketing tag for a specific user list, name must follow the + # pattern `buyers/`accountId`/userLists/`userListId``. See UserList.name. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -207,11 +192,10 @@ module Google # Creates a creative. # @param [String] parent # Required. The name of the parent buyer that the new creative belongs to that - # must - # follow the pattern `buyers/`buyerAccountId``, where ``buyerAccountId`` + # must follow the pattern `buyers/`buyerAccountId``, where ``buyerAccountId`` # represents the account ID of the buyer who owns a creative. For a bidder - # accessing creatives on behalf of a child seat buyer, ``buyerAccountId`` - # should represent the account ID of the child seat buyer. + # accessing creatives on behalf of a child seat buyer, ``buyerAccountId`` should + # represent the account ID of the child seat buyer. # @param [Google::Apis::RealtimebiddingV1::Creative] creative_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -244,15 +228,12 @@ module Google # Gets a creative. # @param [String] name - # Required. Name of the creative to retrieve. See - # creative.name. + # Required. Name of the creative to retrieve. See creative.name. # @param [String] view - # Controls the amount of information included in the response. - # By default only - # creativeServingDecision - # is included. To retrieve the entire creative - # resource (including the declared - # fields and the creative content) specify the view as "FULL". + # Controls the amount of information included in the response. By default only + # creativeServingDecision is included. To retrieve the entire creative resource ( + # including the declared fields and the creative content) specify the view as " + # FULL". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -283,44 +264,36 @@ module Google # Lists creatives. # @param [String] parent - # Required. Name of the parent buyer that owns the creatives. - # The pattern for this resource is either `buyers/`buyerAccountId`` or - # `bidders/`bidderAccountId``. - # For `buyers/`buyerAccountId``, the `buyerAccountId` can be one of the - # following: - # 1. The ID of the buyer that is accessing their own creatives. - # 2. The ID of the child seat buyer under a bidder account. - # So for listing creatives pertaining to the child seat buyer (`456`) - # under bidder account (`123`), you would use the pattern: `buyers/456`. - # 3. The ID of the bidder itself. - # So for listing creatives pertaining to bidder (`123`), - # you would use `buyers/123`. - # If you want to access all creatives pertaining to both the bidder and all - # of its child seat accounts, you would use `bidders/`bidderAccountId``, - # e.g., for all creatives pertaining to bidder (`123`), use `bidders/123`. + # Required. Name of the parent buyer that owns the creatives. The pattern for + # this resource is either `buyers/`buyerAccountId`` or `bidders/`bidderAccountId` + # `. For `buyers/`buyerAccountId``, the `buyerAccountId` can be one of the + # following: 1. The ID of the buyer that is accessing their own creatives. 2. + # The ID of the child seat buyer under a bidder account. So for listing + # creatives pertaining to the child seat buyer (`456`) under bidder account (` + # 123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself. + # So for listing creatives pertaining to bidder (`123`), you would use `buyers/ + # 123`. If you want to access all creatives pertaining to both the bidder and + # all of its child seat accounts, you would use `bidders/`bidderAccountId``, e.g. + # , for all creatives pertaining to bidder (`123`), use `bidders/123`. # @param [String] filter - # Query string to filter creatives. If no filter is specified, - # all active creatives will be returned. - # Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND - # disapprovalReason:UNACCEPTABLE_CONTENT) OR - # declaredAttributes:IS_COOKIE_TARGETED' + # Query string to filter creatives. If no filter is specified, all active + # creatives will be returned. Example: 'accountId=12345 AND (dealsStatus: + # DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes: + # IS_COOKIE_TARGETED' # @param [Fixnum] page_size - # Requested page size. The server may return fewer creatives than requested - # (due to timeout constraint) even if more are available via another call. - # If unspecified, server will pick an appropriate default. - # Acceptable values are 1 to 1000, inclusive. + # Requested page size. The server may return fewer creatives than requested (due + # to timeout constraint) even if more are available via another call. If + # unspecified, server will pick an appropriate default. Acceptable values are 1 + # to 1000, inclusive. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # ListCreativesResponse.nextPageToken - # returned from the previous call to the 'ListCreatives' method. + # A token identifying a page of results the server should return. Typically, + # this is the value of ListCreativesResponse.nextPageToken returned from the + # previous call to the 'ListCreatives' method. # @param [String] view - # Controls the amount of information included in the response. - # By default only - # creativeServingDecision - # is included. To retrieve the entire creative - # resource (including the declared - # fields and the creative content) specify the view as "FULL". + # Controls the amount of information included in the response. By default only + # creativeServingDecision is included. To retrieve the entire creative resource ( + # including the declared fields and the creative content) specify the view as " + # FULL". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -354,8 +327,7 @@ module Google # Updates a creative. # @param [String] name - # Name of the creative to update. See - # creative.name. + # Name of the creative to update. See creative.name. # @param [Google::Apis::RealtimebiddingV1::Creative] creative_object # @param [String] update_mask # Field mask to use for partial in-place updates. @@ -389,11 +361,10 @@ module Google execute_or_queue_command(command, &block) end - # Change the status of a user list to CLOSED. This prevents new users from - # being added to the user list. + # Change the status of a user list to CLOSED. This prevents new users from being + # added to the user list. # @param [String] name - # Required. The name of the user list to close. - # See UserList.name + # Required. The name of the user list to close. See UserList.name # @param [Google::Apis::RealtimebiddingV1::CloseUserListRequest] close_user_list_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -463,8 +434,7 @@ module Google # Gets a user list by its name. # @param [String] name - # Required. The name of the user list to be retrieved. See - # UserList.name. + # Required. The name of the user list to be retrieved. See UserList.name. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -492,21 +462,16 @@ module Google execute_or_queue_command(command, &block) end - # Gets remarketing tag for a buyer. A remarketing tag is a piece of - # JavaScript code that can be placed on a web page. When a user - # visits a page containing a remarketing tag, Google adds the user to a user - # list. + # Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript + # code that can be placed on a web page. When a user visits a page containing a + # remarketing tag, Google adds the user to a user list. # @param [String] name # Required. To fetch remarketing tag for an account, name must follow the - # pattern - # `buyers/`accountId`` where ``accountId`` - # represents ID of a buyer that owns the remarketing tag. For a - # bidder accessing remarketing tag on behalf of a child seat buyer, - # ``accountId`` should represent the ID of the child seat buyer. - # To fetch remarketing tag for a specific user list, name - # must follow the pattern - # `buyers/`accountId`/userLists/`userListId``. See - # UserList.name. + # pattern `buyers/`accountId`` where ``accountId`` represents ID of a buyer that + # owns the remarketing tag. For a bidder accessing remarketing tag on behalf of + # a child seat buyer, ``accountId`` should represent the ID of the child seat + # buyer. To fetch remarketing tag for a specific user list, name must follow the + # pattern `buyers/`accountId`/userLists/`userListId``. See UserList.name. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -537,8 +502,7 @@ module Google # Lists the user lists visible to the current user. # @param [String] parent # Required. The name of the parent buyer for the user lists to be returned that - # must - # follow the pattern `buyers/`buyerAccountId``, where ``buyerAccountId`` + # must follow the pattern `buyers/`buyerAccountId``, where ``buyerAccountId`` # represents the account ID of the buyer who owns user lists. For a bidder # accessing user lists on behalf of a child seat buyer , ``buyerAccountId`` # should represent the account ID of the child seat buyer. @@ -575,11 +539,10 @@ module Google execute_or_queue_command(command, &block) end - # Change the status of a user list to OPEN. This allows new users to be added - # to the user list. + # Change the status of a user list to OPEN. This allows new users to be added to + # the user list. # @param [String] name - # Required. The name of the user list to open. - # See UserList.name + # Required. The name of the user list to open. See UserList.name # @param [Google::Apis::RealtimebiddingV1::OpenUserListRequest] open_user_list_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -613,12 +576,12 @@ module Google # Update the given user list. Only user lists with URLRestrictions can be # updated. # @param [String] name - # Output only. Name of the user list that must follow the pattern - # `buyers/`buyer`/userLists/`user_list``, where ``buyer`` represents - # the account ID of the buyer who owns the user list. For a bidder accessing - # user lists on behalf of a child seat buyer, ``buyer`` represents - # the account ID of the child seat buyer. ``user_list`` is an int64 - # identifier assigned by Google to uniquely identify a user list. + # Output only. Name of the user list that must follow the pattern `buyers/`buyer` + # /userLists/`user_list``, where ``buyer`` represents the account ID of the + # buyer who owns the user list. For a bidder accessing user lists on behalf of a + # child seat buyer, ``buyer`` represents the account ID of the child seat buyer. + # ``user_list`` is an int64 identifier assigned by Google to uniquely identify a + # user list. # @param [Google::Apis::RealtimebiddingV1::UserList] user_list_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/sasportal_v1alpha1.rb b/generated/google/apis/sasportal_v1alpha1.rb index 8a6e7c4f5..a3296fe4f 100644 --- a/generated/google/apis/sasportal_v1alpha1.rb +++ b/generated/google/apis/sasportal_v1alpha1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/spectrum-access-system/ module SasportalV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200722' + REVISION = '20200801' # View your email address AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email' diff --git a/generated/google/apis/sasportal_v1alpha1/classes.rb b/generated/google/apis/sasportal_v1alpha1/classes.rb index 84899cd4a..616231fc3 100644 --- a/generated/google/apis/sasportal_v1alpha1/classes.rb +++ b/generated/google/apis/sasportal_v1alpha1/classes.rb @@ -26,12 +26,10 @@ module Google class SasPortalAssignment include Google::Apis::Core::Hashable - # The identities the role is assigned to. It can have the following - # values: - # * ``user_email``: An email address that represents a specific - # Google account. For example: `alice@gmail.com`. - # * ``group_email``: An email address that represents a Google - # group. For example, `viewers@gmail.com`. + # The identities the role is assigned to. It can have the following values: * `` + # user_email``: An email address that represents a specific Google account. For + # example: `alice@gmail.com`. * ``group_email``: An email address that + # represents a Google group. For example, `viewers@gmail.com`. # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members @@ -56,8 +54,8 @@ module Google class SasPortalBulkCreateDeviceRequest include Google::Apis::Core::Hashable - # Required. A csv with each row representing a [device]. Each row must - # conform to the regulations described on CreateDeviceRequest's device field. + # Required. A csv with each row representing a [device]. Each row must conform + # to the regulations described on CreateDeviceRequest's device field. # Corresponds to the JSON property `csv` # @return [String] attr_accessor :csv @@ -95,8 +93,8 @@ module Google class SasPortalCreateSignedDeviceRequest include Google::Apis::Core::Hashable - # Required. JSON Web Token signed using a CPI private key. Payload - # must be the JSON encoding of the [Device]. The user_id field must be set. + # Required. JSON Web Token signed using a CPI private key. Payload must be the + # JSON encoding of the [Device]. The user_id field must be set. # Corresponds to the JSON property `encodedDevice` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -189,8 +187,7 @@ module Google # @return [Google::Apis::SasportalV1alpha1::SasPortalDeviceConfig] attr_accessor :preloaded_config - # A serial number assigned to the device by the device - # manufacturer. + # A serial number assigned to the device by the device manufacturer. # Corresponds to the JSON property `serialNumber` # @return [String] attr_accessor :serial_number @@ -230,8 +227,7 @@ module Google # This field is related to the radioTechnology field and provides the air # interface specification that the CBSD is compliant with at the time of - # registration. - # Optional + # registration. Optional # Corresponds to the JSON property `supportedSpec` # @return [String] attr_accessor :supported_spec @@ -321,9 +317,9 @@ module Google end end - # Device grant. It is an authorization provided by the Spectrum - # Access System to a device to transmit using specified operating - # parameters after a successful heartbeat by the device. + # Device grant. It is an authorization provided by the Spectrum Access System to + # a device to transmit using specified operating parameters after a successful + # heartbeat by the device. class SasPortalDeviceGrant include Google::Apis::Core::Hashable @@ -342,10 +338,10 @@ module Google # @return [Google::Apis::SasportalV1alpha1::SasPortalFrequencyRange] attr_accessor :frequency_range - # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted - # by the grant. The maximum EIRP is in units of dBm/MHz. The - # value of maxEirp represents the average (RMS) EIRP that would be - # measured by the procedure defined in FCC part 96.41(e)(3). + # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. + # The maximum EIRP is in units of dBm/MHz. The value of maxEirp represents the + # average (RMS) EIRP that would be measured by the procedure defined in FCC part + # 96.41(e)(3). # Corresponds to the JSON property `maxEirp` # @return [Float] attr_accessor :max_eirp @@ -462,13 +458,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 SasPortalEmpty include Google::Apis::Core::Hashable @@ -506,8 +500,8 @@ module Google end end - # Request for GenerateSecret method] - # [spectrum.sas.portal.v1alpha1.DeviceManager.GenerateSecret]. + # Request for GenerateSecret method] [spectrum.sas.portal.v1alpha1.DeviceManager. + # GenerateSecret]. class SasPortalGenerateSecretRequest include Google::Apis::Core::Hashable @@ -524,8 +518,7 @@ module Google class SasPortalGenerateSecretResponse include Google::Apis::Core::Hashable - # The secret generated by the string and used by - # [ValidateInstaller] method. + # The secret generated by the string and used by [ValidateInstaller] method. # Corresponds to the JSON property `secret` # @return [String] attr_accessor :secret @@ -563,41 +556,39 @@ module Google class SasPortalInstallationParams include Google::Apis::Core::Hashable - # Boresight direction of the horizontal plane of the antenna in - # degrees with respect to true north. The value of this parameter - # is an integer with a value between 0 and 359 inclusive. A value - # of 0 degrees means true north; a value of 90 degrees means - # east. This parameter is optional for Category A devices and + # Boresight direction of the horizontal plane of the antenna in degrees with + # respect to true north. The value of this parameter is an integer with a value + # between 0 and 359 inclusive. A value of 0 degrees means true north; a value of + # 90 degrees means east. This parameter is optional for Category A devices and # conditional for Category B devices. # Corresponds to the JSON property `antennaAzimuth` # @return [Fixnum] attr_accessor :antenna_azimuth - # 3-dB antenna beamwidth of the antenna in the horizontal-plane in - # degrees. This parameter is an unsigned integer having a value - # between 0 and 360 (degrees) inclusive; it is optional for - # Category A devices and conditional for Category B devices. + # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This + # parameter is an unsigned integer having a value between 0 and 360 (degrees) + # inclusive; it is optional for Category A devices and conditional for Category + # B devices. # Corresponds to the JSON property `antennaBeamwidth` # @return [Fixnum] attr_accessor :antenna_beamwidth - # Antenna downtilt in degrees and is an integer with a value - # between -90 and +90 inclusive; a negative value means the antenna - # is tilted up (above horizontal). This parameter is optional for - # Category A devices and conditional for Category B devices. + # Antenna downtilt in degrees and is an integer with a value between -90 and +90 + # inclusive; a negative value means the antenna is tilted up (above horizontal). + # This parameter is optional for Category A devices and conditional for Category + # B devices. # Corresponds to the JSON property `antennaDowntilt` # @return [Fixnum] attr_accessor :antenna_downtilt - # Peak antenna gain in dBi. This parameter is an integer with a - # value between -127 and +128 (dBi) inclusive. + # Peak antenna gain in dBi. This parameter is an integer with a value between - + # 127 and +128 (dBi) inclusive. # Corresponds to the JSON property `antennaGain` # @return [Fixnum] attr_accessor :antenna_gain - # If an external antenna is used, the antenna model is optionally - # provided in this field. The string has a maximum length of 128 - # octets. + # If an external antenna is used, the antenna model is optionally provided in + # this field. The string has a maximum length of 128 octets. # Corresponds to the JSON property `antennaModel` # @return [String] attr_accessor :antenna_model @@ -608,18 +599,17 @@ module Google attr_accessor :cpe_cbsd_indication alias_method :cpe_cbsd_indication?, :cpe_cbsd_indication - # This parameter is the maximum device EIRP in units of dBm/10MHz - # and is an integer with a value between -127 and +47 (dBm/10 MHz) - # inclusive. If not included, SAS interprets it as maximum - # allowable EIRP in units of dBm/10MHz for device category. + # This parameter is the maximum device EIRP in units of dBm/10MHz and is an + # integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not + # included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz + # for device category. # Corresponds to the JSON property `eirpCapability` # @return [Fixnum] attr_accessor :eirp_capability - # Device antenna height in meters. When the heightType parameter - # value is "AGL", the antenna height should be given relative to - # ground level. When the heightType parameter value is "AMSL", it - # is given with respect to WGS84 datum. + # Device antenna height in meters. When the heightType parameter value is "AGL", + # the antenna height should be given relative to ground level. When the + # heightType parameter value is "AMSL", it is given with respect to WGS84 datum. # Corresponds to the JSON property `height` # @return [Float] attr_accessor :height @@ -629,42 +619,37 @@ module Google # @return [String] attr_accessor :height_type - # A positive number in meters to indicate accuracy of the device - # antenna horizontal location. This optional parameter should only - # be present if its value is less than the FCC requirement of 50 - # meters. + # A positive number in meters to indicate accuracy of the device antenna + # horizontal location. This optional parameter should only be present if its + # value is less than the FCC requirement of 50 meters. # Corresponds to the JSON property `horizontalAccuracy` # @return [Float] attr_accessor :horizontal_accuracy - # Whether the device antenna is indoor or not. True: indoor. False: - # outdoor. + # Whether the device antenna is indoor or not. True: indoor. False: outdoor. # Corresponds to the JSON property `indoorDeployment` # @return [Boolean] attr_accessor :indoor_deployment alias_method :indoor_deployment?, :indoor_deployment - # Latitude of the device antenna location in degrees relative to - # the WGS 84 datum. The allowed range is from -90.000000 to - # +90.000000. Positive values represent latitudes north of the - # equator; negative values south of the equator. + # Latitude of the device antenna location in degrees relative to the WGS 84 + # datum. The allowed range is from -90.000000 to +90.000000. Positive values + # represent latitudes north of the equator; negative values south of the equator. # Corresponds to the JSON property `latitude` # @return [Float] attr_accessor :latitude - # Longitude of the device antenna location. in degrees relative to - # the WGS 84 datum. The allowed range is from -180.000000 to - # +180.000000. Positive values represent longitudes east of the - # prime meridian; negative values west of the prime - # meridian. + # Longitude of the device antenna location. in degrees relative to the WGS 84 + # datum. The allowed range is from -180.000000 to +180.000000. Positive values + # represent longitudes east of the prime meridian; negative values west of the + # prime meridian. # Corresponds to the JSON property `longitude` # @return [Float] attr_accessor :longitude - # A positive number in meters to indicate accuracy of the device - # antenna vertical location. This optional parameter should only be - # present if its value is less than the FCC requirement of 3 - # meters. + # A positive number in meters to indicate accuracy of the device antenna + # vertical location. This optional parameter should only be present if its value + # is less than the FCC requirement of 3 meters. # Corresponds to the JSON property `verticalAccuracy` # @return [Float] attr_accessor :vertical_accuracy @@ -696,16 +681,14 @@ module Google class SasPortalListCustomersResponse include Google::Apis::Core::Hashable - # The list of customers that - # match the request. + # The list of customers that match the request. # Corresponds to the JSON property `customers` # @return [Array] attr_accessor :customers # A pagination token returned from a previous call to ListCustomers method that - # indicates from - # where listing should continue. If the field is missing or empty, it means - # there are no more customers. + # indicates from where listing should continue. If the field is missing or empty, + # it means there are no more customers. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -730,9 +713,9 @@ module Google # @return [Array] attr_accessor :devices - # A pagination token returned from a previous call to ListDevices method - # that indicates from where listing should continue. If the field - # is missing or empty, it means there is no more devices. + # A pagination token returned from a previous call to ListDevices method that + # indicates from where listing should continue. If the field is missing or empty, + # it means there is no more devices. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -752,10 +735,9 @@ module Google class SasPortalListNodesResponse include Google::Apis::Core::Hashable - # A pagination token returned from a previous call to - # ListNodes method - # that indicates from where listing should continue. If the field is missing - # or empty, it means there is no more nodes. + # A pagination token returned from a previous call to ListNodes method that + # indicates from where listing should continue. If the field is missing or empty, + # it means there is no more nodes. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -780,8 +762,8 @@ module Google class SasPortalMoveDeviceRequest include Google::Apis::Core::Hashable - # Required. The name of the new parent resource (Node or Customer) to - # reparent the device under. + # Required. The name of the new parent resource (Node or Customer) to reparent + # the device under. # Corresponds to the JSON property `destination` # @return [String] attr_accessor :destination @@ -852,47 +834,45 @@ module Google class SasPortalOperation 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::SasportalV1alpha1::SasPortalStatus] 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 @@ -920,16 +900,14 @@ module Google # @return [Array] attr_accessor :assignments - # The [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 [GetPolicy], and systems are expected to put - # that etag in the request to [SetPolicy] to ensure that their - # change will be applied to the same version of the policy. - # If no [etag] is provided in the call to [SetPolicy], then the - # existing policy is overwritten blindly. + # The [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 [GetPolicy], and systems are expected to put that + # etag in the request to [SetPolicy] to ensure that their change will be applied + # to the same version of the policy. If no [etag] is provided in the call to [ + # SetPolicy], then the existing policy is overwritten blindly. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -976,9 +954,8 @@ module Google class SasPortalSignDeviceRequest include Google::Apis::Core::Hashable - # Required. The device to sign. - # The device fields name, fcc_id and serial_number must be set. - # The user_id field must be set. + # Required. The device to sign. The device fields name, fcc_id and serial_number + # must be set. The user_id field must be set. # Corresponds to the JSON property `device` # @return [Google::Apis::SasportalV1alpha1::SasPortalDevice] attr_accessor :device @@ -993,12 +970,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 SasPortalStatus include Google::Apis::Core::Hashable @@ -1007,15 +984,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 @@ -1080,9 +1057,8 @@ module Google class SasPortalUpdateSignedDeviceRequest include Google::Apis::Core::Hashable - # Required. The JSON Web Token signed using a CPI private key. Payload - # must be the JSON encoding - # of the device. The user_id field must be set. + # Required. The JSON Web Token signed using a CPI private key. Payload must be + # the JSON encoding of the device. The user_id field must be set. # Corresponds to the JSON property `encodedDevice` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1109,14 +1085,14 @@ module Google class SasPortalValidateInstallerRequest include Google::Apis::Core::Hashable - # Required. JSON Web Token signed using a CPI private key. Payload - # must include a "secret" claim whose value is the secret. + # Required. JSON Web Token signed using a CPI private key. Payload must include + # a "secret" claim whose value is the secret. # Corresponds to the JSON property `encodedSecret` # @return [String] attr_accessor :encoded_secret - # Required. Unique installer id (cpiId) from the Certified - # Professional Installers database. + # Required. Unique installer id (cpiId) from the Certified Professional + # Installers database. # Corresponds to the JSON property `installerId` # @return [String] attr_accessor :installer_id @@ -1138,8 +1114,8 @@ module Google end end - # Response for ValidateInstaller method] - # [spectrum.sas.portal.v1alpha1.DeviceManager.ValidateInstaller]. + # Response for ValidateInstaller method] [spectrum.sas.portal.v1alpha1. + # DeviceManager.ValidateInstaller]. class SasPortalValidateInstallerResponse include Google::Apis::Core::Hashable diff --git a/generated/google/apis/sasportal_v1alpha1/service.rb b/generated/google/apis/sasportal_v1alpha1/service.rb index 0cef41909..07ed01447 100644 --- a/generated/google/apis/sasportal_v1alpha1/service.rb +++ b/generated/google/apis/sasportal_v1alpha1/service.rb @@ -79,12 +79,10 @@ module Google # Returns a list of requested customers. # @param [Fixnum] page_size - # The maximum number of customers - # to return in the response. + # The maximum number of customers to return in the response. # @param [String] page_token # A pagination token returned from a previous call to ListCustomers method that - # indicates where - # this listing should continue from. + # indicates where this listing should continue from. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -215,8 +213,7 @@ module Google execute_or_queue_command(command, &block) end - # Creates a signed device under a - # node or customer. + # Creates a signed device under a node or customer. # @param [String] parent # Required. The name of the parent resource. # @param [Google::Apis::SasportalV1alpha1::SasPortalCreateSignedDeviceRequest] sas_portal_create_signed_device_request_object @@ -313,16 +310,15 @@ module Google # @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. + # 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]. + # 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. + # 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 @@ -587,8 +583,8 @@ module Google # @param [Fixnum] page_size # The maximum number of nodes to return in the response. # @param [String] page_token - # A pagination token returned from a previous call to ListNodes method - # that indicates where this listing should continue from. + # A pagination token returned from a previous call to ListNodes method 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 @@ -620,8 +616,7 @@ module Google # Moves a node under another node or customer. # @param [String] name - # Required. The name of the node to - # move. + # Required. The name of the node to move. # @param [Google::Apis::SasportalV1alpha1::SasPortalMoveNodeRequest] sas_portal_move_node_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -727,8 +722,8 @@ module Google # @param [Fixnum] page_size # The maximum number of nodes to return in the response. # @param [String] page_token - # A pagination token returned from a previous call to ListNodes method - # that indicates where this listing should continue from. + # A pagination token returned from a previous call to ListNodes method 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 @@ -914,8 +909,7 @@ module Google execute_or_queue_command(command, &block) end - # Creates a signed device under a - # node or customer. + # Creates a signed device under a node or customer. # @param [String] parent # Required. The name of the parent resource. # @param [Google::Apis::SasportalV1alpha1::SasPortalCreateSignedDeviceRequest] sas_portal_create_signed_device_request_object @@ -1012,16 +1006,15 @@ module Google # @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. + # 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]. + # 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. + # 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 @@ -1286,8 +1279,8 @@ module Google # @param [Fixnum] page_size # The maximum number of nodes to return in the response. # @param [String] page_token - # A pagination token returned from a previous call to ListNodes method - # that indicates where this listing should continue from. + # A pagination token returned from a previous call to ListNodes method 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 @@ -1319,8 +1312,7 @@ module Google # Moves a node under another node or customer. # @param [String] name - # Required. The name of the node to - # move. + # Required. The name of the node to move. # @param [Google::Apis::SasportalV1alpha1::SasPortalMoveNodeRequest] sas_portal_move_node_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1453,8 +1445,7 @@ module Google execute_or_queue_command(command, &block) end - # Creates a signed device under a - # node or customer. + # Creates a signed device under a node or customer. # @param [String] parent # Required. The name of the parent resource. # @param [Google::Apis::SasportalV1alpha1::SasPortalCreateSignedDeviceRequest] sas_portal_create_signed_device_request_object @@ -1491,16 +1482,15 @@ module Google # @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. + # 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]. + # 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. + # 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 @@ -1570,8 +1560,8 @@ module Google # @param [Fixnum] page_size # The maximum number of nodes to return in the response. # @param [String] page_token - # A pagination token returned from a previous call to ListNodes method - # that indicates where this listing should continue from. + # A pagination token returned from a previous call to ListNodes method 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 @@ -1601,9 +1591,8 @@ 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. + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. # @param [Google::Apis::SasportalV1alpha1::SasPortalGetPolicyRequest] sas_portal_get_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/securitycenter_v1.rb b/generated/google/apis/securitycenter_v1.rb index 682c2d4d7..4183cb22a 100644 --- a/generated/google/apis/securitycenter_v1.rb +++ b/generated/google/apis/securitycenter_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview module SecuritycenterV1 VERSION = 'V1' - REVISION = '20200619' + REVISION = '20200731' # 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/securitycenter_v1/classes.rb b/generated/google/apis/securitycenter_v1/classes.rb index b9623c0db..d66374372 100644 --- a/generated/google/apis/securitycenter_v1/classes.rb +++ b/generated/google/apis/securitycenter_v1/classes.rb @@ -22,12 +22,11 @@ module Google module Apis module SecuritycenterV1 - # Security Command Center representation of a Google Cloud - # resource. - # The Asset is a Security Command Center resource that captures information - # about a single Google Cloud resource. All modifications to an Asset are only - # within the context of Security Command Center and don't affect the referenced - # Google Cloud resource. + # Security Command Center representation of a Google Cloud resource. The Asset + # is a Security Command Center resource that captures information about a single + # Google Cloud resource. All modifications to an Asset are only within the + # context of Security Command Center and don't affect the referenced Google + # Cloud resource. class Asset include Google::Apis::Core::Hashable @@ -38,22 +37,20 @@ module Google # Cloud IAM Policy information associated with the Google Cloud resource # described by the Security Command Center asset. This information is managed - # and defined by the Google Cloud resource and cannot be modified by the - # user. + # and defined by the Google Cloud resource and cannot be modified by the user. # Corresponds to the JSON property `iamPolicy` # @return [Google::Apis::SecuritycenterV1::IamPolicy] attr_accessor :iam_policy - # The relative resource name of this asset. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/assets/`asset_id`". + # The relative resource name of this asset. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/assets/`asset_id`". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Resource managed properties. These properties are managed and defined by - # the Google Cloud resource and cannot be modified by the user. + # Resource managed properties. These properties are managed and defined by the + # Google Cloud resource and cannot be modified by the user. # Corresponds to the JSON property `resourceProperties` # @return [Hash] attr_accessor :resource_properties @@ -64,10 +61,10 @@ module Google # @return [Google::Apis::SecuritycenterV1::SecurityCenterProperties] attr_accessor :security_center_properties - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1::SecurityMarks] attr_accessor :security_marks @@ -119,53 +116,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 @@ -174,9 +139,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 @@ -192,28 +157,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] @@ -239,69 +191,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::SecuritycenterV1::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 @@ -318,13 +258,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 @@ -337,52 +275,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 @@ -400,18 +329,16 @@ module Google end end - # Security Command Center finding. - # A finding is a record of assessment data like security, risk, health, or - # privacy, that is ingested into Security Command Center for presentation, - # notification, analysis, policy testing, and enforcement. For example, a - # cross-site scripting (XSS) vulnerability in an App Engine application is a - # finding. + # Security Command Center finding. A finding is a record of assessment data like + # security, risk, health, or privacy, that is ingested into Security Command + # Center for presentation, notification, analysis, policy testing, and + # enforcement. For example, a cross-site scripting (XSS) vulnerability in an App + # Engine application is a finding. class Finding include Google::Apis::Core::Hashable - # The additional taxonomy group within findings from a given source. - # This field is immutable after creation time. - # Example: "XSS_FLASH_INJECTION" + # The additional taxonomy group within findings from a given source. This field + # is immutable after creation time. Example: "XSS_FLASH_INJECTION" # Corresponds to the JSON property `category` # @return [String] attr_accessor :category @@ -421,59 +348,56 @@ module Google # @return [String] attr_accessor :create_time - # The time at which the event took place. For example, if the finding - # represents an open firewall it would capture the time the detector believes - # the firewall became open. The accuracy is determined by the detector. + # The time at which the event took place. For example, if the finding represents + # an open firewall it would capture the time the detector believes the firewall + # became open. The accuracy is determined by the detector. # Corresponds to the JSON property `eventTime` # @return [String] attr_accessor :event_time - # The URI that, if available, points to a web page outside of Security - # Command Center where additional information about the finding can be found. - # This field is guaranteed to be either empty or a well formed URL. + # The URI that, if available, points to a web page outside of Security Command + # Center where additional information about the finding can be found. This field + # is guaranteed to be either empty or a well formed URL. # Corresponds to the JSON property `externalUri` # @return [String] attr_accessor :external_uri - # The relative resource name of this finding. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`" + # The relative resource name of this finding. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`" # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The relative resource name of the source the finding belongs to. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # This field is immutable after creation time. - # For example: - # "organizations/`organization_id`/sources/`source_id`" + # The relative resource name of the source the finding belongs to. See: https:// + # cloud.google.com/apis/design/resource_names#relative_resource_name This field + # is immutable after creation time. For example: "organizations/`organization_id` + # /sources/`source_id`" # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # For findings on Google Cloud resources, the full resource - # name of the Google Cloud resource this finding is for. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name - # When the finding is for a non-Google Cloud resource, the resourceName can - # be a customer or partner defined string. This field is immutable after - # creation time. + # For findings on Google Cloud resources, the full resource name of the Google + # Cloud resource this finding is for. See: https://cloud.google.com/apis/design/ + # resource_names#full_resource_name When the finding is for a non-Google Cloud + # resource, the resourceName can be a customer or partner defined string. This + # field is immutable after creation time. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1::SecurityMarks] attr_accessor :security_marks - # Source specific properties. These properties are managed by the source - # that writes the finding. The key names in the source_properties map must be - # between 1 and 255 characters, and must start with a letter and contain - # alphanumeric characters or underscores only. + # Source specific properties. These properties are managed by the source that + # writes the finding. The key names in the source_properties map must be between + # 1 and 255 characters, and must start with a letter and contain alphanumeric + # characters or underscores only. # Corresponds to the JSON property `sourceProperties` # @return [Hash] attr_accessor :source_properties @@ -525,15 +449,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 @@ -552,12 +474,11 @@ module Google class GoogleCloudSecuritycenterV1NotificationMessage include Google::Apis::Core::Hashable - # Security Command Center finding. - # A finding is a record of assessment data like security, risk, health, or - # privacy, that is ingested into Security Command Center for presentation, - # notification, analysis, policy testing, and enforcement. For example, a - # cross-site scripting (XSS) vulnerability in an App Engine application is a - # finding. + # Security Command Center finding. A finding is a record of assessment data like + # security, risk, health, or privacy, that is ingested into Security Command + # Center for presentation, notification, analysis, policy testing, and + # enforcement. For example, a cross-site scripting (XSS) vulnerability in an App + # Engine application is a finding. # Corresponds to the JSON property `finding` # @return [Google::Apis::SecuritycenterV1::Finding] attr_accessor :finding @@ -588,8 +509,8 @@ module Google class GoogleCloudSecuritycenterV1Resource include Google::Apis::Core::Hashable - # The full resource name of the resource. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the resource. See: https://cloud.google.com/apis/ + # design/resource_names#full_resource_name # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -678,12 +599,11 @@ module Google end end - # Security Command Center representation of a Google Cloud - # resource. - # The Asset is a Security Command Center resource that captures information - # about a single Google Cloud resource. All modifications to an Asset are only - # within the context of Security Command Center and don't affect the referenced - # Google Cloud resource. + # Security Command Center representation of a Google Cloud resource. The Asset + # is a Security Command Center resource that captures information about a single + # Google Cloud resource. All modifications to an Asset are only within the + # context of Security Command Center and don't affect the referenced Google + # Cloud resource. class GoogleCloudSecuritycenterV1p1beta1Asset include Google::Apis::Core::Hashable @@ -694,22 +614,20 @@ module Google # Cloud IAM Policy information associated with the Google Cloud resource # described by the Security Command Center asset. This information is managed - # and defined by the Google Cloud resource and cannot be modified by the - # user. + # and defined by the Google Cloud resource and cannot be modified by the user. # Corresponds to the JSON property `iamPolicy` # @return [Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1p1beta1IamPolicy] attr_accessor :iam_policy - # The relative resource name of this asset. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/assets/`asset_id`". + # The relative resource name of this asset. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/assets/`asset_id`". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Resource managed properties. These properties are managed and defined by - # the Google Cloud resource and cannot be modified by the user. + # Resource managed properties. These properties are managed and defined by the + # Google Cloud resource and cannot be modified by the user. # Corresponds to the JSON property `resourceProperties` # @return [Hash] attr_accessor :resource_properties @@ -720,16 +638,15 @@ module Google # @return [Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties] attr_accessor :security_center_properties - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] attr_accessor :security_marks - # The time at which the asset was last updated, added, or deleted in Cloud - # SCC. + # The time at which the asset was last updated, added, or deleted in Cloud SCC. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -750,17 +667,15 @@ module Google end end - # Security Command Center finding. - # A finding is a record of assessment data (security, risk, health or privacy) - # ingested into Security Command Center for presentation, notification, - # analysis, policy testing, and enforcement. For example, an XSS vulnerability - # in an App Engine application is a finding. + # Security Command Center finding. A finding is a record of assessment data ( + # security, risk, health or privacy) ingested into Security Command Center for + # presentation, notification, analysis, policy testing, and enforcement. For + # example, an XSS vulnerability in an App Engine application is a finding. class GoogleCloudSecuritycenterV1p1beta1Finding include Google::Apis::Core::Hashable - # The additional taxonomy group within findings from a given source. - # This field is immutable after creation time. - # Example: "XSS_FLASH_INJECTION" + # The additional taxonomy group within findings from a given source. This field + # is immutable after creation time. Example: "XSS_FLASH_INJECTION" # Corresponds to the JSON property `category` # @return [String] attr_accessor :category @@ -770,59 +685,56 @@ module Google # @return [String] attr_accessor :create_time - # The time at which the event took place. For example, if the finding - # represents an open firewall it would capture the time the detector believes - # the firewall became open. The accuracy is determined by the detector. + # The time at which the event took place. For example, if the finding represents + # an open firewall it would capture the time the detector believes the firewall + # became open. The accuracy is determined by the detector. # Corresponds to the JSON property `eventTime` # @return [String] attr_accessor :event_time - # The URI that, if available, points to a web page outside of Security - # Command Center where additional information about the finding can be found. - # This field is guaranteed to be either empty or a well formed URL. + # The URI that, if available, points to a web page outside of Security Command + # Center where additional information about the finding can be found. This field + # is guaranteed to be either empty or a well formed URL. # Corresponds to the JSON property `externalUri` # @return [String] attr_accessor :external_uri - # The relative resource name of this finding. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`" + # The relative resource name of this finding. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`" # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The relative resource name of the source the finding belongs to. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # This field is immutable after creation time. - # For example: - # "organizations/`organization_id`/sources/`source_id`" + # The relative resource name of the source the finding belongs to. See: https:// + # cloud.google.com/apis/design/resource_names#relative_resource_name This field + # is immutable after creation time. For example: "organizations/`organization_id` + # /sources/`source_id`" # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # For findings on Google Cloud resources, the full resource - # name of the Google Cloud resource this finding is for. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name - # When the finding is for a non-Google Cloud resource, the resourceName can - # be a customer or partner defined string. This field is immutable after - # creation time. + # For findings on Google Cloud resources, the full resource name of the Google + # Cloud resource this finding is for. See: https://cloud.google.com/apis/design/ + # resource_names#full_resource_name When the finding is for a non-Google Cloud + # resource, the resourceName can be a customer or partner defined string. This + # field is immutable after creation time. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] attr_accessor :security_marks - # Source specific properties. These properties are managed by the source - # that writes the finding. The key names in the source_properties map must be - # between 1 and 255 characters, and must start with a letter and contain - # alphanumeric characters or underscores only. + # Source specific properties. These properties are managed by the source that + # writes the finding. The key names in the source_properties map must be between + # 1 and 255 characters, and must start with a letter and contain alphanumeric + # characters or underscores only. # Corresponds to the JSON property `sourceProperties` # @return [Hash] attr_accessor :source_properties @@ -853,14 +765,12 @@ module Google # Cloud IAM Policy information associated with the Google Cloud resource # described by the Security Command Center asset. This information is managed - # and defined by the Google Cloud resource and cannot be modified by the - # user. + # and defined by the Google Cloud resource and cannot be modified by the user. class GoogleCloudSecuritycenterV1p1beta1IamPolicy include Google::Apis::Core::Hashable - # The JSON representation of the Policy associated with the asset. - # See https://cloud.google.com/iam/docs/reference/rest/v1/Policy for - # format details. + # The JSON representation of the Policy associated with the asset. See https:// + # cloud.google.com/iam/docs/reference/rest/v1/Policy for format details. # Corresponds to the JSON property `policyBlob` # @return [String] attr_accessor :policy_blob @@ -879,11 +789,10 @@ module Google class GoogleCloudSecuritycenterV1p1beta1NotificationMessage include Google::Apis::Core::Hashable - # Security Command Center finding. - # A finding is a record of assessment data (security, risk, health or privacy) - # ingested into Security Command Center for presentation, notification, - # analysis, policy testing, and enforcement. For example, an XSS vulnerability - # in an App Engine application is a finding. + # Security Command Center finding. A finding is a record of assessment data ( + # security, risk, health or privacy) ingested into Security Command Center for + # presentation, notification, analysis, policy testing, and enforcement. For + # example, an XSS vulnerability in an App Engine application is a finding. # Corresponds to the JSON property `finding` # @return [Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1p1beta1Finding] attr_accessor :finding @@ -898,8 +807,8 @@ module Google # @return [Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1p1beta1Resource] attr_accessor :resource - # Wrapper over asset object that also captures the state change for the asset - # e.g. if it was a newly created asset vs updated or deleted asset. + # Wrapper over asset object that also captures the state change for the asset e. + # g. if it was a newly created asset vs updated or deleted asset. # Corresponds to the JSON property `temporalAsset` # @return [Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1p1beta1TemporalAsset] attr_accessor :temporal_asset @@ -921,8 +830,8 @@ module Google class GoogleCloudSecuritycenterV1p1beta1Resource include Google::Apis::Core::Hashable - # The full resource name of the resource. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the resource. See: https://cloud.google.com/apis/ + # design/resource_names#full_resource_name # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -996,9 +905,9 @@ module Google # @return [String] attr_accessor :resource_display_name - # The full resource name of the Google Cloud resource this asset - # represents. This field is immutable after create time. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the Google Cloud resource this asset represents. + # This field is immutable after create time. See: https://cloud.google.com/apis/ + # design/resource_names#full_resource_name # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name @@ -1008,8 +917,8 @@ module Google # @return [Array] attr_accessor :resource_owners - # The full resource name of the immediate parent of the resource. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the immediate parent of the resource. See: https:// + # cloud.google.com/apis/design/resource_names#full_resource_name # Corresponds to the JSON property `resourceParent` # @return [String] attr_accessor :resource_parent @@ -1019,8 +928,8 @@ module Google # @return [String] attr_accessor :resource_parent_display_name - # The full resource name of the project the resource belongs to. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the project the resource belongs to. See: https:// + # cloud.google.com/apis/design/resource_names#full_resource_name # Corresponds to the JSON property `resourceProject` # @return [String] attr_accessor :resource_project @@ -1030,10 +939,9 @@ module Google # @return [String] attr_accessor :resource_project_display_name - # The type of the Google Cloud resource. Examples include: APPLICATION, - # PROJECT, and ORGANIZATION. This is a case insensitive field defined by - # Security Command Center and/or the producer of the resource and is - # immutable after create time. + # The type of the Google Cloud resource. Examples include: APPLICATION, PROJECT, + # and ORGANIZATION. This is a case insensitive field defined by Security Command + # Center and/or the producer of the resource and is immutable after create time. # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type @@ -1055,30 +963,26 @@ module Google end end - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. class GoogleCloudSecuritycenterV1p1beta1SecurityMarks include Google::Apis::Core::Hashable # Mutable user specified security marks belonging to the parent resource. - # Constraints are as follows: - # * Keys and values are treated as case insensitive - # * Keys must be between 1 - 256 characters (inclusive) - # * Keys must be letters, numbers, underscores, or dashes - # * Values have leading and trailing whitespace trimmed, remaining - # characters must be between 1 - 4096 characters (inclusive) + # Constraints are as follows: * Keys and values are treated as case insensitive * + # Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, + # numbers, underscores, or dashes * Values have leading and trailing whitespace + # trimmed, remaining characters must be between 1 - 4096 characters (inclusive) # Corresponds to the JSON property `marks` # @return [Hash] attr_accessor :marks - # The relative resource name of the SecurityMarks. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Examples: - # "organizations/`organization_id`/assets/`asset_id`/securityMarks" - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/ - # securityMarks". + # The relative resource name of the SecurityMarks. See: https://cloud.google.com/ + # apis/design/resource_names#relative_resource_name Examples: "organizations/` + # organization_id`/assets/`asset_id`/securityMarks" "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1094,17 +998,16 @@ module Google end end - # Wrapper over asset object that also captures the state change for the asset - # e.g. if it was a newly created asset vs updated or deleted asset. + # Wrapper over asset object that also captures the state change for the asset e. + # g. if it was a newly created asset vs updated or deleted asset. class GoogleCloudSecuritycenterV1p1beta1TemporalAsset include Google::Apis::Core::Hashable - # Security Command Center representation of a Google Cloud - # resource. - # The Asset is a Security Command Center resource that captures information - # about a single Google Cloud resource. All modifications to an Asset are only - # within the context of Security Command Center and don't affect the referenced - # Google Cloud resource. + # Security Command Center representation of a Google Cloud resource. The Asset + # is a Security Command Center resource that captures information about a single + # Google Cloud resource. All modifications to an Asset are only within the + # context of Security Command Center and don't affect the referenced Google + # Cloud resource. # Corresponds to the JSON property `asset` # @return [Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1p1beta1Asset] attr_accessor :asset @@ -1130,119 +1033,93 @@ module Google include Google::Apis::Core::Hashable # When compare_duration is set, the GroupResult's "state_change" property is - # updated to indicate whether the asset was added, removed, or remained - # present during the compare_duration period of time that precedes the - # read_time. This is the time between (read_time - compare_duration) and - # read_time. - # The state change value is derived based on the presence of the asset at the - # two points in time. Intermediate state changes between the two times don't - # affect the result. For example, the results aren't affected if the asset is - # removed and re-created again. - # Possible "state_change" values when compare_duration is specified: - # * "ADDED": indicates that the asset was not present at the start of - # compare_duration, but present at reference_time. - # * "REMOVED": indicates that the asset was present at the start of - # compare_duration, but not present at reference_time. - # * "ACTIVE": indicates that the asset was present at both the - # start and the end of the time period defined by - # compare_duration and reference_time. - # If compare_duration is not specified, then the only possible state_change - # is "UNUSED", which will be the state_change set for all assets present at - # read_time. - # If this field is set then `state_change` must be a specified field in - # `group_by`. + # updated to indicate whether the asset was added, removed, or remained present + # during the compare_duration period of time that precedes the read_time. This + # is the time between (read_time - compare_duration) and read_time. The state + # change value is derived based on the presence of the asset at the two points + # in time. Intermediate state changes between the two times don't affect the + # result. For example, the results aren't affected if the asset is removed and + # re-created again. Possible "state_change" values when compare_duration is + # specified: * "ADDED": indicates that the asset was not present at the start of + # compare_duration, but present at reference_time. * "REMOVED": indicates that + # the asset was present at the start of compare_duration, but not present at + # reference_time. * "ACTIVE": indicates that the asset was present at both the + # start and the end of the time period defined by compare_duration and + # reference_time. If compare_duration is not specified, then the only possible + # state_change is "UNUSED", which will be the state_change set for all assets + # present at read_time. If this field is set then `state_change` must be a + # specified field in `group_by`. # Corresponds to the JSON property `compareDuration` # @return [String] attr_accessor :compare_duration - # Expression that defines the filter to apply across assets. - # The expression is a list of zero or more restrictions combined via logical - # operators `AND` and `OR`. - # Parentheses are supported, and `OR` has higher precedence than `AND`. - # Restrictions have the form ` ` and may have a `-` - # character in front of them to indicate negation. The fields map to those - # defined in the Asset resource. Examples include: - # * name - # * security_center_properties.resource_name - # * resource_properties.a_property - # * security_marks.marks.marka - # The supported operators are: - # * `=` for all value types. - # * `>`, `<`, `>=`, `<=` for integer values. - # * `:`, meaning substring matching, for strings. - # The supported value types are: - # * string literals in quotes. - # * integer literals without quotes. - # * boolean literals `true` and `false` without quotes. - # The following field and operator combinations are supported: - # * name: `=` - # * update_time: `=`, `>`, `<`, `>=`, `<=` - # Usage: This should be milliseconds since epoch or an RFC3339 string. - # Examples: - # `update_time = "2019-06-10T16:07:18-07:00"` - # `update_time = 1560208038000` - # * create_time: `=`, `>`, `<`, `>=`, `<=` - # Usage: This should be milliseconds since epoch or an RFC3339 string. - # Examples: - # `create_time = "2019-06-10T16:07:18-07:00"` - # `create_time = 1560208038000` - # * iam_policy.policy_blob: `=`, `:` - # * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` - # * security_marks.marks: `=`, `:` - # * security_center_properties.resource_name: `=`, `:` - # * security_center_properties.resource_display_name: `=`, `:` - # * security_center_properties.resource_type: `=`, `:` - # * security_center_properties.resource_parent: `=`, `:` - # * security_center_properties.resource_parent_display_name: `=`, `:` - # * security_center_properties.resource_project: `=`, `:` - # * security_center_properties.resource_project_display_name: `=`, `:` - # * security_center_properties.resource_owners: `=`, `:` - # For example, `resource_properties.size = 100` is a valid filter string. - # Use a partial match on the empty string to filter based on a property - # existing: `resource_properties.my_property : ""` - # Use a negated partial match on the empty string to filter based on a - # property not existing: `-resource_properties.my_property : ""` + # Expression that defines the filter to apply across assets. The expression is a + # list of zero or more restrictions combined via logical operators `AND` and `OR` + # . Parentheses are supported, and `OR` has higher precedence than `AND`. + # Restrictions have the form ` ` and may have a `-` character in front of them + # to indicate negation. The fields map to those defined in the Asset resource. + # Examples include: * name * security_center_properties.resource_name * + # resource_properties.a_property * security_marks.marks.marka The supported + # operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer + # values. * `:`, meaning substring matching, for strings. The supported value + # types are: * string literals in quotes. * integer literals without quotes. * + # boolean literals `true` and `false` without quotes. The following field and + # operator combinations are supported: * name: `=` * update_time: `=`, `>`, `<`, + # `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. + # Examples: `update_time = "2019-06-10T16:07:18-07:00"` `update_time = + # 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be + # milliseconds since epoch or an RFC3339 string. Examples: `create_time = "2019- + # 06-10T16:07:18-07:00"` `create_time = 1560208038000` * iam_policy.policy_blob: + # `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * + # security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, + # `:` * security_center_properties.resource_display_name: `=`, `:` * + # security_center_properties.resource_type: `=`, `:` * + # security_center_properties.resource_parent: `=`, `:` * + # security_center_properties.resource_parent_display_name: `=`, `:` * + # security_center_properties.resource_project: `=`, `:` * + # security_center_properties.resource_project_display_name: `=`, `:` * + # security_center_properties.resource_owners: `=`, `:` For example, ` + # resource_properties.size = 100` is a valid filter string. Use a partial match + # on the empty string to filter based on a property existing: ` + # resource_properties.my_property : ""` Use a negated partial match on the empty + # string to filter based on a property not existing: `-resource_properties. + # my_property : ""` # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter # Required. Expression that defines what assets fields to use for grouping. The - # string - # value should follow SQL syntax: comma separated list of fields. For - # example: - # "security_center_properties.resource_project,security_center_properties. - # project". - # The following fields are supported when compare_duration is not set: - # * security_center_properties.resource_project - # * security_center_properties.resource_project_display_name - # * security_center_properties.resource_type - # * security_center_properties.resource_parent - # * security_center_properties.resource_parent_display_name - # The following fields are supported when compare_duration is set: - # * security_center_properties.resource_type - # * security_center_properties.resource_project_display_name - # * security_center_properties.resource_parent_display_name + # string value should follow SQL syntax: comma separated list of fields. For + # example: "security_center_properties.resource_project, + # security_center_properties.project". The following fields are supported when + # compare_duration is not set: * security_center_properties.resource_project * + # security_center_properties.resource_project_display_name * + # security_center_properties.resource_type * security_center_properties. + # resource_parent * security_center_properties.resource_parent_display_name The + # following fields are supported when compare_duration is set: * + # security_center_properties.resource_type * security_center_properties. + # resource_project_display_name * security_center_properties. + # resource_parent_display_name # Corresponds to the JSON property `groupBy` # @return [String] attr_accessor :group_by - # The maximum number of results to return in a single response. Default is - # 10, minimum is 1, maximum is 1000. + # The maximum number of results to return in a single response. Default is 10, + # minimum is 1, maximum is 1000. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size - # The value returned by the last `GroupAssetsResponse`; indicates - # that this is a continuation of a prior `GroupAssets` call, and that the - # system should return the next page of data. + # The value returned by the last `GroupAssetsResponse`; indicates that this is a + # continuation of a prior `GroupAssets` call, and that the system should return + # the next page of data. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token - # Time used as a reference point when filtering assets. The filter is limited - # to assets existing at the supplied time and their values are those at that - # specific time. Absence of this field will default to the API's version of - # NOW. + # Time used as a reference point when filtering assets. The filter is limited to + # assets existing at the supplied time and their values are those at that + # specific time. Absence of this field will default to the API's version of NOW. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -1266,9 +1143,9 @@ module Google class GroupAssetsResponse include Google::Apis::Core::Hashable - # Group results. There exists an element for each existing unique - # combination of property/values. The element contains a count for the number - # of times those specific property/values appear. + # Group results. There exists an element for each existing unique combination of + # property/values. The element contains a count for the number of times those + # specific property/values appear. # Corresponds to the JSON property `groupByResults` # @return [Array] attr_accessor :group_by_results @@ -1307,108 +1184,79 @@ module Google include Google::Apis::Core::Hashable # When compare_duration is set, the GroupResult's "state_change" attribute is - # updated to indicate whether the finding had its state changed, the - # finding's state remained unchanged, or if the finding was added during the - # compare_duration period of time that precedes the read_time. This is the - # time between (read_time - compare_duration) and read_time. - # The state_change value is derived based on the presence and state of the - # finding at the two points in time. Intermediate state changes between the - # two times don't affect the result. For example, the results aren't affected - # if the finding is made inactive and then active again. - # Possible "state_change" values when compare_duration is specified: - # * "CHANGED": indicates that the finding was present and matched the given - # filter at the start of compare_duration, but changed its - # state at read_time. - # * "UNCHANGED": indicates that the finding was present and matched the given - # filter at the start of compare_duration and did not change - # state at read_time. - # * "ADDED": indicates that the finding did not match the given filter or - # was not present at the start of compare_duration, but was - # present at read_time. - # * "REMOVED": indicates that the finding was present and matched the - # filter at the start of compare_duration, but did not match - # the filter at read_time. - # If compare_duration is not specified, then the only possible state_change - # is "UNUSED", which will be the state_change set for all findings present - # at read_time. - # If this field is set then `state_change` must be a specified field in - # `group_by`. + # updated to indicate whether the finding had its state changed, the finding's + # state remained unchanged, or if the finding was added during the + # compare_duration period of time that precedes the read_time. This is the time + # between (read_time - compare_duration) and read_time. The state_change value + # is derived based on the presence and state of the finding at the two points in + # time. Intermediate state changes between the two times don't affect the result. + # For example, the results aren't affected if the finding is made inactive and + # then active again. Possible "state_change" values when compare_duration is + # specified: * "CHANGED": indicates that the finding was present and matched the + # given filter at the start of compare_duration, but changed its state at + # read_time. * "UNCHANGED": indicates that the finding was present and matched + # the given filter at the start of compare_duration and did not change state at + # read_time. * "ADDED": indicates that the finding did not match the given + # filter or was not present at the start of compare_duration, but was present at + # read_time. * "REMOVED": indicates that the finding was present and matched the + # filter at the start of compare_duration, but did not match the filter at + # read_time. If compare_duration is not specified, then the only possible + # state_change is "UNUSED", which will be the state_change set for all findings + # present at read_time. If this field is set then `state_change` must be a + # specified field in `group_by`. # Corresponds to the JSON property `compareDuration` # @return [String] attr_accessor :compare_duration - # Expression that defines the filter to apply across findings. - # The expression is a list of one or more restrictions combined via logical - # operators `AND` and `OR`. - # Parentheses are supported, and `OR` has higher precedence than `AND`. - # Restrictions have the form ` ` and may have a `-` - # character in front of them to indicate negation. Examples include: - # * name - # * source_properties.a_property - # * security_marks.marks.marka - # The supported operators are: - # * `=` for all value types. - # * `>`, `<`, `>=`, `<=` for integer values. - # * `:`, meaning substring matching, for strings. - # The supported value types are: - # * string literals in quotes. - # * integer literals without quotes. - # * boolean literals `true` and `false` without quotes. - # The following field and operator combinations are supported: - # * name: `=` - # * parent: `=`, `:` - # * resource_name: `=`, `:` - # * state: `=`, `:` - # * category: `=`, `:` - # * external_uri: `=`, `:` - # * event_time: `=`, `>`, `<`, `>=`, `<=` - # Usage: This should be milliseconds since epoch or an RFC3339 string. - # Examples: - # `event_time = "2019-06-10T16:07:18-07:00"` - # `event_time = 1560208038000` - # * security_marks.marks: `=`, `:` - # * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` - # For example, `source_properties.size = 100` is a valid filter string. - # Use a partial match on the empty string to filter based on a property - # existing: `source_properties.my_property : ""` - # Use a negated partial match on the empty string to filter based on a - # property not existing: `-source_properties.my_property : ""` + # Expression that defines the filter to apply across findings. The expression is + # a list of one or more restrictions combined via logical operators `AND` and ` + # OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. + # Restrictions have the form ` ` and may have a `-` character in front of them + # to indicate negation. Examples include: * name * source_properties.a_property * + # security_marks.marks.marka The supported operators are: * `=` for all value + # types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring + # matching, for strings. The supported value types are: * string literals in + # quotes. * integer literals without quotes. * boolean literals `true` and ` + # false` without quotes. The following field and operator combinations are + # supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `= + # `, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `< + # `, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 + # string. Examples: `event_time = "2019-06-10T16:07:18-07:00"` `event_time = + # 1560208038000` * security_marks.marks: `=`, `:` * source_properties: `=`, `:`, + # `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid + # filter string. Use a partial match on the empty string to filter based on a + # property existing: `source_properties.my_property : ""` Use a negated partial + # match on the empty string to filter based on a property not existing: `- + # source_properties.my_property : ""` # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter # Required. Expression that defines what assets fields to use for grouping ( - # including - # `state_change`). The string value should follow SQL syntax: comma separated - # list of fields. For example: "parent,resource_name". - # The following fields are supported: - # * resource_name - # * category - # * state - # * parent - # The following fields are supported when compare_duration is set: - # * state_change + # including `state_change`). The string value should follow SQL syntax: comma + # separated list of fields. For example: "parent,resource_name". The following + # fields are supported: * resource_name * category * state * parent The + # following fields are supported when compare_duration is set: * state_change # Corresponds to the JSON property `groupBy` # @return [String] attr_accessor :group_by - # The maximum number of results to return in a single response. Default is - # 10, minimum is 1, maximum is 1000. + # The maximum number of results to return in a single response. Default is 10, + # minimum is 1, maximum is 1000. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size - # The value returned by the last `GroupFindingsResponse`; indicates - # that this is a continuation of a prior `GroupFindings` call, and - # that the system should return the next page of data. + # The value returned by the last `GroupFindingsResponse`; indicates that this is + # a continuation of a prior `GroupFindings` call, and that the system should + # return the next page of data. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token - # Time used as a reference point when filtering findings. The filter is - # limited to findings existing at the supplied time and their values are - # those at that specific time. Absence of this field will default to the - # API's version of NOW. + # Time used as a reference point when filtering findings. The filter is limited + # to findings existing at the supplied time and their values are those at that + # specific time. Absence of this field will default to the API's version of NOW. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -1432,9 +1280,9 @@ module Google class GroupFindingsResponse include Google::Apis::Core::Hashable - # Group results. There exists an element for each existing unique - # combination of property/values. The element contains a count for the number - # of times those specific property/values appear. + # Group results. There exists an element for each existing unique combination of + # property/values. The element contains a count for the number of times those + # specific property/values appear. # Corresponds to the JSON property `groupByResults` # @return [Array] attr_accessor :group_by_results @@ -1495,14 +1343,12 @@ module Google # Cloud IAM Policy information associated with the Google Cloud resource # described by the Security Command Center asset. This information is managed - # and defined by the Google Cloud resource and cannot be modified by the - # user. + # and defined by the Google Cloud resource and cannot be modified by the user. class IamPolicy include Google::Apis::Core::Hashable - # The JSON representation of the Policy associated with the asset. - # See https://cloud.google.com/iam/reference/rest/v1/Policy for format - # details. + # The JSON representation of the Policy associated with the asset. See https:// + # cloud.google.com/iam/reference/rest/v1/Policy for format details. # Corresponds to the JSON property `policyBlob` # @return [String] attr_accessor :policy_blob @@ -1559,12 +1405,11 @@ module Google class ListAssetsResult include Google::Apis::Core::Hashable - # Security Command Center representation of a Google Cloud - # resource. - # The Asset is a Security Command Center resource that captures information - # about a single Google Cloud resource. All modifications to an Asset are only - # within the context of Security Command Center and don't affect the referenced - # Google Cloud resource. + # Security Command Center representation of a Google Cloud resource. The Asset + # is a Security Command Center resource that captures information about a single + # Google Cloud resource. All modifications to an Asset are only within the + # context of Security Command Center and don't affect the referenced Google + # Cloud resource. # Corresponds to the JSON property `asset` # @return [Google::Apis::SecuritycenterV1::Asset] attr_accessor :asset @@ -1627,18 +1472,17 @@ module Google class ListFindingsResult include Google::Apis::Core::Hashable - # Security Command Center finding. - # A finding is a record of assessment data like security, risk, health, or - # privacy, that is ingested into Security Command Center for presentation, - # notification, analysis, policy testing, and enforcement. For example, a - # cross-site scripting (XSS) vulnerability in an App Engine application is a - # finding. + # Security Command Center finding. A finding is a record of assessment data like + # security, risk, health, or privacy, that is ingested into Security Command + # Center for presentation, notification, analysis, policy testing, and + # enforcement. For example, a cross-site scripting (XSS) vulnerability in an App + # Engine application is a finding. # Corresponds to the JSON property `finding` # @return [Google::Apis::SecuritycenterV1::Finding] attr_accessor :finding - # Information related to the Google Cloud resource that is - # associated with this finding. + # Information related to the Google Cloud resource that is associated with this + # finding. LINT.IfChange # Corresponds to the JSON property `resource` # @return [Google::Apis::SecuritycenterV1::Resource] attr_accessor :resource @@ -1737,9 +1581,9 @@ module Google end end - # Cloud Security Command Center (Cloud SCC) notification configs. - # A notification config is a Cloud SCC resource that contains the configuration - # to send notifications for create/update events of findings, assets and etc. + # Cloud Security Command Center (Cloud SCC) notification configs. A notification + # config is a Cloud SCC resource that contains the configuration to send + # notifications for create/update events of findings, assets and etc. class NotificationConfig include Google::Apis::Core::Hashable @@ -1748,28 +1592,27 @@ module Google # @return [String] attr_accessor :description - # The relative resource name of this notification config. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/notificationConfigs/notify_public_bucket". + # The relative resource name of this notification config. See: https://cloud. + # google.com/apis/design/resource_names#relative_resource_name Example: " + # organizations/`organization_id`/notificationConfigs/notify_public_bucket". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The PubSub topic to send notifications to. Its format is - # "projects/[project_id]/topics/[topic]". + # The PubSub topic to send notifications to. Its format is "projects/[project_id] + # /topics/[topic]". # Corresponds to the JSON property `pubsubTopic` # @return [String] attr_accessor :pubsub_topic - # Output only. The service account that needs "pubsub.topics.publish" - # permission to publish to the PubSub topic. + # Output only. The service account that needs "pubsub.topics.publish" permission + # to publish to the PubSub topic. # Corresponds to the JSON property `serviceAccount` # @return [String] attr_accessor :service_account - # The config for streaming-based notifications, which send each event as soon - # as it is detected. + # The config for streaming-based notifications, which send each event as soon as + # it is detected. # Corresponds to the JSON property `streamingConfig` # @return [Google::Apis::SecuritycenterV1::StreamingConfig] attr_accessor :streaming_config @@ -1793,47 +1636,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::SecuritycenterV1::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 @@ -1852,8 +1693,8 @@ module Google end end - # User specified settings that are attached to the Security Command - # Center organization. + # User specified settings that are attached to the Security Command Center + # organization. class OrganizationSettings include Google::Apis::Core::Hashable @@ -1862,19 +1703,17 @@ module Google # @return [Google::Apis::SecuritycenterV1::AssetDiscoveryConfig] attr_accessor :asset_discovery_config - # A flag that indicates if Asset Discovery should be enabled. If the flag is - # set to `true`, then discovery of assets will occur. If it is set to `false, - # all historical assets will remain, but discovery of future assets will not - # occur. + # A flag that indicates if Asset Discovery should be enabled. If the flag is set + # to `true`, then discovery of assets will occur. If it is set to `false, all + # historical assets will remain, but discovery of future assets will not occur. # Corresponds to the JSON property `enableAssetDiscovery` # @return [Boolean] attr_accessor :enable_asset_discovery alias_method :enable_asset_discovery?, :enable_asset_discovery - # The relative resource name of the settings. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/organizationSettings". + # The relative resource name of the settings. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/organizationSettings". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1892,66 +1731,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 @@ -1960,48 +1765,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 @@ -2019,13 +1820,13 @@ module Google end end - # Information related to the Google Cloud resource that is - # associated with this finding. + # Information related to the Google Cloud resource that is associated with this + # finding. LINT.IfChange class Resource include Google::Apis::Core::Hashable - # The full resource name of the resource. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the resource. See: https://cloud.google.com/apis/ + # design/resource_names#full_resource_name # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2087,9 +1888,9 @@ module Google # @return [String] attr_accessor :resource_display_name - # The full resource name of the Google Cloud resource this asset - # represents. This field is immutable after create time. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the Google Cloud resource this asset represents. + # This field is immutable after create time. See: https://cloud.google.com/apis/ + # design/resource_names#full_resource_name # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name @@ -2099,8 +1900,8 @@ module Google # @return [Array] attr_accessor :resource_owners - # The full resource name of the immediate parent of the resource. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the immediate parent of the resource. See: https:// + # cloud.google.com/apis/design/resource_names#full_resource_name # Corresponds to the JSON property `resourceParent` # @return [String] attr_accessor :resource_parent @@ -2110,8 +1911,8 @@ module Google # @return [String] attr_accessor :resource_parent_display_name - # The full resource name of the project the resource belongs to. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the project the resource belongs to. See: https:// + # cloud.google.com/apis/design/resource_names#full_resource_name # Corresponds to the JSON property `resourceProject` # @return [String] attr_accessor :resource_project @@ -2121,10 +1922,9 @@ module Google # @return [String] attr_accessor :resource_project_display_name - # The type of the Google Cloud resource. Examples include: APPLICATION, - # PROJECT, and ORGANIZATION. This is a case insensitive field defined by - # Security Command Center and/or the producer of the resource and is - # immutable after create time. + # The type of the Google Cloud resource. Examples include: APPLICATION, PROJECT, + # and ORGANIZATION. This is a case insensitive field defined by Security Command + # Center and/or the producer of the resource and is immutable after create time. # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type @@ -2146,30 +1946,26 @@ module Google end end - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. class SecurityMarks include Google::Apis::Core::Hashable # Mutable user specified security marks belonging to the parent resource. - # Constraints are as follows: - # * Keys and values are treated as case insensitive - # * Keys must be between 1 - 256 characters (inclusive) - # * Keys must be letters, numbers, underscores, or dashes - # * Values have leading and trailing whitespace trimmed, remaining - # characters must be between 1 - 4096 characters (inclusive) + # Constraints are as follows: * Keys and values are treated as case insensitive * + # Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, + # numbers, underscores, or dashes * Values have leading and trailing whitespace + # trimmed, remaining characters must be between 1 - 4096 characters (inclusive) # Corresponds to the JSON property `marks` # @return [Hash] attr_accessor :marks - # The relative resource name of the SecurityMarks. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Examples: - # "organizations/`organization_id`/assets/`asset_id`/securityMarks" - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/ - # securityMarks". + # The relative resource name of the SecurityMarks. See: https://cloud.google.com/ + # apis/design/resource_names#relative_resource_name Examples: "organizations/` + # organization_id`/assets/`asset_id`/securityMarks" "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2215,74 +2011,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::SecuritycenterV1::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 @@ -2298,37 +2059,32 @@ module Google end end - # Security Command Center finding source. A finding source - # is an entity or a mechanism that can produce a finding. A source is like a - # container of findings that come from the same scanner, logger, monitor, and - # other tools. + # Security Command Center finding source. A finding source is an entity or a + # mechanism that can produce a finding. A source is like a container of findings + # that come from the same scanner, logger, monitor, and other tools. class Source include Google::Apis::Core::Hashable - # The description of the source (max of 1024 characters). - # Example: - # "Web Security Scanner is a web security scanner for common - # vulnerabilities in App Engine applications. It can automatically - # scan and detect four common vulnerabilities, including cross-site-scripting - # (XSS), Flash injection, mixed content (HTTP in HTTPS), and - # outdated or insecure libraries." + # The description of the source (max of 1024 characters). Example: "Web Security + # Scanner is a web security scanner for common vulnerabilities in App Engine + # applications. It can automatically scan and detect four common vulnerabilities, + # including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in + # HTTPS), and outdated or insecure libraries." # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # The source's display name. - # A source's display name must be unique amongst its siblings, for example, - # two sources with the same parent can't share the same display name. - # The display name must have a length between 1 and 64 characters - # (inclusive). + # The source's display name. A source's display name must be unique amongst its + # siblings, for example, two sources with the same parent can't share the same + # display name. The display name must have a length between 1 and 64 characters ( + # inclusive). # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # The relative resource name of this source. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/sources/`source_id`" + # The relative resource name of this source. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/sources/`source_id`" # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2345,12 +2101,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 @@ -2359,15 +2115,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 @@ -2384,27 +2140,21 @@ module Google end end - # The config for streaming-based notifications, which send each event as soon - # as it is detected. + # The config for streaming-based notifications, which send each event as soon as + # it is detected. class StreamingConfig include Google::Apis::Core::Hashable - # Expression that defines the filter to apply across create/update events - # of assets or findings as specified by the event type. The expression is a - # list of zero or more restrictions combined via logical operators `AND` - # and `OR`. Parentheses are supported, and `OR` has higher precedence than - # `AND`. - # Restrictions have the form ` ` and may have a - # `-` character in front of them to indicate negation. The fields map to - # those defined in the corresponding resource. - # The supported operators are: - # * `=` for all value types. - # * `>`, `<`, `>=`, `<=` for integer values. - # * `:`, meaning substring matching, for strings. - # The supported value types are: - # * string literals in quotes. - # * integer literals without quotes. - # * boolean literals `true` and `false` without quotes. + # Expression that defines the filter to apply across create/update events of + # assets or findings as specified by the event type. The expression is a list of + # zero or more restrictions combined via logical operators `AND` and `OR`. + # Parentheses are supported, and `OR` has higher precedence than `AND`. + # Restrictions have the form ` ` and may have a `-` character in front of them + # to indicate negation. The fields map to those defined in the corresponding + # resource. The supported operators are: * `=` for all value types. * `>`, `<`, ` + # >=`, `<=` for integer values. * `:`, meaning substring matching, for strings. + # The supported value types are: * string literals in quotes. * integer literals + # without quotes. * boolean literals `true` and `false` without quotes. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter @@ -2423,10 +2173,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 @@ -2445,8 +2194,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 diff --git a/generated/google/apis/securitycenter_v1/service.rb b/generated/google/apis/securitycenter_v1/service.rb index dd66a7515..1aa5a4b00 100644 --- a/generated/google/apis/securitycenter_v1/service.rb +++ b/generated/google/apis/securitycenter_v1/service.rb @@ -51,8 +51,7 @@ module Google # Gets the settings for an organization. # @param [String] name # Required. Name of the organization to get organization settings for. Its - # format is - # "organizations/[organization_id]/organizationSettings". + # format is "organizations/[organization_id]/organizationSettings". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -82,14 +81,13 @@ module Google # Updates an organization's settings. # @param [String] name - # The relative resource name of the settings. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/organizationSettings". + # The relative resource name of the settings. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/organizationSettings". # @param [Google::Apis::SecuritycenterV1::OrganizationSettings] organization_settings_object # @param [String] update_mask - # The FieldMask to use when updating the settings resource. - # If empty all mutable fields will be updated. + # The FieldMask to use when updating the settings resource. If empty all mutable + # fields will be updated. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -120,11 +118,10 @@ module Google execute_or_queue_command(command, &block) end - # Filters an organization's assets and groups them by their specified - # properties. + # Filters an organization's assets and groups them by their specified properties. # @param [String] parent - # Required. Name of the organization to groupBy. Its format is - # "organizations/[organization_id]". + # Required. Name of the organization to groupBy. Its format is "organizations/[ + # organization_id]". # @param [Google::Apis::SecuritycenterV1::GroupAssetsRequest] group_assets_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -157,114 +154,86 @@ module Google # Lists an organization's assets. # @param [String] parent - # Required. Name of the organization assets should belong to. Its format is - # "organizations/[organization_id]". + # Required. Name of the organization assets should belong to. Its format is " + # organizations/[organization_id]". # @param [String] compare_duration - # When compare_duration is set, the ListAssetsResult's "state_change" - # attribute is updated to indicate whether the asset was added, removed, or - # remained present during the compare_duration period of time that precedes - # the read_time. This is the time between (read_time - compare_duration) and - # read_time. - # The state_change value is derived based on the presence of the asset at the - # two points in time. Intermediate state changes between the two times don't - # affect the result. For example, the results aren't affected if the asset is - # removed and re-created again. - # Possible "state_change" values when compare_duration is specified: - # * "ADDED": indicates that the asset was not present at the start of - # compare_duration, but present at read_time. - # * "REMOVED": indicates that the asset was present at the start of - # compare_duration, but not present at read_time. - # * "ACTIVE": indicates that the asset was present at both the - # start and the end of the time period defined by - # compare_duration and read_time. - # If compare_duration is not specified, then the only possible state_change - # is "UNUSED", which will be the state_change set for all assets present at + # When compare_duration is set, the ListAssetsResult's "state_change" attribute + # is updated to indicate whether the asset was added, removed, or remained + # present during the compare_duration period of time that precedes the read_time. + # This is the time between (read_time - compare_duration) and read_time. The + # state_change value is derived based on the presence of the asset at the two + # points in time. Intermediate state changes between the two times don't affect + # the result. For example, the results aren't affected if the asset is removed + # and re-created again. Possible "state_change" values when compare_duration is + # specified: * "ADDED": indicates that the asset was not present at the start of + # compare_duration, but present at read_time. * "REMOVED": indicates that the + # asset was present at the start of compare_duration, but not present at + # read_time. * "ACTIVE": indicates that the asset was present at both the start + # and the end of the time period defined by compare_duration and read_time. If + # compare_duration is not specified, then the only possible state_change is " + # UNUSED", which will be the state_change set for all assets present at # read_time. # @param [String] field_mask # A field mask to specify the ListAssetsResult fields to be listed in the - # response. - # An empty field mask will list all fields. + # response. An empty field mask will list all fields. # @param [String] filter - # Expression that defines the filter to apply across assets. - # The expression is a list of zero or more restrictions combined via logical - # operators `AND` and `OR`. - # Parentheses are supported, and `OR` has higher precedence than `AND`. - # Restrictions have the form ` ` and may have a `-` - # character in front of them to indicate negation. The fields map to those - # defined in the Asset resource. Examples include: - # * name - # * security_center_properties.resource_name - # * resource_properties.a_property - # * security_marks.marks.marka - # The supported operators are: - # * `=` for all value types. - # * `>`, `<`, `>=`, `<=` for integer values. - # * `:`, meaning substring matching, for strings. - # The supported value types are: - # * string literals in quotes. - # * integer literals without quotes. - # * boolean literals `true` and `false` without quotes. - # The following are the allowed field and operator combinations: - # * name: `=` - # * update_time: `=`, `>`, `<`, `>=`, `<=` - # Usage: This should be milliseconds since epoch or an RFC3339 string. - # Examples: - # `update_time = "2019-06-10T16:07:18-07:00"` - # `update_time = 1560208038000` - # * create_time: `=`, `>`, `<`, `>=`, `<=` - # Usage: This should be milliseconds since epoch or an RFC3339 string. - # Examples: - # `create_time = "2019-06-10T16:07:18-07:00"` - # `create_time = 1560208038000` - # * iam_policy.policy_blob: `=`, `:` - # * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` - # * security_marks.marks: `=`, `:` - # * security_center_properties.resource_name: `=`, `:` - # * security_center_properties.resource_display_name: `=`, `:` - # * security_center_properties.resource_type: `=`, `:` - # * security_center_properties.resource_parent: `=`, `:` - # * security_center_properties.resource_parent_display_name: `=`, `:` - # * security_center_properties.resource_project: `=`, `:` - # * security_center_properties.resource_project_display_name: `=`, `:` - # * security_center_properties.resource_owners: `=`, `:` - # For example, `resource_properties.size = 100` is a valid filter string. - # Use a partial match on the empty string to filter based on a property - # existing: `resource_properties.my_property : ""` - # Use a negated partial match on the empty string to filter based on a - # property not existing: `-resource_properties.my_property : ""` + # Expression that defines the filter to apply across assets. The expression is a + # list of zero or more restrictions combined via logical operators `AND` and `OR` + # . Parentheses are supported, and `OR` has higher precedence than `AND`. + # Restrictions have the form ` ` and may have a `-` character in front of them + # to indicate negation. The fields map to those defined in the Asset resource. + # Examples include: * name * security_center_properties.resource_name * + # resource_properties.a_property * security_marks.marks.marka The supported + # operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer + # values. * `:`, meaning substring matching, for strings. The supported value + # types are: * string literals in quotes. * integer literals without quotes. * + # boolean literals `true` and `false` without quotes. The following are the + # allowed field and operator combinations: * name: `=` * update_time: `=`, `>`, ` + # <`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 + # string. Examples: `update_time = "2019-06-10T16:07:18-07:00"` `update_time = + # 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be + # milliseconds since epoch or an RFC3339 string. Examples: `create_time = "2019- + # 06-10T16:07:18-07:00"` `create_time = 1560208038000` * iam_policy.policy_blob: + # `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * + # security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, + # `:` * security_center_properties.resource_display_name: `=`, `:` * + # security_center_properties.resource_type: `=`, `:` * + # security_center_properties.resource_parent: `=`, `:` * + # security_center_properties.resource_parent_display_name: `=`, `:` * + # security_center_properties.resource_project: `=`, `:` * + # security_center_properties.resource_project_display_name: `=`, `:` * + # security_center_properties.resource_owners: `=`, `:` For example, ` + # resource_properties.size = 100` is a valid filter string. Use a partial match + # on the empty string to filter based on a property existing: ` + # resource_properties.my_property : ""` Use a negated partial match on the empty + # string to filter based on a property not existing: `-resource_properties. + # my_property : ""` # @param [String] order_by - # Expression that defines what fields and order to use for sorting. The - # string value should follow SQL syntax: comma separated list of fields. For - # example: "name,resource_properties.a_property". The default sorting order - # is ascending. To specify descending order for a field, a suffix " desc" - # should be appended to the field name. For example: "name - # desc,resource_properties.a_property". Redundant space characters in the - # syntax are insignificant. "name desc,resource_properties.a_property" and " - # name desc , resource_properties.a_property " are equivalent. - # The following fields are supported: - # name - # update_time - # resource_properties - # security_marks.marks - # security_center_properties.resource_name - # security_center_properties.resource_display_name - # security_center_properties.resource_parent + # Expression that defines what fields and order to use for sorting. The string + # value should follow SQL syntax: comma separated list of fields. For example: " + # name,resource_properties.a_property". The default sorting order is ascending. + # To specify descending order for a field, a suffix " desc" should be appended + # to the field name. For example: "name desc,resource_properties.a_property". + # Redundant space characters in the syntax are insignificant. "name desc, + # resource_properties.a_property" and " name desc , resource_properties. + # a_property " are equivalent. The following fields are supported: name + # update_time resource_properties security_marks.marks + # security_center_properties.resource_name security_center_properties. + # resource_display_name security_center_properties.resource_parent # security_center_properties.resource_parent_display_name - # security_center_properties.resource_project - # security_center_properties.resource_project_display_name - # security_center_properties.resource_type + # security_center_properties.resource_project security_center_properties. + # resource_project_display_name security_center_properties.resource_type # @param [Fixnum] page_size - # The maximum number of results to return in a single response. Default is - # 10, minimum is 1, maximum is 1000. + # The maximum number of results to return in a single response. Default is 10, + # minimum is 1, maximum is 1000. # @param [String] page_token - # The value returned by the last `ListAssetsResponse`; indicates - # that this is a continuation of a prior `ListAssets` call, and - # that the system should return the next page of data. + # The value returned by the last `ListAssetsResponse`; indicates that this is a + # continuation of a prior `ListAssets` call, and that the system should return + # the next page of data. # @param [String] read_time - # Time used as a reference point when filtering assets. The filter is limited - # to assets existing at the supplied time and their values are those at that - # specific time. Absence of this field will default to the API's version of - # NOW. + # Time used as a reference point when filtering assets. The filter is limited to + # assets existing at the supplied time and their values are those at that + # specific time. Absence of this field will default to the API's version of NOW. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -299,14 +268,12 @@ module Google execute_or_queue_command(command, &block) end - # Runs asset discovery. The discovery is tracked with a long-running - # operation. - # This API can only be called with limited frequency for an organization. If - # it is called too frequently the caller will receive a TOO_MANY_REQUESTS - # error. + # Runs asset discovery. The discovery is tracked with a long-running operation. + # This API can only be called with limited frequency for an organization. If it + # is called too frequently the caller will receive a TOO_MANY_REQUESTS error. # @param [String] parent - # Required. Name of the organization to run asset discovery for. Its format is - # "organizations/[organization_id]". + # Required. Name of the organization to run asset discovery for. Its format is " + # organizations/[organization_id]". # @param [Google::Apis::SecuritycenterV1::RunAssetDiscoveryRequest] run_asset_discovery_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -339,22 +306,19 @@ module Google # Updates security marks. # @param [String] name - # The relative resource name of the SecurityMarks. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Examples: - # "organizations/`organization_id`/assets/`asset_id`/securityMarks" - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/ - # securityMarks". + # The relative resource name of the SecurityMarks. See: https://cloud.google.com/ + # apis/design/resource_names#relative_resource_name Examples: "organizations/` + # organization_id`/assets/`asset_id`/securityMarks" "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks". # @param [Google::Apis::SecuritycenterV1::SecurityMarks] security_marks_object # @param [String] start_time - # The time at which the updated SecurityMarks take effect. - # If not set uses current server time. Updates will be applied to the - # SecurityMarks that are active immediately preceding this time. + # The time at which the updated SecurityMarks take effect. If not set uses + # current server time. Updates will be applied to the SecurityMarks that are + # active immediately preceding this time. # @param [String] update_mask - # The FieldMask to use when updating the security marks resource. - # The field mask must not contain duplicate fields. - # If empty or set to "marks", all marks will be replaced. Individual - # marks can be updated using "marks.". + # The FieldMask to use when updating the security marks resource. The field mask + # must not contain duplicate fields. If empty or set to "marks", all marks will + # be replaced. Individual marks can be updated using "marks.". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -392,10 +356,9 @@ module Google # "organizations/[organization_id]". # @param [Google::Apis::SecuritycenterV1::NotificationConfig] notification_config_object # @param [String] config_id - # Required. - # Unique identifier provided by the client within the parent scope. - # It must be between 1 and 128 characters, and contains alphanumeric - # characters, underscores or hyphens only. + # Required. Unique identifier provided by the client within the parent scope. It + # must be between 1 and 128 characters, and contains alphanumeric characters, + # underscores or hyphens only. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -428,8 +391,8 @@ module Google # Deletes a notification config. # @param [String] name - # Required. Name of the notification config to delete. Its format is - # "organizations/[organization_id]/notificationConfigs/[config_id]". + # Required. Name of the notification config to delete. Its format is " + # organizations/[organization_id]/notificationConfigs/[config_id]". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -459,8 +422,8 @@ module Google # Gets a notification config. # @param [String] name - # Required. Name of the notification config to get. Its format is - # "organizations/[organization_id]/notificationConfigs/[config_id]". + # Required. Name of the notification config to get. Its format is "organizations/ + # [organization_id]/notificationConfigs/[config_id]". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -490,11 +453,11 @@ module Google # Lists notification configs. # @param [String] parent - # Required. Name of the organization to list notification configs. - # Its format is "organizations/[organization_id]". + # Required. Name of the organization to list notification configs. Its format is + # "organizations/[organization_id]". # @param [Fixnum] page_size - # The maximum number of results to return in a single response. Default is - # 10, minimum is 1, maximum is 1000. + # The maximum number of results to return in a single response. Default is 10, + # minimum is 1, maximum is 1000. # @param [String] page_token # The value returned by the last `ListNotificationConfigsResponse`; indicates # that this is a continuation of a prior `ListNotificationConfigs` call, and @@ -528,17 +491,16 @@ module Google execute_or_queue_command(command, &block) end - # Updates a notification config. The following update - # fields are allowed: description, pubsub_topic, streaming_config.filter + # Updates a notification config. The following update fields are allowed: + # description, pubsub_topic, streaming_config.filter # @param [String] name - # The relative resource name of this notification config. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/notificationConfigs/notify_public_bucket". + # The relative resource name of this notification config. See: https://cloud. + # google.com/apis/design/resource_names#relative_resource_name Example: " + # organizations/`organization_id`/notificationConfigs/notify_public_bucket". # @param [Google::Apis::SecuritycenterV1::NotificationConfig] notification_config_object # @param [String] update_mask - # The FieldMask to use when updating the notification config. - # If empty all mutable fields will be updated. + # The FieldMask to use when updating the notification config. If empty all + # mutable fields will be updated. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -569,15 +531,13 @@ module Google 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, + # 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. @@ -608,10 +568,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 @@ -641,9 +601,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 @@ -673,15 +632,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 @@ -722,8 +680,8 @@ module Google # Creates a source. # @param [String] parent - # Required. Resource name of the new source's parent. Its format should be - # "organizations/[organization_id]". + # Required. Resource name of the new source's parent. Its format should be " + # organizations/[organization_id]". # @param [Google::Apis::SecuritycenterV1::Source] source_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -756,8 +714,8 @@ module Google # Gets a source. # @param [String] name - # Required. Relative resource name of the source. Its format is - # "organizations/[organization_id]/source/[source_id]". + # Required. Relative resource name of the source. Its format is "organizations/[ + # organization_id]/source/[source_id]". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -787,8 +745,8 @@ module Google # Gets the access control policy on the specified Source. # @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::SecuritycenterV1::GetIamPolicyRequest] get_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -824,12 +782,12 @@ module Google # Required. Resource name of the parent of sources to list. Its format should be # "organizations/[organization_id]". # @param [Fixnum] page_size - # The maximum number of results to return in a single response. Default is - # 10, minimum is 1, maximum is 1000. + # The maximum number of results to return in a single response. Default is 10, + # minimum is 1, maximum is 1000. # @param [String] page_token - # The value returned by the last `ListSourcesResponse`; indicates - # that this is a continuation of a prior `ListSources` call, and - # that the system should return the next page of data. + # The value returned by the last `ListSourcesResponse`; indicates that this is a + # continuation of a prior `ListSources` call, and that the system should return + # the next page of data. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -861,14 +819,13 @@ module Google # Updates a source. # @param [String] name - # The relative resource name of this source. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/sources/`source_id`" + # The relative resource name of this source. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/sources/`source_id`" # @param [Google::Apis::SecuritycenterV1::Source] source_object # @param [String] update_mask - # The FieldMask to use when updating the source resource. - # If empty all mutable fields will be updated. + # The FieldMask to use when updating the source resource. If empty all mutable + # fields will be updated. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -901,8 +858,8 @@ module Google # Sets the access control policy on the specified Source. # @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::SecuritycenterV1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -935,8 +892,8 @@ module Google # Returns the permissions that a caller has on the specified source. # @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::SecuritycenterV1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -967,16 +924,16 @@ module Google execute_or_queue_command(command, &block) end - # Creates a finding. The corresponding source must exist for finding creation - # to succeed. + # Creates a finding. The corresponding source must exist for finding creation to + # succeed. # @param [String] parent - # Required. Resource name of the new finding's parent. Its format should be - # "organizations/[organization_id]/sources/[source_id]". + # Required. Resource name of the new finding's parent. Its format should be " + # organizations/[organization_id]/sources/[source_id]". # @param [Google::Apis::SecuritycenterV1::Finding] finding_object # @param [String] finding_id - # Required. Unique identifier provided by the client within the parent scope. - # It must be alphanumeric and less than or equal to 32 characters and - # greater than 0 characters in length. + # Required. Unique identifier provided by the client within the parent scope. It + # must be alphanumeric and less than or equal to 32 characters and greater than + # 0 characters in length. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1007,15 +964,13 @@ module Google execute_or_queue_command(command, &block) end - # Filters an organization or source's findings and groups them by their - # specified properties. - # To group across all sources provide a `-` as the source id. - # Example: /v1/organizations/`organization_id`/sources/-/findings + # Filters an organization or source's findings and groups them by their + # specified properties. To group across all sources provide a `-` as the source + # id. Example: /v1/organizations/`organization_id`/sources/-/findings # @param [String] parent - # Required. Name of the source to groupBy. Its format is - # "organizations/[organization_id]/sources/[source_id]". To groupBy across - # all sources provide a source_id of `-`. For example: - # organizations/`organization_id`/sources/- + # Required. Name of the source to groupBy. Its format is "organizations/[ + # organization_id]/sources/[source_id]". To groupBy across all sources provide a + # source_id of `-`. For example: organizations/`organization_id`/sources/- # @param [Google::Apis::SecuritycenterV1::GroupFindingsRequest] group_findings_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1046,111 +1001,80 @@ module Google execute_or_queue_command(command, &block) end - # Lists an organization or source's findings. - # To list across all sources provide a `-` as the source id. - # Example: /v1/organizations/`organization_id`/sources/-/findings + # Lists an organization or source's findings. To list across all sources provide + # a `-` as the source id. Example: /v1/organizations/`organization_id`/sources/-/ + # findings # @param [String] parent - # Required. Name of the source the findings belong to. Its format is - # "organizations/[organization_id]/sources/[source_id]". To list across all - # sources provide a source_id of `-`. For example: - # organizations/`organization_id`/sources/- + # Required. Name of the source the findings belong to. Its format is " + # organizations/[organization_id]/sources/[source_id]". To list across all + # sources provide a source_id of `-`. For example: organizations/` + # organization_id`/sources/- # @param [String] compare_duration # When compare_duration is set, the ListFindingsResult's "state_change" # attribute is updated to indicate whether the finding had its state changed, # the finding's state remained unchanged, or if the finding was added in any - # state during the compare_duration period of time that precedes the - # read_time. This is the time between (read_time - compare_duration) and - # read_time. - # The state_change value is derived based on the presence and state of the - # finding at the two points in time. Intermediate state changes between the - # two times don't affect the result. For example, the results aren't affected - # if the finding is made inactive and then active again. - # Possible "state_change" values when compare_duration is specified: - # * "CHANGED": indicates that the finding was present and matched the given - # filter at the start of compare_duration, but changed its - # state at read_time. - # * "UNCHANGED": indicates that the finding was present and matched the given - # filter at the start of compare_duration and did not change - # state at read_time. - # * "ADDED": indicates that the finding did not match the given filter or - # was not present at the start of compare_duration, but was - # present at read_time. - # * "REMOVED": indicates that the finding was present and matched the - # filter at the start of compare_duration, but did not match - # the filter at read_time. - # If compare_duration is not specified, then the only possible state_change - # is "UNUSED", which will be the state_change set for all findings present at - # read_time. + # state during the compare_duration period of time that precedes the read_time. + # This is the time between (read_time - compare_duration) and read_time. The + # state_change value is derived based on the presence and state of the finding + # at the two points in time. Intermediate state changes between the two times + # don't affect the result. For example, the results aren't affected if the + # finding is made inactive and then active again. Possible "state_change" values + # when compare_duration is specified: * "CHANGED": indicates that the finding + # was present and matched the given filter at the start of compare_duration, but + # changed its state at read_time. * "UNCHANGED": indicates that the finding was + # present and matched the given filter at the start of compare_duration and did + # not change state at read_time. * "ADDED": indicates that the finding did not + # match the given filter or was not present at the start of compare_duration, + # but was present at read_time. * "REMOVED": indicates that the finding was + # present and matched the filter at the start of compare_duration, but did not + # match the filter at read_time. If compare_duration is not specified, then the + # only possible state_change is "UNUSED", which will be the state_change set for + # all findings present at read_time. # @param [String] field_mask - # A field mask to specify the Finding fields to be listed in the response. - # An empty field mask will list all fields. + # A field mask to specify the Finding fields to be listed in the response. An + # empty field mask will list all fields. # @param [String] filter - # Expression that defines the filter to apply across findings. - # The expression is a list of one or more restrictions combined via logical - # operators `AND` and `OR`. - # Parentheses are supported, and `OR` has higher precedence than `AND`. - # Restrictions have the form ` ` and may have a `-` - # character in front of them to indicate negation. Examples include: - # * name - # * source_properties.a_property - # * security_marks.marks.marka - # The supported operators are: - # * `=` for all value types. - # * `>`, `<`, `>=`, `<=` for integer values. - # * `:`, meaning substring matching, for strings. - # The supported value types are: - # * string literals in quotes. - # * integer literals without quotes. - # * boolean literals `true` and `false` without quotes. - # The following field and operator combinations are supported: - # name: `=` - # parent: `=`, `:` - # resource_name: `=`, `:` - # state: `=`, `:` - # category: `=`, `:` - # external_uri: `=`, `:` - # event_time: `=`, `>`, `<`, `>=`, `<=` - # Usage: This should be milliseconds since epoch or an RFC3339 string. - # Examples: - # `event_time = "2019-06-10T16:07:18-07:00"` - # `event_time = 1560208038000` - # security_marks.marks: `=`, `:` - # source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` - # For example, `source_properties.size = 100` is a valid filter string. - # Use a partial match on the empty string to filter based on a property - # existing: `source_properties.my_property : ""` - # Use a negated partial match on the empty string to filter based on a - # property not existing: `-source_properties.my_property : ""` + # Expression that defines the filter to apply across findings. The expression is + # a list of one or more restrictions combined via logical operators `AND` and ` + # OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. + # Restrictions have the form ` ` and may have a `-` character in front of them + # to indicate negation. Examples include: * name * source_properties.a_property * + # security_marks.marks.marka The supported operators are: * `=` for all value + # types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring + # matching, for strings. The supported value types are: * string literals in + # quotes. * integer literals without quotes. * boolean literals `true` and ` + # false` without quotes. The following field and operator combinations are + # supported: name: `=` parent: `=`, `:` resource_name: `=`, `:` state: `=`, `:` + # category: `=`, `:` external_uri: `=`, `:` event_time: `=`, `>`, `<`, `>=`, `<=` + # Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: + # `event_time = "2019-06-10T16:07:18-07:00"` `event_time = 1560208038000` + # security_marks.marks: `=`, `:` source_properties: `=`, `:`, `>`, `<`, `>=`, `<= + # ` For example, `source_properties.size = 100` is a valid filter string. Use a + # partial match on the empty string to filter based on a property existing: ` + # source_properties.my_property : ""` Use a negated partial match on the empty + # string to filter based on a property not existing: `-source_properties. + # my_property : ""` # @param [String] order_by - # Expression that defines what fields and order to use for sorting. The - # string value should follow SQL syntax: comma separated list of fields. For - # example: "name,resource_properties.a_property". The default sorting order - # is ascending. To specify descending order for a field, a suffix " desc" - # should be appended to the field name. For example: "name - # desc,source_properties.a_property". Redundant space characters in the - # syntax are insignificant. "name desc,source_properties.a_property" and " - # name desc , source_properties.a_property " are equivalent. - # The following fields are supported: - # name - # parent - # state - # category - # resource_name - # event_time - # source_properties - # security_marks.marks + # Expression that defines what fields and order to use for sorting. The string + # value should follow SQL syntax: comma separated list of fields. For example: " + # name,resource_properties.a_property". The default sorting order is ascending. + # To specify descending order for a field, a suffix " desc" should be appended + # to the field name. For example: "name desc,source_properties.a_property". + # Redundant space characters in the syntax are insignificant. "name desc, + # source_properties.a_property" and " name desc , source_properties.a_property " + # are equivalent. The following fields are supported: name parent state category + # resource_name event_time source_properties security_marks.marks # @param [Fixnum] page_size - # The maximum number of results to return in a single response. Default is - # 10, minimum is 1, maximum is 1000. + # The maximum number of results to return in a single response. Default is 10, + # minimum is 1, maximum is 1000. # @param [String] page_token - # The value returned by the last `ListFindingsResponse`; indicates - # that this is a continuation of a prior `ListFindings` call, and - # that the system should return the next page of data. + # The value returned by the last `ListFindingsResponse`; indicates that this is + # a continuation of a prior `ListFindings` call, and that the system should + # return the next page of data. # @param [String] read_time - # Time used as a reference point when filtering findings. The filter is - # limited to findings existing at the supplied time and their values are - # those at that specific time. Absence of this field will default to the - # API's version of NOW. + # Time used as a reference point when filtering findings. The filter is limited + # to findings existing at the supplied time and their values are those at that + # specific time. Absence of this field will default to the API's version of NOW. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1188,18 +1112,16 @@ module Google # Creates or updates a finding. The corresponding source must exist for a # finding creation to succeed. # @param [String] name - # The relative resource name of this finding. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`" + # The relative resource name of this finding. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`" # @param [Google::Apis::SecuritycenterV1::Finding] finding_object # @param [String] update_mask - # The FieldMask to use when updating the finding resource. This field should - # not be specified when creating a finding. - # When updating a finding, an empty mask is treated as updating all mutable - # fields and replacing source_properties. Individual source_properties can - # be added/updated by using "source_properties." in the field - # mask. + # The FieldMask to use when updating the finding resource. This field should not + # be specified when creating a finding. When updating a finding, an empty mask + # is treated as updating all mutable fields and replacing source_properties. + # Individual source_properties can be added/updated by using "source_properties." + # in the field mask. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1232,10 +1154,9 @@ module Google # Updates the state of a finding. # @param [String] name - # Required. The relative resource name of the finding. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/sources/`source_id`/finding/`finding_id`". + # Required. The relative resource name of the finding. See: https://cloud.google. + # com/apis/design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/sources/`source_id`/finding/`finding_id`". # @param [Google::Apis::SecuritycenterV1::SetFindingStateRequest] set_finding_state_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1268,22 +1189,19 @@ module Google # Updates security marks. # @param [String] name - # The relative resource name of the SecurityMarks. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Examples: - # "organizations/`organization_id`/assets/`asset_id`/securityMarks" - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/ - # securityMarks". + # The relative resource name of the SecurityMarks. See: https://cloud.google.com/ + # apis/design/resource_names#relative_resource_name Examples: "organizations/` + # organization_id`/assets/`asset_id`/securityMarks" "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks". # @param [Google::Apis::SecuritycenterV1::SecurityMarks] security_marks_object # @param [String] start_time - # The time at which the updated SecurityMarks take effect. - # If not set uses current server time. Updates will be applied to the - # SecurityMarks that are active immediately preceding this time. + # The time at which the updated SecurityMarks take effect. If not set uses + # current server time. Updates will be applied to the SecurityMarks that are + # active immediately preceding this time. # @param [String] update_mask - # The FieldMask to use when updating the security marks resource. - # The field mask must not contain duplicate fields. - # If empty or set to "marks", all marks will be replaced. Individual - # marks can be updated using "marks.". + # The FieldMask to use when updating the security marks resource. The field mask + # must not contain duplicate fields. If empty or set to "marks", all marks will + # be replaced. Individual marks can be updated using "marks.". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/securitycenter_v1beta1.rb b/generated/google/apis/securitycenter_v1beta1.rb index 8b1f1f1c7..3125323ce 100644 --- a/generated/google/apis/securitycenter_v1beta1.rb +++ b/generated/google/apis/securitycenter_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview module SecuritycenterV1beta1 VERSION = 'V1beta1' - REVISION = '20200605' + REVISION = '20200731' # 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/securitycenter_v1beta1/classes.rb b/generated/google/apis/securitycenter_v1beta1/classes.rb index a21924017..5045fa01f 100644 --- a/generated/google/apis/securitycenter_v1beta1/classes.rb +++ b/generated/google/apis/securitycenter_v1beta1/classes.rb @@ -22,12 +22,11 @@ module Google module Apis module SecuritycenterV1beta1 - # Security Command Center representation of a Google Cloud - # resource. - # The Asset is a Security Command Center resource that captures information - # about a single Google Cloud resource. All modifications to an Asset are only - # within the context of Security Command Center and don't affect the referenced - # Google Cloud resource. + # Security Command Center representation of a Google Cloud resource. The Asset + # is a Security Command Center resource that captures information about a single + # Google Cloud resource. All modifications to an Asset are only within the + # context of Security Command Center and don't affect the referenced Google + # Cloud resource. class Asset include Google::Apis::Core::Hashable @@ -36,16 +35,15 @@ module Google # @return [String] attr_accessor :create_time - # The relative resource name of this asset. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/assets/`asset_id`". + # The relative resource name of this asset. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/assets/`asset_id`". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Resource managed properties. These properties are managed and defined by - # the Google Cloud resource and cannot be modified by the user. + # Resource managed properties. These properties are managed and defined by the + # Google Cloud resource and cannot be modified by the user. # Corresponds to the JSON property `resourceProperties` # @return [Hash] attr_accessor :resource_properties @@ -56,10 +54,10 @@ module Google # @return [Google::Apis::SecuritycenterV1beta1::SecurityCenterProperties] attr_accessor :security_center_properties - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1beta1SecurityMarks] attr_accessor :security_marks @@ -110,53 +108,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 @@ -165,9 +131,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 @@ -183,28 +149,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] @@ -230,69 +183,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::SecuritycenterV1beta1::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 @@ -322,13 +263,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 @@ -341,52 +280,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 @@ -404,18 +334,16 @@ module Google end end - # Security Command Center finding. - # A finding is a record of assessment data like security, risk, health, or - # privacy, that is ingested into Security Command Center for presentation, - # notification, analysis, policy testing, and enforcement. For example, a - # cross-site scripting (XSS) vulnerability in an App Engine application is a - # finding. + # Security Command Center finding. A finding is a record of assessment data like + # security, risk, health, or privacy, that is ingested into Security Command + # Center for presentation, notification, analysis, policy testing, and + # enforcement. For example, a cross-site scripting (XSS) vulnerability in an App + # Engine application is a finding. class Finding include Google::Apis::Core::Hashable - # The additional taxonomy group within findings from a given source. - # This field is immutable after creation time. - # Example: "XSS_FLASH_INJECTION" + # The additional taxonomy group within findings from a given source. This field + # is immutable after creation time. Example: "XSS_FLASH_INJECTION" # Corresponds to the JSON property `category` # @return [String] attr_accessor :category @@ -425,59 +353,56 @@ module Google # @return [String] attr_accessor :create_time - # The time at which the event took place. For example, if the finding - # represents an open firewall it would capture the time the detector believes - # the firewall became open. The accuracy is determined by the detector. + # The time at which the event took place. For example, if the finding represents + # an open firewall it would capture the time the detector believes the firewall + # became open. The accuracy is determined by the detector. # Corresponds to the JSON property `eventTime` # @return [String] attr_accessor :event_time - # The URI that, if available, points to a web page outside of Security - # Command Center where additional information about the finding can be found. - # This field is guaranteed to be either empty or a well formed URL. + # The URI that, if available, points to a web page outside of Security Command + # Center where additional information about the finding can be found. This field + # is guaranteed to be either empty or a well formed URL. # Corresponds to the JSON property `externalUri` # @return [String] attr_accessor :external_uri - # The relative resource name of this finding. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`" + # The relative resource name of this finding. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`" # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The relative resource name of the source the finding belongs to. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # This field is immutable after creation time. - # For example: - # "organizations/`organization_id`/sources/`source_id`" + # The relative resource name of the source the finding belongs to. See: https:// + # cloud.google.com/apis/design/resource_names#relative_resource_name This field + # is immutable after creation time. For example: "organizations/`organization_id` + # /sources/`source_id`" # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # For findings on Google Cloud resources, the full resource - # name of the Google Cloud resource this finding is for. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name - # When the finding is for a non-Google Cloud resource, the resourceName can - # be a customer or partner defined string. This field is immutable after - # creation time. + # For findings on Google Cloud resources, the full resource name of the Google + # Cloud resource this finding is for. See: https://cloud.google.com/apis/design/ + # resource_names#full_resource_name When the finding is for a non-Google Cloud + # resource, the resourceName can be a customer or partner defined string. This + # field is immutable after creation time. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1beta1::SecurityMarks] attr_accessor :security_marks - # Source specific properties. These properties are managed by the source - # that writes the finding. The key names in the source_properties map must be - # between 1 and 255 characters, and must start with a letter and contain - # alphanumeric characters or underscores only. + # Source specific properties. These properties are managed by the source that + # writes the finding. The key names in the source_properties map must be between + # 1 and 255 characters, and must start with a letter and contain alphanumeric + # characters or underscores only. # Corresponds to the JSON property `sourceProperties` # @return [Hash] attr_accessor :source_properties @@ -529,15 +454,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 @@ -556,12 +479,11 @@ module Google class GoogleCloudSecuritycenterV1NotificationMessage include Google::Apis::Core::Hashable - # Security Command Center finding. - # A finding is a record of assessment data like security, risk, health, or - # privacy, that is ingested into Security Command Center for presentation, - # notification, analysis, policy testing, and enforcement. For example, a - # cross-site scripting (XSS) vulnerability in an App Engine application is a - # finding. + # Security Command Center finding. A finding is a record of assessment data like + # security, risk, health, or privacy, that is ingested into Security Command + # Center for presentation, notification, analysis, policy testing, and + # enforcement. For example, a cross-site scripting (XSS) vulnerability in an App + # Engine application is a finding. # Corresponds to the JSON property `finding` # @return [Google::Apis::SecuritycenterV1beta1::Finding] attr_accessor :finding @@ -592,8 +514,8 @@ module Google class GoogleCloudSecuritycenterV1Resource include Google::Apis::Core::Hashable - # The full resource name of the resource. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the resource. See: https://cloud.google.com/apis/ + # design/resource_names#full_resource_name # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -657,17 +579,15 @@ module Google end end - # Security Command Center finding. - # A finding is a record of assessment data (security, risk, health or privacy) - # ingested into Security Command Center for presentation, notification, - # analysis, policy testing, and enforcement. For example, an XSS vulnerability - # in an App Engine application is a finding. + # Security Command Center finding. A finding is a record of assessment data ( + # security, risk, health or privacy) ingested into Security Command Center for + # presentation, notification, analysis, policy testing, and enforcement. For + # example, an XSS vulnerability in an App Engine application is a finding. class GoogleCloudSecuritycenterV1beta1Finding include Google::Apis::Core::Hashable - # The additional taxonomy group within findings from a given source. - # This field is immutable after creation time. - # Example: "XSS_FLASH_INJECTION" + # The additional taxonomy group within findings from a given source. This field + # is immutable after creation time. Example: "XSS_FLASH_INJECTION" # Corresponds to the JSON property `category` # @return [String] attr_accessor :category @@ -677,60 +597,56 @@ module Google # @return [String] attr_accessor :create_time - # The time at which the event took place. For example, if the finding - # represents an open firewall it would capture the time the detector believes - # the firewall became open. The accuracy is determined by the detector. + # The time at which the event took place. For example, if the finding represents + # an open firewall it would capture the time the detector believes the firewall + # became open. The accuracy is determined by the detector. # Corresponds to the JSON property `eventTime` # @return [String] attr_accessor :event_time - # The URI that, if available, points to a web page outside of Security - # Command Center where additional information about the finding can be found. - # This field is guaranteed to be either empty or a well formed URL. + # The URI that, if available, points to a web page outside of Security Command + # Center where additional information about the finding can be found. This field + # is guaranteed to be either empty or a well formed URL. # Corresponds to the JSON property `externalUri` # @return [String] attr_accessor :external_uri - # The relative resource name of this finding. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`" + # The relative resource name of this finding. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`" # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Immutable. The relative resource name of the source the finding belongs to. - # See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # This field is immutable after creation time. - # For example: - # "organizations/`organization_id`/sources/`source_id`" + # See: https://cloud.google.com/apis/design/resource_names# + # relative_resource_name This field is immutable after creation time. For + # example: "organizations/`organization_id`/sources/`source_id`" # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # For findings on Google Cloud resources, the full resource - # name of the Google Cloud resource this finding is for. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name - # When the finding is for a non-Google Cloud resource, the resourceName can - # be a customer or partner defined string. This field is immutable after - # creation time. + # For findings on Google Cloud resources, the full resource name of the Google + # Cloud resource this finding is for. See: https://cloud.google.com/apis/design/ + # resource_names#full_resource_name When the finding is for a non-Google Cloud + # resource, the resourceName can be a customer or partner defined string. This + # field is immutable after creation time. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1beta1SecurityMarks] attr_accessor :security_marks - # Source specific properties. These properties are managed by the source - # that writes the finding. The key names in the source_properties map must be - # between 1 and 255 characters, and must start with a letter and contain - # alphanumeric characters or underscores only. + # Source specific properties. These properties are managed by the source that + # writes the finding. The key names in the source_properties map must be between + # 1 and 255 characters, and must start with a letter and contain alphanumeric + # characters or underscores only. # Corresponds to the JSON property `sourceProperties` # @return [Hash] attr_accessor :source_properties @@ -784,30 +700,26 @@ module Google end end - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. class GoogleCloudSecuritycenterV1beta1SecurityMarks include Google::Apis::Core::Hashable # Mutable user specified security marks belonging to the parent resource. - # Constraints are as follows: - # * Keys and values are treated as case insensitive - # * Keys must be between 1 - 256 characters (inclusive) - # * Keys must be letters, numbers, underscores, or dashes - # * Values have leading and trailing whitespace trimmed, remaining - # characters must be between 1 - 4096 characters (inclusive) + # Constraints are as follows: * Keys and values are treated as case insensitive * + # Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, + # numbers, underscores, or dashes * Values have leading and trailing whitespace + # trimmed, remaining characters must be between 1 - 4096 characters (inclusive) # Corresponds to the JSON property `marks` # @return [Hash] attr_accessor :marks - # The relative resource name of the SecurityMarks. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Examples: - # "organizations/`organization_id`/assets/`asset_id`/securityMarks" - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/ - # securityMarks". + # The relative resource name of the SecurityMarks. See: https://cloud.google.com/ + # apis/design/resource_names#relative_resource_name Examples: "organizations/` + # organization_id`/assets/`asset_id`/securityMarks" "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -823,12 +735,11 @@ module Google end end - # Security Command Center representation of a Google Cloud - # resource. - # The Asset is a Security Command Center resource that captures information - # about a single Google Cloud resource. All modifications to an Asset are only - # within the context of Security Command Center and don't affect the referenced - # Google Cloud resource. + # Security Command Center representation of a Google Cloud resource. The Asset + # is a Security Command Center resource that captures information about a single + # Google Cloud resource. All modifications to an Asset are only within the + # context of Security Command Center and don't affect the referenced Google + # Cloud resource. class GoogleCloudSecuritycenterV1p1beta1Asset include Google::Apis::Core::Hashable @@ -839,22 +750,20 @@ module Google # Cloud IAM Policy information associated with the Google Cloud resource # described by the Security Command Center asset. This information is managed - # and defined by the Google Cloud resource and cannot be modified by the - # user. + # and defined by the Google Cloud resource and cannot be modified by the user. # Corresponds to the JSON property `iamPolicy` # @return [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1p1beta1IamPolicy] attr_accessor :iam_policy - # The relative resource name of this asset. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/assets/`asset_id`". + # The relative resource name of this asset. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/assets/`asset_id`". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Resource managed properties. These properties are managed and defined by - # the Google Cloud resource and cannot be modified by the user. + # Resource managed properties. These properties are managed and defined by the + # Google Cloud resource and cannot be modified by the user. # Corresponds to the JSON property `resourceProperties` # @return [Hash] attr_accessor :resource_properties @@ -865,16 +774,15 @@ module Google # @return [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties] attr_accessor :security_center_properties - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] attr_accessor :security_marks - # The time at which the asset was last updated, added, or deleted in Cloud - # SCC. + # The time at which the asset was last updated, added, or deleted in Cloud SCC. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -895,17 +803,15 @@ module Google end end - # Security Command Center finding. - # A finding is a record of assessment data (security, risk, health or privacy) - # ingested into Security Command Center for presentation, notification, - # analysis, policy testing, and enforcement. For example, an XSS vulnerability - # in an App Engine application is a finding. + # Security Command Center finding. A finding is a record of assessment data ( + # security, risk, health or privacy) ingested into Security Command Center for + # presentation, notification, analysis, policy testing, and enforcement. For + # example, an XSS vulnerability in an App Engine application is a finding. class GoogleCloudSecuritycenterV1p1beta1Finding include Google::Apis::Core::Hashable - # The additional taxonomy group within findings from a given source. - # This field is immutable after creation time. - # Example: "XSS_FLASH_INJECTION" + # The additional taxonomy group within findings from a given source. This field + # is immutable after creation time. Example: "XSS_FLASH_INJECTION" # Corresponds to the JSON property `category` # @return [String] attr_accessor :category @@ -915,59 +821,56 @@ module Google # @return [String] attr_accessor :create_time - # The time at which the event took place. For example, if the finding - # represents an open firewall it would capture the time the detector believes - # the firewall became open. The accuracy is determined by the detector. + # The time at which the event took place. For example, if the finding represents + # an open firewall it would capture the time the detector believes the firewall + # became open. The accuracy is determined by the detector. # Corresponds to the JSON property `eventTime` # @return [String] attr_accessor :event_time - # The URI that, if available, points to a web page outside of Security - # Command Center where additional information about the finding can be found. - # This field is guaranteed to be either empty or a well formed URL. + # The URI that, if available, points to a web page outside of Security Command + # Center where additional information about the finding can be found. This field + # is guaranteed to be either empty or a well formed URL. # Corresponds to the JSON property `externalUri` # @return [String] attr_accessor :external_uri - # The relative resource name of this finding. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`" + # The relative resource name of this finding. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`" # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The relative resource name of the source the finding belongs to. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # This field is immutable after creation time. - # For example: - # "organizations/`organization_id`/sources/`source_id`" + # The relative resource name of the source the finding belongs to. See: https:// + # cloud.google.com/apis/design/resource_names#relative_resource_name This field + # is immutable after creation time. For example: "organizations/`organization_id` + # /sources/`source_id`" # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # For findings on Google Cloud resources, the full resource - # name of the Google Cloud resource this finding is for. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name - # When the finding is for a non-Google Cloud resource, the resourceName can - # be a customer or partner defined string. This field is immutable after - # creation time. + # For findings on Google Cloud resources, the full resource name of the Google + # Cloud resource this finding is for. See: https://cloud.google.com/apis/design/ + # resource_names#full_resource_name When the finding is for a non-Google Cloud + # resource, the resourceName can be a customer or partner defined string. This + # field is immutable after creation time. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] attr_accessor :security_marks - # Source specific properties. These properties are managed by the source - # that writes the finding. The key names in the source_properties map must be - # between 1 and 255 characters, and must start with a letter and contain - # alphanumeric characters or underscores only. + # Source specific properties. These properties are managed by the source that + # writes the finding. The key names in the source_properties map must be between + # 1 and 255 characters, and must start with a letter and contain alphanumeric + # characters or underscores only. # Corresponds to the JSON property `sourceProperties` # @return [Hash] attr_accessor :source_properties @@ -998,14 +901,12 @@ module Google # Cloud IAM Policy information associated with the Google Cloud resource # described by the Security Command Center asset. This information is managed - # and defined by the Google Cloud resource and cannot be modified by the - # user. + # and defined by the Google Cloud resource and cannot be modified by the user. class GoogleCloudSecuritycenterV1p1beta1IamPolicy include Google::Apis::Core::Hashable - # The JSON representation of the Policy associated with the asset. - # See https://cloud.google.com/iam/docs/reference/rest/v1/Policy for - # format details. + # The JSON representation of the Policy associated with the asset. See https:// + # cloud.google.com/iam/docs/reference/rest/v1/Policy for format details. # Corresponds to the JSON property `policyBlob` # @return [String] attr_accessor :policy_blob @@ -1024,11 +925,10 @@ module Google class GoogleCloudSecuritycenterV1p1beta1NotificationMessage include Google::Apis::Core::Hashable - # Security Command Center finding. - # A finding is a record of assessment data (security, risk, health or privacy) - # ingested into Security Command Center for presentation, notification, - # analysis, policy testing, and enforcement. For example, an XSS vulnerability - # in an App Engine application is a finding. + # Security Command Center finding. A finding is a record of assessment data ( + # security, risk, health or privacy) ingested into Security Command Center for + # presentation, notification, analysis, policy testing, and enforcement. For + # example, an XSS vulnerability in an App Engine application is a finding. # Corresponds to the JSON property `finding` # @return [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1p1beta1Finding] attr_accessor :finding @@ -1043,8 +943,8 @@ module Google # @return [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1p1beta1Resource] attr_accessor :resource - # Wrapper over asset object that also captures the state change for the asset - # e.g. if it was a newly created asset vs updated or deleted asset. + # Wrapper over asset object that also captures the state change for the asset e. + # g. if it was a newly created asset vs updated or deleted asset. # Corresponds to the JSON property `temporalAsset` # @return [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1p1beta1TemporalAsset] attr_accessor :temporal_asset @@ -1066,8 +966,8 @@ module Google class GoogleCloudSecuritycenterV1p1beta1Resource include Google::Apis::Core::Hashable - # The full resource name of the resource. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the resource. See: https://cloud.google.com/apis/ + # design/resource_names#full_resource_name # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1141,9 +1041,9 @@ module Google # @return [String] attr_accessor :resource_display_name - # The full resource name of the Google Cloud resource this asset - # represents. This field is immutable after create time. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the Google Cloud resource this asset represents. + # This field is immutable after create time. See: https://cloud.google.com/apis/ + # design/resource_names#full_resource_name # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name @@ -1153,8 +1053,8 @@ module Google # @return [Array] attr_accessor :resource_owners - # The full resource name of the immediate parent of the resource. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the immediate parent of the resource. See: https:// + # cloud.google.com/apis/design/resource_names#full_resource_name # Corresponds to the JSON property `resourceParent` # @return [String] attr_accessor :resource_parent @@ -1164,8 +1064,8 @@ module Google # @return [String] attr_accessor :resource_parent_display_name - # The full resource name of the project the resource belongs to. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the project the resource belongs to. See: https:// + # cloud.google.com/apis/design/resource_names#full_resource_name # Corresponds to the JSON property `resourceProject` # @return [String] attr_accessor :resource_project @@ -1175,10 +1075,9 @@ module Google # @return [String] attr_accessor :resource_project_display_name - # The type of the Google Cloud resource. Examples include: APPLICATION, - # PROJECT, and ORGANIZATION. This is a case insensitive field defined by - # Security Command Center and/or the producer of the resource and is - # immutable after create time. + # The type of the Google Cloud resource. Examples include: APPLICATION, PROJECT, + # and ORGANIZATION. This is a case insensitive field defined by Security Command + # Center and/or the producer of the resource and is immutable after create time. # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type @@ -1200,30 +1099,26 @@ module Google end end - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. class GoogleCloudSecuritycenterV1p1beta1SecurityMarks include Google::Apis::Core::Hashable # Mutable user specified security marks belonging to the parent resource. - # Constraints are as follows: - # * Keys and values are treated as case insensitive - # * Keys must be between 1 - 256 characters (inclusive) - # * Keys must be letters, numbers, underscores, or dashes - # * Values have leading and trailing whitespace trimmed, remaining - # characters must be between 1 - 4096 characters (inclusive) + # Constraints are as follows: * Keys and values are treated as case insensitive * + # Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, + # numbers, underscores, or dashes * Values have leading and trailing whitespace + # trimmed, remaining characters must be between 1 - 4096 characters (inclusive) # Corresponds to the JSON property `marks` # @return [Hash] attr_accessor :marks - # The relative resource name of the SecurityMarks. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Examples: - # "organizations/`organization_id`/assets/`asset_id`/securityMarks" - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/ - # securityMarks". + # The relative resource name of the SecurityMarks. See: https://cloud.google.com/ + # apis/design/resource_names#relative_resource_name Examples: "organizations/` + # organization_id`/assets/`asset_id`/securityMarks" "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1239,17 +1134,16 @@ module Google end end - # Wrapper over asset object that also captures the state change for the asset - # e.g. if it was a newly created asset vs updated or deleted asset. + # Wrapper over asset object that also captures the state change for the asset e. + # g. if it was a newly created asset vs updated or deleted asset. class GoogleCloudSecuritycenterV1p1beta1TemporalAsset include Google::Apis::Core::Hashable - # Security Command Center representation of a Google Cloud - # resource. - # The Asset is a Security Command Center resource that captures information - # about a single Google Cloud resource. All modifications to an Asset are only - # within the context of Security Command Center and don't affect the referenced - # Google Cloud resource. + # Security Command Center representation of a Google Cloud resource. The Asset + # is a Security Command Center resource that captures information about a single + # Google Cloud resource. All modifications to an Asset are only within the + # context of Security Command Center and don't affect the referenced Google + # Cloud resource. # Corresponds to the JSON property `asset` # @return [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1p1beta1Asset] attr_accessor :asset @@ -1275,83 +1169,67 @@ module Google include Google::Apis::Core::Hashable # When compare_duration is set, the Asset's "state" property is updated to - # indicate whether the asset was added, removed, or remained present during - # the compare_duration period of time that precedes the read_time. This is - # the time between (read_time - compare_duration) and read_time. - # The state value is derived based on the presence of the asset at the two - # points in time. Intermediate state changes between the two times don't - # affect the result. For example, the results aren't affected if the asset is - # removed and re-created again. - # Possible "state" values when compare_duration is specified: - # * "ADDED": indicates that the asset was not present before - # compare_duration, but present at reference_time. - # * "REMOVED": indicates that the asset was present at the start of - # compare_duration, but not present at reference_time. - # * "ACTIVE": indicates that the asset was present at both the - # start and the end of the time period defined by - # compare_duration and reference_time. - # This field is ignored if `state` is not a field in `group_by`. + # indicate whether the asset was added, removed, or remained present during the + # compare_duration period of time that precedes the read_time. This is the time + # between (read_time - compare_duration) and read_time. The state value is + # derived based on the presence of the asset at the two points in time. + # Intermediate state changes between the two times don't affect the result. For + # example, the results aren't affected if the asset is removed and re-created + # again. Possible "state" values when compare_duration is specified: * "ADDED": + # indicates that the asset was not present before compare_duration, but present + # at reference_time. * "REMOVED": indicates that the asset was present at the + # start of compare_duration, but not present at reference_time. * "ACTIVE": + # indicates that the asset was present at both the start and the end of the time + # period defined by compare_duration and reference_time. This field is ignored + # if `state` is not a field in `group_by`. # Corresponds to the JSON property `compareDuration` # @return [String] attr_accessor :compare_duration - # Expression that defines the filter to apply across assets. - # The expression is a list of zero or more restrictions combined via logical - # operators `AND` and `OR`. - # Parentheses are not supported, and `OR` has higher precedence than `AND`. - # Restrictions have the form ` ` and may have a `-` - # character in front of them to indicate negation. The fields map to those - # defined in the Asset resource. Examples include: - # * name - # * security_center_properties.resource_name - # * resource_properties.a_property - # * security_marks.marks.marka - # The supported operators are: - # * `=` for all value types. - # * `>`, `<`, `>=`, `<=` for integer values. - # * `:`, meaning substring matching, for strings. - # The supported value types are: - # * string literals in quotes. - # * integer literals without quotes. - # * boolean literals `true` and `false` without quotes. - # For example, `resource_properties.size = 100` is a valid filter string. + # Expression that defines the filter to apply across assets. The expression is a + # list of zero or more restrictions combined via logical operators `AND` and `OR` + # . Parentheses are not supported, and `OR` has higher precedence than `AND`. + # Restrictions have the form ` ` and may have a `-` character in front of them + # to indicate negation. The fields map to those defined in the Asset resource. + # Examples include: * name * security_center_properties.resource_name * + # resource_properties.a_property * security_marks.marks.marka The supported + # operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer + # values. * `:`, meaning substring matching, for strings. The supported value + # types are: * string literals in quotes. * integer literals without quotes. * + # boolean literals `true` and `false` without quotes. For example, ` + # resource_properties.size = 100` is a valid filter string. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter # Required. Expression that defines what assets fields to use for grouping. The - # string - # value should follow SQL syntax: comma separated list of fields. For - # example: - # "security_center_properties.resource_project,security_center_properties. - # project". - # The following fields are supported when compare_duration is not set: - # * security_center_properties.resource_project - # * security_center_properties.resource_type - # * security_center_properties.resource_parent - # The following fields are supported when compare_duration is set: - # * security_center_properties.resource_type + # string value should follow SQL syntax: comma separated list of fields. For + # example: "security_center_properties.resource_project, + # security_center_properties.project". The following fields are supported when + # compare_duration is not set: * security_center_properties.resource_project * + # security_center_properties.resource_type * security_center_properties. + # resource_parent The following fields are supported when compare_duration is + # set: * security_center_properties.resource_type # Corresponds to the JSON property `groupBy` # @return [String] attr_accessor :group_by - # The maximum number of results to return in a single response. Default is - # 10, minimum is 1, maximum is 1000. + # The maximum number of results to return in a single response. Default is 10, + # minimum is 1, maximum is 1000. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size - # The value returned by the last `GroupAssetsResponse`; indicates - # that this is a continuation of a prior `GroupAssets` call, and that the - # system should return the next page of data. + # The value returned by the last `GroupAssetsResponse`; indicates that this is a + # continuation of a prior `GroupAssets` call, and that the system should return + # the next page of data. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token - # Time used as a reference point when filtering assets. The filter is limited - # to assets existing at the supplied time and their values are those at that - # specific time. Absence of this field will default to the API's version of - # NOW. + # Time used as a reference point when filtering assets. The filter is limited to + # assets existing at the supplied time and their values are those at that + # specific time. Absence of this field will default to the API's version of NOW. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -1375,9 +1253,9 @@ module Google class GroupAssetsResponse include Google::Apis::Core::Hashable - # Group results. There exists an element for each existing unique - # combination of property/values. The element contains a count for the number - # of times those specific property/values appear. + # Group results. There exists an element for each existing unique combination of + # property/values. The element contains a count for the number of times those + # specific property/values appear. # Corresponds to the JSON property `groupByResults` # @return [Array] attr_accessor :group_by_results @@ -1409,59 +1287,45 @@ module Google class GroupFindingsRequest include Google::Apis::Core::Hashable - # Expression that defines the filter to apply across findings. - # The expression is a list of one or more restrictions combined via logical - # operators `AND` and `OR`. - # Parentheses are not supported, and `OR` has higher precedence than `AND`. - # Restrictions have the form ` ` and may have a `-` - # character in front of them to indicate negation. Examples include: - # * name - # * source_properties.a_property - # * security_marks.marks.marka - # The supported operators are: - # * `=` for all value types. - # * `>`, `<`, `>=`, `<=` for integer values. - # * `:`, meaning substring matching, for strings. - # The supported value types are: - # * string literals in quotes. - # * integer literals without quotes. - # * boolean literals `true` and `false` without quotes. - # For example, `source_properties.size = 100` is a valid filter string. + # Expression that defines the filter to apply across findings. The expression is + # a list of one or more restrictions combined via logical operators `AND` and ` + # OR`. Parentheses are not supported, and `OR` has higher precedence than `AND`. + # Restrictions have the form ` ` and may have a `-` character in front of them + # to indicate negation. Examples include: * name * source_properties.a_property * + # security_marks.marks.marka The supported operators are: * `=` for all value + # types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring + # matching, for strings. The supported value types are: * string literals in + # quotes. * integer literals without quotes. * boolean literals `true` and ` + # false` without quotes. For example, `source_properties.size = 100` is a valid + # filter string. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter # Required. Expression that defines what assets fields to use for grouping ( - # including - # `state`). The string value should follow SQL syntax: comma separated list - # of fields. For example: - # "parent,resource_name". - # The following fields are supported: - # * resource_name - # * category - # * state - # * parent + # including `state`). The string value should follow SQL syntax: comma separated + # list of fields. For example: "parent,resource_name". The following fields are + # supported: * resource_name * category * state * parent # Corresponds to the JSON property `groupBy` # @return [String] attr_accessor :group_by - # The maximum number of results to return in a single response. Default is - # 10, minimum is 1, maximum is 1000. + # The maximum number of results to return in a single response. Default is 10, + # minimum is 1, maximum is 1000. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size - # The value returned by the last `GroupFindingsResponse`; indicates - # that this is a continuation of a prior `GroupFindings` call, and - # that the system should return the next page of data. + # The value returned by the last `GroupFindingsResponse`; indicates that this is + # a continuation of a prior `GroupFindings` call, and that the system should + # return the next page of data. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token - # Time used as a reference point when filtering findings. The filter is - # limited to findings existing at the supplied time and their values are - # those at that specific time. Absence of this field will default to the - # API's version of NOW. + # Time used as a reference point when filtering findings. The filter is limited + # to findings existing at the supplied time and their values are those at that + # specific time. Absence of this field will default to the API's version of NOW. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -1484,9 +1348,9 @@ module Google class GroupFindingsResponse include Google::Apis::Core::Hashable - # Group results. There exists an element for each existing unique - # combination of property/values. The element contains a count for the number - # of times those specific property/values appear. + # Group results. There exists an element for each existing unique combination of + # property/values. The element contains a count for the number of times those + # specific property/values appear. # Corresponds to the JSON property `groupByResults` # @return [Array] attr_accessor :group_by_results @@ -1581,12 +1445,11 @@ module Google class ListAssetsResult include Google::Apis::Core::Hashable - # Security Command Center representation of a Google Cloud - # resource. - # The Asset is a Security Command Center resource that captures information - # about a single Google Cloud resource. All modifications to an Asset are only - # within the context of Security Command Center and don't affect the referenced - # Google Cloud resource. + # Security Command Center representation of a Google Cloud resource. The Asset + # is a Security Command Center resource that captures information about a single + # Google Cloud resource. All modifications to an Asset are only within the + # context of Security Command Center and don't affect the referenced Google + # Cloud resource. # Corresponds to the JSON property `asset` # @return [Google::Apis::SecuritycenterV1beta1::Asset] attr_accessor :asset @@ -1701,47 +1564,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::SecuritycenterV1beta1::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 @@ -1760,8 +1621,8 @@ module Google end end - # User specified settings that are attached to the Security Command - # Center organization. + # User specified settings that are attached to the Security Command Center + # organization. class OrganizationSettings include Google::Apis::Core::Hashable @@ -1770,19 +1631,17 @@ module Google # @return [Google::Apis::SecuritycenterV1beta1::AssetDiscoveryConfig] attr_accessor :asset_discovery_config - # A flag that indicates if Asset Discovery should be enabled. If the flag is - # set to `true`, then discovery of assets will occur. If it is set to `false, - # all historical assets will remain, but discovery of future assets will not - # occur. + # A flag that indicates if Asset Discovery should be enabled. If the flag is set + # to `true`, then discovery of assets will occur. If it is set to `false, all + # historical assets will remain, but discovery of future assets will not occur. # Corresponds to the JSON property `enableAssetDiscovery` # @return [Boolean] attr_accessor :enable_asset_discovery alias_method :enable_asset_discovery?, :enable_asset_discovery - # The relative resource name of the settings. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/organizationSettings". + # The relative resource name of the settings. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/organizationSettings". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1800,66 +1659,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 @@ -1868,48 +1693,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 @@ -1946,8 +1767,8 @@ module Google include Google::Apis::Core::Hashable # Immutable. The full resource name of the Google Cloud resource this asset - # represents. This field is immutable after create time. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # represents. This field is immutable after create time. See: https://cloud. + # google.com/apis/design/resource_names#full_resource_name # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name @@ -1957,22 +1778,21 @@ module Google # @return [Array] attr_accessor :resource_owners - # The full resource name of the immediate parent of the resource. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the immediate parent of the resource. See: https:// + # cloud.google.com/apis/design/resource_names#full_resource_name # Corresponds to the JSON property `resourceParent` # @return [String] attr_accessor :resource_parent - # The full resource name of the project the resource belongs to. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the project the resource belongs to. See: https:// + # cloud.google.com/apis/design/resource_names#full_resource_name # Corresponds to the JSON property `resourceProject` # @return [String] attr_accessor :resource_project - # The type of the Google Cloud resource. Examples include: APPLICATION, - # PROJECT, and ORGANIZATION. This is a case insensitive field defined by - # Security Command Center and/or the producer of the resource and is - # immutable after create time. + # The type of the Google Cloud resource. Examples include: APPLICATION, PROJECT, + # and ORGANIZATION. This is a case insensitive field defined by Security Command + # Center and/or the producer of the resource and is immutable after create time. # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type @@ -1991,30 +1811,26 @@ module Google end end - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. class SecurityMarks include Google::Apis::Core::Hashable # Mutable user specified security marks belonging to the parent resource. - # Constraints are as follows: - # * Keys and values are treated as case insensitive - # * Keys must be between 1 - 256 characters (inclusive) - # * Keys must be letters, numbers, underscores, or dashes - # * Values have leading and trailing whitespace trimmed, remaining - # characters must be between 1 - 4096 characters (inclusive) + # Constraints are as follows: * Keys and values are treated as case insensitive * + # Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, + # numbers, underscores, or dashes * Values have leading and trailing whitespace + # trimmed, remaining characters must be between 1 - 4096 characters (inclusive) # Corresponds to the JSON property `marks` # @return [Hash] attr_accessor :marks - # The relative resource name of the SecurityMarks. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Examples: - # "organizations/`organization_id`/assets/`asset_id`/securityMarks" - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/ - # securityMarks". + # The relative resource name of the SecurityMarks. See: https://cloud.google.com/ + # apis/design/resource_names#relative_resource_name Examples: "organizations/` + # organization_id`/assets/`asset_id`/securityMarks" "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2060,74 +1876,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::SecuritycenterV1beta1::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 @@ -2143,36 +1924,32 @@ module Google end end - # Security Command Center finding source. A finding source - # is an entity or a mechanism that can produce a finding. A source is like a - # container of findings that come from the same scanner, logger, monitor, etc. + # Security Command Center finding source. A finding source is an entity or a + # mechanism that can produce a finding. A source is like a container of findings + # that come from the same scanner, logger, monitor, etc. class Source include Google::Apis::Core::Hashable - # The description of the source (max of 1024 characters). - # Example: - # "Web Security Scanner is a web security scanner for common - # vulnerabilities in App Engine applications. It can automatically - # scan and detect four common vulnerabilities, including cross-site-scripting - # (XSS), Flash injection, mixed content (HTTP in HTTPS), and - # outdated/insecure libraries." + # The description of the source (max of 1024 characters). Example: "Web Security + # Scanner is a web security scanner for common vulnerabilities in App Engine + # applications. It can automatically scan and detect four common vulnerabilities, + # including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in + # HTTPS), and outdated/insecure libraries." # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # The source's display name. - # A source's display name must be unique amongst its siblings, for example, - # two sources with the same parent can't share the same display name. - # The display name must have a length between 1 and 64 characters - # (inclusive). + # The source's display name. A source's display name must be unique amongst its + # siblings, for example, two sources with the same parent can't share the same + # display name. The display name must have a length between 1 and 64 characters ( + # inclusive). # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # The relative resource name of this source. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/sources/`source_id`" + # The relative resource name of this source. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/sources/`source_id`" # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2189,12 +1966,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 @@ -2203,15 +1980,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 @@ -2232,10 +2009,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 @@ -2254,8 +2030,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 diff --git a/generated/google/apis/securitycenter_v1beta1/service.rb b/generated/google/apis/securitycenter_v1beta1/service.rb index 7154ab447..f8aa2ccb4 100644 --- a/generated/google/apis/securitycenter_v1beta1/service.rb +++ b/generated/google/apis/securitycenter_v1beta1/service.rb @@ -51,8 +51,7 @@ module Google # Gets the settings for an organization. # @param [String] name # Required. Name of the organization to get organization settings for. Its - # format is - # "organizations/[organization_id]/organizationSettings". + # format is "organizations/[organization_id]/organizationSettings". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -82,10 +81,9 @@ module Google # Updates an organization's settings. # @param [String] name - # The relative resource name of the settings. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/organizationSettings". + # The relative resource name of the settings. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/organizationSettings". # @param [Google::Apis::SecuritycenterV1beta1::OrganizationSettings] organization_settings_object # @param [String] update_mask # The FieldMask to use when updating the settings resource. @@ -119,11 +117,10 @@ module Google execute_or_queue_command(command, &block) end - # Filters an organization's assets and groups them by their specified - # properties. + # Filters an organization's assets and groups them by their specified properties. # @param [String] parent - # Required. Name of the organization to groupBy. Its format is - # "organizations/[organization_id]". + # Required. Name of the organization to groupBy. Its format is "organizations/[ + # organization_id]". # @param [Google::Apis::SecuritycenterV1beta1::GroupAssetsRequest] group_assets_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -156,75 +153,60 @@ module Google # Lists an organization's assets. # @param [String] parent - # Required. Name of the organization assets should belong to. Its format is - # "organizations/[organization_id]". + # Required. Name of the organization assets should belong to. Its format is " + # organizations/[organization_id]". # @param [String] compare_duration # When compare_duration is set, the ListAssetResult's "state" attribute is - # updated to indicate whether the asset was added, removed, or remained - # present during the compare_duration period of time that precedes the - # read_time. This is the time between (read_time - - # compare_duration) and read_time. - # The state value is derived based on the presence of the asset at the two - # points in time. Intermediate state changes between the two times don't - # affect the result. For example, the results aren't affected if the asset is - # removed and re-created again. - # Possible "state" values when compare_duration is specified: - # * "ADDED": indicates that the asset was not present before - # compare_duration, but present at read_time. - # * "REMOVED": indicates that the asset was present at the start of - # compare_duration, but not present at read_time. - # * "ACTIVE": indicates that the asset was present at both the - # start and the end of the time period defined by - # compare_duration and read_time. - # If compare_duration is not specified, then the only possible state is - # "UNUSED", which indicates that the asset is present at read_time. + # updated to indicate whether the asset was added, removed, or remained present + # during the compare_duration period of time that precedes the read_time. This + # is the time between (read_time - compare_duration) and read_time. The state + # value is derived based on the presence of the asset at the two points in time. + # Intermediate state changes between the two times don't affect the result. For + # example, the results aren't affected if the asset is removed and re-created + # again. Possible "state" values when compare_duration is specified: * "ADDED": + # indicates that the asset was not present before compare_duration, but present + # at read_time. * "REMOVED": indicates that the asset was present at the start + # of compare_duration, but not present at read_time. * "ACTIVE": indicates that + # the asset was present at both the start and the end of the time period defined + # by compare_duration and read_time. If compare_duration is not specified, then + # the only possible state is "UNUSED", which indicates that the asset is present + # at read_time. # @param [String] field_mask # Optional. A field mask to specify the ListAssetsResult fields to be listed in - # the - # response. - # An empty field mask will list all fields. + # the response. An empty field mask will list all fields. # @param [String] filter - # Expression that defines the filter to apply across assets. - # The expression is a list of zero or more restrictions combined via logical - # operators `AND` and `OR`. - # Parentheses are not supported, and `OR` has higher precedence than `AND`. - # Restrictions have the form ` ` and may have a `-` - # character in front of them to indicate negation. The fields map to those - # defined in the Asset resource. Examples include: - # * name - # * security_center_properties.resource_name - # * resource_properties.a_property - # * security_marks.marks.marka - # The supported operators are: - # * `=` for all value types. - # * `>`, `<`, `>=`, `<=` for integer values. - # * `:`, meaning substring matching, for strings. - # The supported value types are: - # * string literals in quotes. - # * integer literals without quotes. - # * boolean literals `true` and `false` without quotes. - # For example, `resource_properties.size = 100` is a valid filter string. + # Expression that defines the filter to apply across assets. The expression is a + # list of zero or more restrictions combined via logical operators `AND` and `OR` + # . Parentheses are not supported, and `OR` has higher precedence than `AND`. + # Restrictions have the form ` ` and may have a `-` character in front of them + # to indicate negation. The fields map to those defined in the Asset resource. + # Examples include: * name * security_center_properties.resource_name * + # resource_properties.a_property * security_marks.marks.marka The supported + # operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer + # values. * `:`, meaning substring matching, for strings. The supported value + # types are: * string literals in quotes. * integer literals without quotes. * + # boolean literals `true` and `false` without quotes. For example, ` + # resource_properties.size = 100` is a valid filter string. # @param [String] order_by - # Expression that defines what fields and order to use for sorting. The - # string value should follow SQL syntax: comma separated list of fields. For - # example: "name,resource_properties.a_property". The default sorting order - # is ascending. To specify descending order for a field, a suffix " desc" - # should be appended to the field name. For example: "name - # desc,resource_properties.a_property". Redundant space characters in the - # syntax are insignificant. "name desc,resource_properties.a_property" and " - # name desc , resource_properties.a_property " are equivalent. + # Expression that defines what fields and order to use for sorting. The string + # value should follow SQL syntax: comma separated list of fields. For example: " + # name,resource_properties.a_property". The default sorting order is ascending. + # To specify descending order for a field, a suffix " desc" should be appended + # to the field name. For example: "name desc,resource_properties.a_property". + # Redundant space characters in the syntax are insignificant. "name desc, + # resource_properties.a_property" and " name desc , resource_properties. + # a_property " are equivalent. # @param [Fixnum] page_size - # The maximum number of results to return in a single response. Default is - # 10, minimum is 1, maximum is 1000. + # The maximum number of results to return in a single response. Default is 10, + # minimum is 1, maximum is 1000. # @param [String] page_token - # The value returned by the last `ListAssetsResponse`; indicates - # that this is a continuation of a prior `ListAssets` call, and - # that the system should return the next page of data. + # The value returned by the last `ListAssetsResponse`; indicates that this is a + # continuation of a prior `ListAssets` call, and that the system should return + # the next page of data. # @param [String] read_time - # Time used as a reference point when filtering assets. The filter is limited - # to assets existing at the supplied time and their values are those at that - # specific time. Absence of this field will default to the API's version of - # NOW. + # Time used as a reference point when filtering assets. The filter is limited to + # assets existing at the supplied time and their values are those at that + # specific time. Absence of this field will default to the API's version of NOW. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -259,14 +241,12 @@ module Google execute_or_queue_command(command, &block) end - # Runs asset discovery. The discovery is tracked with a long-running - # operation. - # This API can only be called with limited frequency for an organization. If - # it is called too frequently the caller will receive a TOO_MANY_REQUESTS - # error. + # Runs asset discovery. The discovery is tracked with a long-running operation. + # This API can only be called with limited frequency for an organization. If it + # is called too frequently the caller will receive a TOO_MANY_REQUESTS error. # @param [String] parent - # Required. Name of the organization to run asset discovery for. Its format is - # "organizations/[organization_id]". + # Required. Name of the organization to run asset discovery for. Its format is " + # organizations/[organization_id]". # @param [Google::Apis::SecuritycenterV1beta1::RunAssetDiscoveryRequest] run_asset_discovery_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -299,12 +279,10 @@ module Google # Updates security marks. # @param [String] name - # The relative resource name of the SecurityMarks. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Examples: - # "organizations/`organization_id`/assets/`asset_id`/securityMarks" - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/ - # securityMarks". + # The relative resource name of the SecurityMarks. See: https://cloud.google.com/ + # apis/design/resource_names#relative_resource_name Examples: "organizations/` + # organization_id`/assets/`asset_id`/securityMarks" "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks". # @param [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1beta1SecurityMarks] google_cloud_securitycenter_v1beta1_security_marks_object # @param [String] start_time # The time at which the updated SecurityMarks take effect. @@ -341,15 +319,13 @@ module Google 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, + # 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. @@ -383,10 +359,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 @@ -416,9 +392,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 @@ -448,15 +423,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 @@ -497,8 +471,8 @@ module Google # Creates a source. # @param [String] parent - # Required. Resource name of the new source's parent. Its format should be - # "organizations/[organization_id]". + # Required. Resource name of the new source's parent. Its format should be " + # organizations/[organization_id]". # @param [Google::Apis::SecuritycenterV1beta1::Source] source_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -531,8 +505,8 @@ module Google # Gets a source. # @param [String] name - # Required. Relative resource name of the source. Its format is - # "organizations/[organization_id]/source/[source_id]". + # Required. Relative resource name of the source. Its format is "organizations/[ + # organization_id]/source/[source_id]". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -562,8 +536,8 @@ module Google # Gets the access control policy on the specified Source. # @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::SecuritycenterV1beta1::GetIamPolicyRequest] get_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -599,12 +573,12 @@ module Google # Required. Resource name of the parent of sources to list. Its format should be # "organizations/[organization_id]". # @param [Fixnum] page_size - # The maximum number of results to return in a single response. Default is - # 10, minimum is 1, maximum is 1000. + # The maximum number of results to return in a single response. Default is 10, + # minimum is 1, maximum is 1000. # @param [String] page_token - # The value returned by the last `ListSourcesResponse`; indicates - # that this is a continuation of a prior `ListSources` call, and - # that the system should return the next page of data. + # The value returned by the last `ListSourcesResponse`; indicates that this is a + # continuation of a prior `ListSources` call, and that the system should return + # the next page of data. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -636,10 +610,9 @@ module Google # Updates a source. # @param [String] name - # The relative resource name of this source. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/sources/`source_id`" + # The relative resource name of this source. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/sources/`source_id`" # @param [Google::Apis::SecuritycenterV1beta1::Source] source_object # @param [String] update_mask # The FieldMask to use when updating the source resource. @@ -675,8 +648,8 @@ module Google # Sets the access control policy on the specified Source. # @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::SecuritycenterV1beta1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -709,8 +682,8 @@ module Google # Returns the permissions that a caller has on the specified source. # @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::SecuritycenterV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -741,16 +714,16 @@ module Google execute_or_queue_command(command, &block) end - # Creates a finding. The corresponding source must exist for finding creation - # to succeed. + # Creates a finding. The corresponding source must exist for finding creation to + # succeed. # @param [String] parent - # Required. Resource name of the new finding's parent. Its format should be - # "organizations/[organization_id]/sources/[source_id]". + # Required. Resource name of the new finding's parent. Its format should be " + # organizations/[organization_id]/sources/[source_id]". # @param [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1beta1Finding] google_cloud_securitycenter_v1beta1_finding_object # @param [String] finding_id - # Required. Unique identifier provided by the client within the parent scope. - # It must be alphanumeric and less than or equal to 32 characters and - # greater than 0 characters in length. + # Required. Unique identifier provided by the client within the parent scope. It + # must be alphanumeric and less than or equal to 32 characters and greater than + # 0 characters in length. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -781,15 +754,13 @@ module Google execute_or_queue_command(command, &block) end - # Filters an organization or source's findings and groups them by their - # specified properties. - # To group across all sources provide a `-` as the source id. - # Example: /v1beta1/organizations/`organization_id`/sources/-/findings + # Filters an organization or source's findings and groups them by their + # specified properties. To group across all sources provide a `-` as the source + # id. Example: /v1beta1/organizations/`organization_id`/sources/-/findings # @param [String] parent - # Required. Name of the source to groupBy. Its format is - # "organizations/[organization_id]/sources/[source_id]". To groupBy across - # all sources provide a source_id of `-`. For example: - # organizations/`organization_id`/sources/- + # Required. Name of the source to groupBy. Its format is "organizations/[ + # organization_id]/sources/[source_id]". To groupBy across all sources provide a + # source_id of `-`. For example: organizations/`organization_id`/sources/- # @param [Google::Apis::SecuritycenterV1beta1::GroupFindingsRequest] group_findings_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -820,58 +791,49 @@ module Google execute_or_queue_command(command, &block) end - # Lists an organization or source's findings. - # To list across all sources provide a `-` as the source id. - # Example: /v1beta1/organizations/`organization_id`/sources/-/findings + # Lists an organization or source's findings. To list across all sources provide + # a `-` as the source id. Example: /v1beta1/organizations/`organization_id`/ + # sources/-/findings # @param [String] parent - # Required. Name of the source the findings belong to. Its format is - # "organizations/[organization_id]/sources/[source_id]". To list across all - # sources provide a source_id of `-`. For example: - # organizations/`organization_id`/sources/- + # Required. Name of the source the findings belong to. Its format is " + # organizations/[organization_id]/sources/[source_id]". To list across all + # sources provide a source_id of `-`. For example: organizations/` + # organization_id`/sources/- # @param [String] field_mask # Optional. A field mask to specify the Finding fields to be listed in the - # response. - # An empty field mask will list all fields. + # response. An empty field mask will list all fields. # @param [String] filter - # Expression that defines the filter to apply across findings. - # The expression is a list of one or more restrictions combined via logical - # operators `AND` and `OR`. - # Parentheses are not supported, and `OR` has higher precedence than `AND`. - # Restrictions have the form ` ` and may have a `-` - # character in front of them to indicate negation. Examples include: - # * name - # * source_properties.a_property - # * security_marks.marks.marka - # The supported operators are: - # * `=` for all value types. - # * `>`, `<`, `>=`, `<=` for integer values. - # * `:`, meaning substring matching, for strings. - # The supported value types are: - # * string literals in quotes. - # * integer literals without quotes. - # * boolean literals `true` and `false` without quotes. - # For example, `source_properties.size = 100` is a valid filter string. + # Expression that defines the filter to apply across findings. The expression is + # a list of one or more restrictions combined via logical operators `AND` and ` + # OR`. Parentheses are not supported, and `OR` has higher precedence than `AND`. + # Restrictions have the form ` ` and may have a `-` character in front of them + # to indicate negation. Examples include: * name * source_properties.a_property * + # security_marks.marks.marka The supported operators are: * `=` for all value + # types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring + # matching, for strings. The supported value types are: * string literals in + # quotes. * integer literals without quotes. * boolean literals `true` and ` + # false` without quotes. For example, `source_properties.size = 100` is a valid + # filter string. # @param [String] order_by - # Expression that defines what fields and order to use for sorting. The - # string value should follow SQL syntax: comma separated list of fields. For - # example: "name,resource_properties.a_property". The default sorting order - # is ascending. To specify descending order for a field, a suffix " desc" - # should be appended to the field name. For example: "name - # desc,source_properties.a_property". Redundant space characters in the - # syntax are insignificant. "name desc,source_properties.a_property" and " - # name desc , source_properties.a_property " are equivalent. + # Expression that defines what fields and order to use for sorting. The string + # value should follow SQL syntax: comma separated list of fields. For example: " + # name,resource_properties.a_property". The default sorting order is ascending. + # To specify descending order for a field, a suffix " desc" should be appended + # to the field name. For example: "name desc,source_properties.a_property". + # Redundant space characters in the syntax are insignificant. "name desc, + # source_properties.a_property" and " name desc , source_properties.a_property " + # are equivalent. # @param [Fixnum] page_size - # The maximum number of results to return in a single response. Default is - # 10, minimum is 1, maximum is 1000. + # The maximum number of results to return in a single response. Default is 10, + # minimum is 1, maximum is 1000. # @param [String] page_token - # The value returned by the last `ListFindingsResponse`; indicates - # that this is a continuation of a prior `ListFindings` call, and - # that the system should return the next page of data. + # The value returned by the last `ListFindingsResponse`; indicates that this is + # a continuation of a prior `ListFindings` call, and that the system should + # return the next page of data. # @param [String] read_time - # Time used as a reference point when filtering findings. The filter is - # limited to findings existing at the supplied time and their values are - # those at that specific time. Absence of this field will default to the - # API's version of NOW. + # Time used as a reference point when filtering findings. The filter is limited + # to findings existing at the supplied time and their values are those at that + # specific time. Absence of this field will default to the API's version of NOW. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -908,14 +870,13 @@ module Google # Creates or updates a finding. The corresponding source must exist for a # finding creation to succeed. # @param [String] name - # The relative resource name of this finding. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`" + # The relative resource name of this finding. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`" # @param [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1beta1Finding] google_cloud_securitycenter_v1beta1_finding_object # @param [String] update_mask - # The FieldMask to use when updating the finding resource. This field should - # not be specified when creating a finding. + # The FieldMask to use when updating the finding resource. This field should not + # be specified when creating a finding. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -948,10 +909,9 @@ module Google # Updates the state of a finding. # @param [String] name - # Required. The relative resource name of the finding. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/sources/`source_id`/finding/`finding_id`". + # Required. The relative resource name of the finding. See: https://cloud.google. + # com/apis/design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/sources/`source_id`/finding/`finding_id`". # @param [Google::Apis::SecuritycenterV1beta1::SetFindingStateRequest] set_finding_state_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -984,12 +944,10 @@ module Google # Updates security marks. # @param [String] name - # The relative resource name of the SecurityMarks. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Examples: - # "organizations/`organization_id`/assets/`asset_id`/securityMarks" - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/ - # securityMarks". + # The relative resource name of the SecurityMarks. See: https://cloud.google.com/ + # apis/design/resource_names#relative_resource_name Examples: "organizations/` + # organization_id`/assets/`asset_id`/securityMarks" "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks". # @param [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1beta1SecurityMarks] google_cloud_securitycenter_v1beta1_security_marks_object # @param [String] start_time # The time at which the updated SecurityMarks take effect. diff --git a/generated/google/apis/securitycenter_v1p1alpha1.rb b/generated/google/apis/securitycenter_v1p1alpha1.rb index be36ec3ff..c7030ce3a 100644 --- a/generated/google/apis/securitycenter_v1p1alpha1.rb +++ b/generated/google/apis/securitycenter_v1p1alpha1.rb @@ -26,7 +26,7 @@ module Google # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview module SecuritycenterV1p1alpha1 VERSION = 'V1p1alpha1' - REVISION = '20200605' + REVISION = '20200731' # 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/securitycenter_v1p1alpha1/classes.rb b/generated/google/apis/securitycenter_v1p1alpha1/classes.rb index 29aafd15f..1f57cbae6 100644 --- a/generated/google/apis/securitycenter_v1p1alpha1/classes.rb +++ b/generated/google/apis/securitycenter_v1p1alpha1/classes.rb @@ -22,13 +22,11 @@ module Google module Apis module SecuritycenterV1p1alpha1 - # 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 @@ -41,18 +39,16 @@ module Google end end - # Security Command Center finding. - # A finding is a record of assessment data like security, risk, health, or - # privacy, that is ingested into Security Command Center for presentation, - # notification, analysis, policy testing, and enforcement. For example, a - # cross-site scripting (XSS) vulnerability in an App Engine application is a - # finding. + # Security Command Center finding. A finding is a record of assessment data like + # security, risk, health, or privacy, that is ingested into Security Command + # Center for presentation, notification, analysis, policy testing, and + # enforcement. For example, a cross-site scripting (XSS) vulnerability in an App + # Engine application is a finding. class Finding include Google::Apis::Core::Hashable - # The additional taxonomy group within findings from a given source. - # This field is immutable after creation time. - # Example: "XSS_FLASH_INJECTION" + # The additional taxonomy group within findings from a given source. This field + # is immutable after creation time. Example: "XSS_FLASH_INJECTION" # Corresponds to the JSON property `category` # @return [String] attr_accessor :category @@ -62,59 +58,56 @@ module Google # @return [String] attr_accessor :create_time - # The time at which the event took place. For example, if the finding - # represents an open firewall it would capture the time the detector believes - # the firewall became open. The accuracy is determined by the detector. + # The time at which the event took place. For example, if the finding represents + # an open firewall it would capture the time the detector believes the firewall + # became open. The accuracy is determined by the detector. # Corresponds to the JSON property `eventTime` # @return [String] attr_accessor :event_time - # The URI that, if available, points to a web page outside of Security - # Command Center where additional information about the finding can be found. - # This field is guaranteed to be either empty or a well formed URL. + # The URI that, if available, points to a web page outside of Security Command + # Center where additional information about the finding can be found. This field + # is guaranteed to be either empty or a well formed URL. # Corresponds to the JSON property `externalUri` # @return [String] attr_accessor :external_uri - # The relative resource name of this finding. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`" + # The relative resource name of this finding. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`" # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The relative resource name of the source the finding belongs to. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # This field is immutable after creation time. - # For example: - # "organizations/`organization_id`/sources/`source_id`" + # The relative resource name of the source the finding belongs to. See: https:// + # cloud.google.com/apis/design/resource_names#relative_resource_name This field + # is immutable after creation time. For example: "organizations/`organization_id` + # /sources/`source_id`" # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # For findings on Google Cloud resources, the full resource - # name of the Google Cloud resource this finding is for. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name - # When the finding is for a non-Google Cloud resource, the resourceName can - # be a customer or partner defined string. This field is immutable after - # creation time. + # For findings on Google Cloud resources, the full resource name of the Google + # Cloud resource this finding is for. See: https://cloud.google.com/apis/design/ + # resource_names#full_resource_name When the finding is for a non-Google Cloud + # resource, the resourceName can be a customer or partner defined string. This + # field is immutable after creation time. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1p1alpha1::SecurityMarks] attr_accessor :security_marks - # Source specific properties. These properties are managed by the source - # that writes the finding. The key names in the source_properties map must be - # between 1 and 255 characters, and must start with a letter and contain - # alphanumeric characters or underscores only. + # Source specific properties. These properties are managed by the source that + # writes the finding. The key names in the source_properties map must be between + # 1 and 255 characters, and must start with a letter and contain alphanumeric + # characters or underscores only. # Corresponds to the JSON property `sourceProperties` # @return [Hash] attr_accessor :source_properties @@ -147,12 +140,11 @@ module Google class GoogleCloudSecuritycenterV1NotificationMessage include Google::Apis::Core::Hashable - # Security Command Center finding. - # A finding is a record of assessment data like security, risk, health, or - # privacy, that is ingested into Security Command Center for presentation, - # notification, analysis, policy testing, and enforcement. For example, a - # cross-site scripting (XSS) vulnerability in an App Engine application is a - # finding. + # Security Command Center finding. A finding is a record of assessment data like + # security, risk, health, or privacy, that is ingested into Security Command + # Center for presentation, notification, analysis, policy testing, and + # enforcement. For example, a cross-site scripting (XSS) vulnerability in an App + # Engine application is a finding. # Corresponds to the JSON property `finding` # @return [Google::Apis::SecuritycenterV1p1alpha1::Finding] attr_accessor :finding @@ -183,8 +175,8 @@ module Google class GoogleCloudSecuritycenterV1Resource include Google::Apis::Core::Hashable - # The full resource name of the resource. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the resource. See: https://cloud.google.com/apis/ + # design/resource_names#full_resource_name # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -273,12 +265,11 @@ module Google end end - # Security Command Center representation of a Google Cloud - # resource. - # The Asset is a Security Command Center resource that captures information - # about a single Google Cloud resource. All modifications to an Asset are only - # within the context of Security Command Center and don't affect the referenced - # Google Cloud resource. + # Security Command Center representation of a Google Cloud resource. The Asset + # is a Security Command Center resource that captures information about a single + # Google Cloud resource. All modifications to an Asset are only within the + # context of Security Command Center and don't affect the referenced Google + # Cloud resource. class GoogleCloudSecuritycenterV1p1beta1Asset include Google::Apis::Core::Hashable @@ -289,22 +280,20 @@ module Google # Cloud IAM Policy information associated with the Google Cloud resource # described by the Security Command Center asset. This information is managed - # and defined by the Google Cloud resource and cannot be modified by the - # user. + # and defined by the Google Cloud resource and cannot be modified by the user. # Corresponds to the JSON property `iamPolicy` # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1IamPolicy] attr_accessor :iam_policy - # The relative resource name of this asset. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/assets/`asset_id`". + # The relative resource name of this asset. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/assets/`asset_id`". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Resource managed properties. These properties are managed and defined by - # the Google Cloud resource and cannot be modified by the user. + # Resource managed properties. These properties are managed and defined by the + # Google Cloud resource and cannot be modified by the user. # Corresponds to the JSON property `resourceProperties` # @return [Hash] attr_accessor :resource_properties @@ -315,16 +304,15 @@ module Google # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties] attr_accessor :security_center_properties - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] attr_accessor :security_marks - # The time at which the asset was last updated, added, or deleted in Cloud - # SCC. + # The time at which the asset was last updated, added, or deleted in Cloud SCC. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -345,17 +333,15 @@ module Google end end - # Security Command Center finding. - # A finding is a record of assessment data (security, risk, health or privacy) - # ingested into Security Command Center for presentation, notification, - # analysis, policy testing, and enforcement. For example, an XSS vulnerability - # in an App Engine application is a finding. + # Security Command Center finding. A finding is a record of assessment data ( + # security, risk, health or privacy) ingested into Security Command Center for + # presentation, notification, analysis, policy testing, and enforcement. For + # example, an XSS vulnerability in an App Engine application is a finding. class GoogleCloudSecuritycenterV1p1beta1Finding include Google::Apis::Core::Hashable - # The additional taxonomy group within findings from a given source. - # This field is immutable after creation time. - # Example: "XSS_FLASH_INJECTION" + # The additional taxonomy group within findings from a given source. This field + # is immutable after creation time. Example: "XSS_FLASH_INJECTION" # Corresponds to the JSON property `category` # @return [String] attr_accessor :category @@ -365,59 +351,56 @@ module Google # @return [String] attr_accessor :create_time - # The time at which the event took place. For example, if the finding - # represents an open firewall it would capture the time the detector believes - # the firewall became open. The accuracy is determined by the detector. + # The time at which the event took place. For example, if the finding represents + # an open firewall it would capture the time the detector believes the firewall + # became open. The accuracy is determined by the detector. # Corresponds to the JSON property `eventTime` # @return [String] attr_accessor :event_time - # The URI that, if available, points to a web page outside of Security - # Command Center where additional information about the finding can be found. - # This field is guaranteed to be either empty or a well formed URL. + # The URI that, if available, points to a web page outside of Security Command + # Center where additional information about the finding can be found. This field + # is guaranteed to be either empty or a well formed URL. # Corresponds to the JSON property `externalUri` # @return [String] attr_accessor :external_uri - # The relative resource name of this finding. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`" + # The relative resource name of this finding. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`" # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The relative resource name of the source the finding belongs to. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # This field is immutable after creation time. - # For example: - # "organizations/`organization_id`/sources/`source_id`" + # The relative resource name of the source the finding belongs to. See: https:// + # cloud.google.com/apis/design/resource_names#relative_resource_name This field + # is immutable after creation time. For example: "organizations/`organization_id` + # /sources/`source_id`" # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # For findings on Google Cloud resources, the full resource - # name of the Google Cloud resource this finding is for. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name - # When the finding is for a non-Google Cloud resource, the resourceName can - # be a customer or partner defined string. This field is immutable after - # creation time. + # For findings on Google Cloud resources, the full resource name of the Google + # Cloud resource this finding is for. See: https://cloud.google.com/apis/design/ + # resource_names#full_resource_name When the finding is for a non-Google Cloud + # resource, the resourceName can be a customer or partner defined string. This + # field is immutable after creation time. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] attr_accessor :security_marks - # Source specific properties. These properties are managed by the source - # that writes the finding. The key names in the source_properties map must be - # between 1 and 255 characters, and must start with a letter and contain - # alphanumeric characters or underscores only. + # Source specific properties. These properties are managed by the source that + # writes the finding. The key names in the source_properties map must be between + # 1 and 255 characters, and must start with a letter and contain alphanumeric + # characters or underscores only. # Corresponds to the JSON property `sourceProperties` # @return [Hash] attr_accessor :source_properties @@ -448,14 +431,12 @@ module Google # Cloud IAM Policy information associated with the Google Cloud resource # described by the Security Command Center asset. This information is managed - # and defined by the Google Cloud resource and cannot be modified by the - # user. + # and defined by the Google Cloud resource and cannot be modified by the user. class GoogleCloudSecuritycenterV1p1beta1IamPolicy include Google::Apis::Core::Hashable - # The JSON representation of the Policy associated with the asset. - # See https://cloud.google.com/iam/docs/reference/rest/v1/Policy for - # format details. + # The JSON representation of the Policy associated with the asset. See https:// + # cloud.google.com/iam/docs/reference/rest/v1/Policy for format details. # Corresponds to the JSON property `policyBlob` # @return [String] attr_accessor :policy_blob @@ -474,11 +455,10 @@ module Google class GoogleCloudSecuritycenterV1p1beta1NotificationMessage include Google::Apis::Core::Hashable - # Security Command Center finding. - # A finding is a record of assessment data (security, risk, health or privacy) - # ingested into Security Command Center for presentation, notification, - # analysis, policy testing, and enforcement. For example, an XSS vulnerability - # in an App Engine application is a finding. + # Security Command Center finding. A finding is a record of assessment data ( + # security, risk, health or privacy) ingested into Security Command Center for + # presentation, notification, analysis, policy testing, and enforcement. For + # example, an XSS vulnerability in an App Engine application is a finding. # Corresponds to the JSON property `finding` # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1Finding] attr_accessor :finding @@ -493,8 +473,8 @@ module Google # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1Resource] attr_accessor :resource - # Wrapper over asset object that also captures the state change for the asset - # e.g. if it was a newly created asset vs updated or deleted asset. + # Wrapper over asset object that also captures the state change for the asset e. + # g. if it was a newly created asset vs updated or deleted asset. # Corresponds to the JSON property `temporalAsset` # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1TemporalAsset] attr_accessor :temporal_asset @@ -516,8 +496,8 @@ module Google class GoogleCloudSecuritycenterV1p1beta1Resource include Google::Apis::Core::Hashable - # The full resource name of the resource. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the resource. See: https://cloud.google.com/apis/ + # design/resource_names#full_resource_name # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -591,9 +571,9 @@ module Google # @return [String] attr_accessor :resource_display_name - # The full resource name of the Google Cloud resource this asset - # represents. This field is immutable after create time. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the Google Cloud resource this asset represents. + # This field is immutable after create time. See: https://cloud.google.com/apis/ + # design/resource_names#full_resource_name # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name @@ -603,8 +583,8 @@ module Google # @return [Array] attr_accessor :resource_owners - # The full resource name of the immediate parent of the resource. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the immediate parent of the resource. See: https:// + # cloud.google.com/apis/design/resource_names#full_resource_name # Corresponds to the JSON property `resourceParent` # @return [String] attr_accessor :resource_parent @@ -614,8 +594,8 @@ module Google # @return [String] attr_accessor :resource_parent_display_name - # The full resource name of the project the resource belongs to. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the project the resource belongs to. See: https:// + # cloud.google.com/apis/design/resource_names#full_resource_name # Corresponds to the JSON property `resourceProject` # @return [String] attr_accessor :resource_project @@ -625,10 +605,9 @@ module Google # @return [String] attr_accessor :resource_project_display_name - # The type of the Google Cloud resource. Examples include: APPLICATION, - # PROJECT, and ORGANIZATION. This is a case insensitive field defined by - # Security Command Center and/or the producer of the resource and is - # immutable after create time. + # The type of the Google Cloud resource. Examples include: APPLICATION, PROJECT, + # and ORGANIZATION. This is a case insensitive field defined by Security Command + # Center and/or the producer of the resource and is immutable after create time. # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type @@ -650,30 +629,26 @@ module Google end end - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. class GoogleCloudSecuritycenterV1p1beta1SecurityMarks include Google::Apis::Core::Hashable # Mutable user specified security marks belonging to the parent resource. - # Constraints are as follows: - # * Keys and values are treated as case insensitive - # * Keys must be between 1 - 256 characters (inclusive) - # * Keys must be letters, numbers, underscores, or dashes - # * Values have leading and trailing whitespace trimmed, remaining - # characters must be between 1 - 4096 characters (inclusive) + # Constraints are as follows: * Keys and values are treated as case insensitive * + # Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, + # numbers, underscores, or dashes * Values have leading and trailing whitespace + # trimmed, remaining characters must be between 1 - 4096 characters (inclusive) # Corresponds to the JSON property `marks` # @return [Hash] attr_accessor :marks - # The relative resource name of the SecurityMarks. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Examples: - # "organizations/`organization_id`/assets/`asset_id`/securityMarks" - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/ - # securityMarks". + # The relative resource name of the SecurityMarks. See: https://cloud.google.com/ + # apis/design/resource_names#relative_resource_name Examples: "organizations/` + # organization_id`/assets/`asset_id`/securityMarks" "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -689,17 +664,16 @@ module Google end end - # Wrapper over asset object that also captures the state change for the asset - # e.g. if it was a newly created asset vs updated or deleted asset. + # Wrapper over asset object that also captures the state change for the asset e. + # g. if it was a newly created asset vs updated or deleted asset. class GoogleCloudSecuritycenterV1p1beta1TemporalAsset include Google::Apis::Core::Hashable - # Security Command Center representation of a Google Cloud - # resource. - # The Asset is a Security Command Center resource that captures information - # about a single Google Cloud resource. All modifications to an Asset are only - # within the context of Security Command Center and don't affect the referenced - # Google Cloud resource. + # Security Command Center representation of a Google Cloud resource. The Asset + # is a Security Command Center resource that captures information about a single + # Google Cloud resource. All modifications to an Asset are only within the + # context of Security Command Center and don't affect the referenced Google + # Cloud resource. # Corresponds to the JSON property `asset` # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1Asset] attr_accessor :asset @@ -750,47 +724,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::SecuritycenterV1p1alpha1::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 @@ -809,30 +781,26 @@ module Google end end - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. class SecurityMarks include Google::Apis::Core::Hashable # Mutable user specified security marks belonging to the parent resource. - # Constraints are as follows: - # * Keys and values are treated as case insensitive - # * Keys must be between 1 - 256 characters (inclusive) - # * Keys must be letters, numbers, underscores, or dashes - # * Values have leading and trailing whitespace trimmed, remaining - # characters must be between 1 - 4096 characters (inclusive) + # Constraints are as follows: * Keys and values are treated as case insensitive * + # Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, + # numbers, underscores, or dashes * Values have leading and trailing whitespace + # trimmed, remaining characters must be between 1 - 4096 characters (inclusive) # Corresponds to the JSON property `marks` # @return [Hash] attr_accessor :marks - # The relative resource name of the SecurityMarks. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Examples: - # "organizations/`organization_id`/assets/`asset_id`/securityMarks" - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/ - # securityMarks". + # The relative resource name of the SecurityMarks. See: https://cloud.google.com/ + # apis/design/resource_names#relative_resource_name Examples: "organizations/` + # organization_id`/assets/`asset_id`/securityMarks" "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -848,12 +816,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 @@ -862,15 +830,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 diff --git a/generated/google/apis/securitycenter_v1p1alpha1/service.rb b/generated/google/apis/securitycenter_v1p1alpha1/service.rb index f016ea7f1..1ff65a03d 100644 --- a/generated/google/apis/securitycenter_v1p1alpha1/service.rb +++ b/generated/google/apis/securitycenter_v1p1alpha1/service.rb @@ -48,15 +48,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. @@ -87,10 +85,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 @@ -120,9 +118,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 @@ -152,15 +149,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 diff --git a/generated/google/apis/securitycenter_v1p1beta1.rb b/generated/google/apis/securitycenter_v1p1beta1.rb index 3683e4e7f..f2109cf11 100644 --- a/generated/google/apis/securitycenter_v1p1beta1.rb +++ b/generated/google/apis/securitycenter_v1p1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview module SecuritycenterV1p1beta1 VERSION = 'V1p1beta1' - REVISION = '20200619' + REVISION = '20200731' # 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/securitycenter_v1p1beta1/classes.rb b/generated/google/apis/securitycenter_v1p1beta1/classes.rb index 6e2b6ec5d..1779617da 100644 --- a/generated/google/apis/securitycenter_v1p1beta1/classes.rb +++ b/generated/google/apis/securitycenter_v1p1beta1/classes.rb @@ -47,53 +47,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 @@ -102,9 +70,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 @@ -120,28 +88,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] @@ -167,69 +122,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::SecuritycenterV1p1beta1::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 @@ -246,13 +189,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 @@ -265,52 +206,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 @@ -328,18 +260,16 @@ module Google end end - # Security Command Center finding. - # A finding is a record of assessment data like security, risk, health, or - # privacy, that is ingested into Security Command Center for presentation, - # notification, analysis, policy testing, and enforcement. For example, a - # cross-site scripting (XSS) vulnerability in an App Engine application is a - # finding. + # Security Command Center finding. A finding is a record of assessment data like + # security, risk, health, or privacy, that is ingested into Security Command + # Center for presentation, notification, analysis, policy testing, and + # enforcement. For example, a cross-site scripting (XSS) vulnerability in an App + # Engine application is a finding. class Finding include Google::Apis::Core::Hashable - # The additional taxonomy group within findings from a given source. - # This field is immutable after creation time. - # Example: "XSS_FLASH_INJECTION" + # The additional taxonomy group within findings from a given source. This field + # is immutable after creation time. Example: "XSS_FLASH_INJECTION" # Corresponds to the JSON property `category` # @return [String] attr_accessor :category @@ -349,59 +279,56 @@ module Google # @return [String] attr_accessor :create_time - # The time at which the event took place. For example, if the finding - # represents an open firewall it would capture the time the detector believes - # the firewall became open. The accuracy is determined by the detector. + # The time at which the event took place. For example, if the finding represents + # an open firewall it would capture the time the detector believes the firewall + # became open. The accuracy is determined by the detector. # Corresponds to the JSON property `eventTime` # @return [String] attr_accessor :event_time - # The URI that, if available, points to a web page outside of Security - # Command Center where additional information about the finding can be found. - # This field is guaranteed to be either empty or a well formed URL. + # The URI that, if available, points to a web page outside of Security Command + # Center where additional information about the finding can be found. This field + # is guaranteed to be either empty or a well formed URL. # Corresponds to the JSON property `externalUri` # @return [String] attr_accessor :external_uri - # The relative resource name of this finding. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`" + # The relative resource name of this finding. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`" # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The relative resource name of the source the finding belongs to. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # This field is immutable after creation time. - # For example: - # "organizations/`organization_id`/sources/`source_id`" + # The relative resource name of the source the finding belongs to. See: https:// + # cloud.google.com/apis/design/resource_names#relative_resource_name This field + # is immutable after creation time. For example: "organizations/`organization_id` + # /sources/`source_id`" # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # For findings on Google Cloud resources, the full resource - # name of the Google Cloud resource this finding is for. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name - # When the finding is for a non-Google Cloud resource, the resourceName can - # be a customer or partner defined string. This field is immutable after - # creation time. + # For findings on Google Cloud resources, the full resource name of the Google + # Cloud resource this finding is for. See: https://cloud.google.com/apis/design/ + # resource_names#full_resource_name When the finding is for a non-Google Cloud + # resource, the resourceName can be a customer or partner defined string. This + # field is immutable after creation time. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1p1beta1::SecurityMarks] attr_accessor :security_marks - # Source specific properties. These properties are managed by the source - # that writes the finding. The key names in the source_properties map must be - # between 1 and 255 characters, and must start with a letter and contain - # alphanumeric characters or underscores only. + # Source specific properties. These properties are managed by the source that + # writes the finding. The key names in the source_properties map must be between + # 1 and 255 characters, and must start with a letter and contain alphanumeric + # characters or underscores only. # Corresponds to the JSON property `sourceProperties` # @return [Hash] attr_accessor :source_properties @@ -453,15 +380,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 @@ -480,12 +405,11 @@ module Google class GoogleCloudSecuritycenterV1NotificationMessage include Google::Apis::Core::Hashable - # Security Command Center finding. - # A finding is a record of assessment data like security, risk, health, or - # privacy, that is ingested into Security Command Center for presentation, - # notification, analysis, policy testing, and enforcement. For example, a - # cross-site scripting (XSS) vulnerability in an App Engine application is a - # finding. + # Security Command Center finding. A finding is a record of assessment data like + # security, risk, health, or privacy, that is ingested into Security Command + # Center for presentation, notification, analysis, policy testing, and + # enforcement. For example, a cross-site scripting (XSS) vulnerability in an App + # Engine application is a finding. # Corresponds to the JSON property `finding` # @return [Google::Apis::SecuritycenterV1p1beta1::Finding] attr_accessor :finding @@ -516,8 +440,8 @@ module Google class GoogleCloudSecuritycenterV1Resource include Google::Apis::Core::Hashable - # The full resource name of the resource. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the resource. See: https://cloud.google.com/apis/ + # design/resource_names#full_resource_name # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -606,12 +530,11 @@ module Google end end - # Security Command Center representation of a Google Cloud - # resource. - # The Asset is a Security Command Center resource that captures information - # about a single Google Cloud resource. All modifications to an Asset are only - # within the context of Security Command Center and don't affect the referenced - # Google Cloud resource. + # Security Command Center representation of a Google Cloud resource. The Asset + # is a Security Command Center resource that captures information about a single + # Google Cloud resource. All modifications to an Asset are only within the + # context of Security Command Center and don't affect the referenced Google + # Cloud resource. class GoogleCloudSecuritycenterV1p1beta1Asset include Google::Apis::Core::Hashable @@ -622,22 +545,20 @@ module Google # Cloud IAM Policy information associated with the Google Cloud resource # described by the Security Command Center asset. This information is managed - # and defined by the Google Cloud resource and cannot be modified by the - # user. + # and defined by the Google Cloud resource and cannot be modified by the user. # Corresponds to the JSON property `iamPolicy` # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1IamPolicy] attr_accessor :iam_policy - # The relative resource name of this asset. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/assets/`asset_id`". + # The relative resource name of this asset. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/assets/`asset_id`". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Resource managed properties. These properties are managed and defined by - # the Google Cloud resource and cannot be modified by the user. + # Resource managed properties. These properties are managed and defined by the + # Google Cloud resource and cannot be modified by the user. # Corresponds to the JSON property `resourceProperties` # @return [Hash] attr_accessor :resource_properties @@ -648,16 +569,15 @@ module Google # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties] attr_accessor :security_center_properties - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] attr_accessor :security_marks - # The time at which the asset was last updated, added, or deleted in Cloud - # SCC. + # The time at which the asset was last updated, added, or deleted in Cloud SCC. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -678,17 +598,15 @@ module Google end end - # Security Command Center finding. - # A finding is a record of assessment data (security, risk, health or privacy) - # ingested into Security Command Center for presentation, notification, - # analysis, policy testing, and enforcement. For example, an XSS vulnerability - # in an App Engine application is a finding. + # Security Command Center finding. A finding is a record of assessment data ( + # security, risk, health or privacy) ingested into Security Command Center for + # presentation, notification, analysis, policy testing, and enforcement. For + # example, an XSS vulnerability in an App Engine application is a finding. class GoogleCloudSecuritycenterV1p1beta1Finding include Google::Apis::Core::Hashable - # The additional taxonomy group within findings from a given source. - # This field is immutable after creation time. - # Example: "XSS_FLASH_INJECTION" + # The additional taxonomy group within findings from a given source. This field + # is immutable after creation time. Example: "XSS_FLASH_INJECTION" # Corresponds to the JSON property `category` # @return [String] attr_accessor :category @@ -698,59 +616,56 @@ module Google # @return [String] attr_accessor :create_time - # The time at which the event took place. For example, if the finding - # represents an open firewall it would capture the time the detector believes - # the firewall became open. The accuracy is determined by the detector. + # The time at which the event took place. For example, if the finding represents + # an open firewall it would capture the time the detector believes the firewall + # became open. The accuracy is determined by the detector. # Corresponds to the JSON property `eventTime` # @return [String] attr_accessor :event_time - # The URI that, if available, points to a web page outside of Security - # Command Center where additional information about the finding can be found. - # This field is guaranteed to be either empty or a well formed URL. + # The URI that, if available, points to a web page outside of Security Command + # Center where additional information about the finding can be found. This field + # is guaranteed to be either empty or a well formed URL. # Corresponds to the JSON property `externalUri` # @return [String] attr_accessor :external_uri - # The relative resource name of this finding. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`" + # The relative resource name of this finding. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`" # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The relative resource name of the source the finding belongs to. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # This field is immutable after creation time. - # For example: - # "organizations/`organization_id`/sources/`source_id`" + # The relative resource name of the source the finding belongs to. See: https:// + # cloud.google.com/apis/design/resource_names#relative_resource_name This field + # is immutable after creation time. For example: "organizations/`organization_id` + # /sources/`source_id`" # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # For findings on Google Cloud resources, the full resource - # name of the Google Cloud resource this finding is for. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name - # When the finding is for a non-Google Cloud resource, the resourceName can - # be a customer or partner defined string. This field is immutable after - # creation time. + # For findings on Google Cloud resources, the full resource name of the Google + # Cloud resource this finding is for. See: https://cloud.google.com/apis/design/ + # resource_names#full_resource_name When the finding is for a non-Google Cloud + # resource, the resourceName can be a customer or partner defined string. This + # field is immutable after creation time. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] attr_accessor :security_marks - # Source specific properties. These properties are managed by the source - # that writes the finding. The key names in the source_properties map must be - # between 1 and 255 characters, and must start with a letter and contain - # alphanumeric characters or underscores only. + # Source specific properties. These properties are managed by the source that + # writes the finding. The key names in the source_properties map must be between + # 1 and 255 characters, and must start with a letter and contain alphanumeric + # characters or underscores only. # Corresponds to the JSON property `sourceProperties` # @return [Hash] attr_accessor :source_properties @@ -781,14 +696,12 @@ module Google # Cloud IAM Policy information associated with the Google Cloud resource # described by the Security Command Center asset. This information is managed - # and defined by the Google Cloud resource and cannot be modified by the - # user. + # and defined by the Google Cloud resource and cannot be modified by the user. class GoogleCloudSecuritycenterV1p1beta1IamPolicy include Google::Apis::Core::Hashable - # The JSON representation of the Policy associated with the asset. - # See https://cloud.google.com/iam/docs/reference/rest/v1/Policy for - # format details. + # The JSON representation of the Policy associated with the asset. See https:// + # cloud.google.com/iam/docs/reference/rest/v1/Policy for format details. # Corresponds to the JSON property `policyBlob` # @return [String] attr_accessor :policy_blob @@ -807,11 +720,10 @@ module Google class GoogleCloudSecuritycenterV1p1beta1NotificationMessage include Google::Apis::Core::Hashable - # Security Command Center finding. - # A finding is a record of assessment data (security, risk, health or privacy) - # ingested into Security Command Center for presentation, notification, - # analysis, policy testing, and enforcement. For example, an XSS vulnerability - # in an App Engine application is a finding. + # Security Command Center finding. A finding is a record of assessment data ( + # security, risk, health or privacy) ingested into Security Command Center for + # presentation, notification, analysis, policy testing, and enforcement. For + # example, an XSS vulnerability in an App Engine application is a finding. # Corresponds to the JSON property `finding` # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding] attr_accessor :finding @@ -826,8 +738,8 @@ module Google # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Resource] attr_accessor :resource - # Wrapper over asset object that also captures the state change for the asset - # e.g. if it was a newly created asset vs updated or deleted asset. + # Wrapper over asset object that also captures the state change for the asset e. + # g. if it was a newly created asset vs updated or deleted asset. # Corresponds to the JSON property `temporalAsset` # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1TemporalAsset] attr_accessor :temporal_asset @@ -849,8 +761,8 @@ module Google class GoogleCloudSecuritycenterV1p1beta1Resource include Google::Apis::Core::Hashable - # The full resource name of the resource. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the resource. See: https://cloud.google.com/apis/ + # design/resource_names#full_resource_name # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -924,9 +836,9 @@ module Google # @return [String] attr_accessor :resource_display_name - # The full resource name of the Google Cloud resource this asset - # represents. This field is immutable after create time. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the Google Cloud resource this asset represents. + # This field is immutable after create time. See: https://cloud.google.com/apis/ + # design/resource_names#full_resource_name # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name @@ -936,8 +848,8 @@ module Google # @return [Array] attr_accessor :resource_owners - # The full resource name of the immediate parent of the resource. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the immediate parent of the resource. See: https:// + # cloud.google.com/apis/design/resource_names#full_resource_name # Corresponds to the JSON property `resourceParent` # @return [String] attr_accessor :resource_parent @@ -947,8 +859,8 @@ module Google # @return [String] attr_accessor :resource_parent_display_name - # The full resource name of the project the resource belongs to. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the project the resource belongs to. See: https:// + # cloud.google.com/apis/design/resource_names#full_resource_name # Corresponds to the JSON property `resourceProject` # @return [String] attr_accessor :resource_project @@ -958,10 +870,9 @@ module Google # @return [String] attr_accessor :resource_project_display_name - # The type of the Google Cloud resource. Examples include: APPLICATION, - # PROJECT, and ORGANIZATION. This is a case insensitive field defined by - # Security Command Center and/or the producer of the resource and is - # immutable after create time. + # The type of the Google Cloud resource. Examples include: APPLICATION, PROJECT, + # and ORGANIZATION. This is a case insensitive field defined by Security Command + # Center and/or the producer of the resource and is immutable after create time. # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type @@ -983,30 +894,26 @@ module Google end end - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. class GoogleCloudSecuritycenterV1p1beta1SecurityMarks include Google::Apis::Core::Hashable # Mutable user specified security marks belonging to the parent resource. - # Constraints are as follows: - # * Keys and values are treated as case insensitive - # * Keys must be between 1 - 256 characters (inclusive) - # * Keys must be letters, numbers, underscores, or dashes - # * Values have leading and trailing whitespace trimmed, remaining - # characters must be between 1 - 4096 characters (inclusive) + # Constraints are as follows: * Keys and values are treated as case insensitive * + # Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, + # numbers, underscores, or dashes * Values have leading and trailing whitespace + # trimmed, remaining characters must be between 1 - 4096 characters (inclusive) # Corresponds to the JSON property `marks` # @return [Hash] attr_accessor :marks - # The relative resource name of the SecurityMarks. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Examples: - # "organizations/`organization_id`/assets/`asset_id`/securityMarks" - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/ - # securityMarks". + # The relative resource name of the SecurityMarks. See: https://cloud.google.com/ + # apis/design/resource_names#relative_resource_name Examples: "organizations/` + # organization_id`/assets/`asset_id`/securityMarks" "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1022,17 +929,16 @@ module Google end end - # Wrapper over asset object that also captures the state change for the asset - # e.g. if it was a newly created asset vs updated or deleted asset. + # Wrapper over asset object that also captures the state change for the asset e. + # g. if it was a newly created asset vs updated or deleted asset. class GoogleCloudSecuritycenterV1p1beta1TemporalAsset include Google::Apis::Core::Hashable - # Security Command Center representation of a Google Cloud - # resource. - # The Asset is a Security Command Center resource that captures information - # about a single Google Cloud resource. All modifications to an Asset are only - # within the context of Security Command Center and don't affect the referenced - # Google Cloud resource. + # Security Command Center representation of a Google Cloud resource. The Asset + # is a Security Command Center resource that captures information about a single + # Google Cloud resource. All modifications to an Asset are only within the + # context of Security Command Center and don't affect the referenced Google + # Cloud resource. # Corresponds to the JSON property `asset` # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Asset] attr_accessor :asset @@ -1058,119 +964,93 @@ module Google include Google::Apis::Core::Hashable # When compare_duration is set, the GroupResult's "state_change" property is - # updated to indicate whether the asset was added, removed, or remained - # present during the compare_duration period of time that precedes the - # read_time. This is the time between (read_time - compare_duration) and - # read_time. - # The state change value is derived based on the presence of the asset at the - # two points in time. Intermediate state changes between the two times don't - # affect the result. For example, the results aren't affected if the asset is - # removed and re-created again. - # Possible "state_change" values when compare_duration is specified: - # * "ADDED": indicates that the asset was not present at the start of - # compare_duration, but present at reference_time. - # * "REMOVED": indicates that the asset was present at the start of - # compare_duration, but not present at reference_time. - # * "ACTIVE": indicates that the asset was present at both the - # start and the end of the time period defined by - # compare_duration and reference_time. - # If compare_duration is not specified, then the only possible state_change - # is "UNUSED", which will be the state_change set for all assets present at - # read_time. - # If this field is set then `state_change` must be a specified field in - # `group_by`. + # updated to indicate whether the asset was added, removed, or remained present + # during the compare_duration period of time that precedes the read_time. This + # is the time between (read_time - compare_duration) and read_time. The state + # change value is derived based on the presence of the asset at the two points + # in time. Intermediate state changes between the two times don't affect the + # result. For example, the results aren't affected if the asset is removed and + # re-created again. Possible "state_change" values when compare_duration is + # specified: * "ADDED": indicates that the asset was not present at the start of + # compare_duration, but present at reference_time. * "REMOVED": indicates that + # the asset was present at the start of compare_duration, but not present at + # reference_time. * "ACTIVE": indicates that the asset was present at both the + # start and the end of the time period defined by compare_duration and + # reference_time. If compare_duration is not specified, then the only possible + # state_change is "UNUSED", which will be the state_change set for all assets + # present at read_time. If this field is set then `state_change` must be a + # specified field in `group_by`. # Corresponds to the JSON property `compareDuration` # @return [String] attr_accessor :compare_duration - # Expression that defines the filter to apply across assets. - # The expression is a list of zero or more restrictions combined via logical - # operators `AND` and `OR`. - # Parentheses are supported, and `OR` has higher precedence than `AND`. - # Restrictions have the form ` ` and may have a `-` - # character in front of them to indicate negation. The fields map to those - # defined in the Asset resource. Examples include: - # * name - # * security_center_properties.resource_name - # * resource_properties.a_property - # * security_marks.marks.marka - # The supported operators are: - # * `=` for all value types. - # * `>`, `<`, `>=`, `<=` for integer values. - # * `:`, meaning substring matching, for strings. - # The supported value types are: - # * string literals in quotes. - # * integer literals without quotes. - # * boolean literals `true` and `false` without quotes. - # The following field and operator combinations are supported: - # * name: `=` - # * update_time: `=`, `>`, `<`, `>=`, `<=` - # Usage: This should be milliseconds since epoch or an RFC3339 string. - # Examples: - # `update_time = "2019-06-10T16:07:18-07:00"` - # `update_time = 1560208038000` - # * create_time: `=`, `>`, `<`, `>=`, `<=` - # Usage: This should be milliseconds since epoch or an RFC3339 string. - # Examples: - # `create_time = "2019-06-10T16:07:18-07:00"` - # `create_time = 1560208038000` - # * iam_policy.policy_blob: `=`, `:` - # * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` - # * security_marks.marks: `=`, `:` - # * security_center_properties.resource_name: `=`, `:` - # * security_center_properties.resource_name_display_name: `=`, `:` - # * security_center_properties.resource_type: `=`, `:` - # * security_center_properties.resource_parent: `=`, `:` - # * security_center_properties.resource_parent_display_name: `=`, `:` - # * security_center_properties.resource_project: `=`, `:` - # * security_center_properties.resource_project_display_name: `=`, `:` - # * security_center_properties.resource_owners: `=`, `:` - # For example, `resource_properties.size = 100` is a valid filter string. - # Use a partial match on the empty string to filter based on a property - # existing: `resource_properties.my_property : ""` - # Use a negated partial match on the empty string to filter based on a - # property not existing: `-resource_properties.my_property : ""` + # Expression that defines the filter to apply across assets. The expression is a + # list of zero or more restrictions combined via logical operators `AND` and `OR` + # . Parentheses are supported, and `OR` has higher precedence than `AND`. + # Restrictions have the form ` ` and may have a `-` character in front of them + # to indicate negation. The fields map to those defined in the Asset resource. + # Examples include: * name * security_center_properties.resource_name * + # resource_properties.a_property * security_marks.marks.marka The supported + # operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer + # values. * `:`, meaning substring matching, for strings. The supported value + # types are: * string literals in quotes. * integer literals without quotes. * + # boolean literals `true` and `false` without quotes. The following field and + # operator combinations are supported: * name: `=` * update_time: `=`, `>`, `<`, + # `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. + # Examples: `update_time = "2019-06-10T16:07:18-07:00"` `update_time = + # 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be + # milliseconds since epoch or an RFC3339 string. Examples: `create_time = "2019- + # 06-10T16:07:18-07:00"` `create_time = 1560208038000` * iam_policy.policy_blob: + # `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * + # security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, + # `:` * security_center_properties.resource_name_display_name: `=`, `:` * + # security_center_properties.resource_type: `=`, `:` * + # security_center_properties.resource_parent: `=`, `:` * + # security_center_properties.resource_parent_display_name: `=`, `:` * + # security_center_properties.resource_project: `=`, `:` * + # security_center_properties.resource_project_display_name: `=`, `:` * + # security_center_properties.resource_owners: `=`, `:` For example, ` + # resource_properties.size = 100` is a valid filter string. Use a partial match + # on the empty string to filter based on a property existing: ` + # resource_properties.my_property : ""` Use a negated partial match on the empty + # string to filter based on a property not existing: `-resource_properties. + # my_property : ""` # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter # Required. Expression that defines what assets fields to use for grouping. The - # string - # value should follow SQL syntax: comma separated list of fields. For - # example: - # "security_center_properties.resource_project,security_center_properties. - # project". - # The following fields are supported when compare_duration is not set: - # * security_center_properties.resource_project - # * security_center_properties.resource_project_display_name - # * security_center_properties.resource_type - # * security_center_properties.resource_parent - # * security_center_properties.resource_parent_display_name - # The following fields are supported when compare_duration is set: - # * security_center_properties.resource_type - # * security_center_properties.resource_project_display_name - # * security_center_properties.resource_parent_display_name + # string value should follow SQL syntax: comma separated list of fields. For + # example: "security_center_properties.resource_project, + # security_center_properties.project". The following fields are supported when + # compare_duration is not set: * security_center_properties.resource_project * + # security_center_properties.resource_project_display_name * + # security_center_properties.resource_type * security_center_properties. + # resource_parent * security_center_properties.resource_parent_display_name The + # following fields are supported when compare_duration is set: * + # security_center_properties.resource_type * security_center_properties. + # resource_project_display_name * security_center_properties. + # resource_parent_display_name # Corresponds to the JSON property `groupBy` # @return [String] attr_accessor :group_by - # The maximum number of results to return in a single response. Default is - # 10, minimum is 1, maximum is 1000. + # The maximum number of results to return in a single response. Default is 10, + # minimum is 1, maximum is 1000. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size - # The value returned by the last `GroupAssetsResponse`; indicates - # that this is a continuation of a prior `GroupAssets` call, and that the - # system should return the next page of data. + # The value returned by the last `GroupAssetsResponse`; indicates that this is a + # continuation of a prior `GroupAssets` call, and that the system should return + # the next page of data. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token - # Time used as a reference point when filtering assets. The filter is limited - # to assets existing at the supplied time and their values are those at that - # specific time. Absence of this field will default to the API's version of - # NOW. + # Time used as a reference point when filtering assets. The filter is limited to + # assets existing at the supplied time and their values are those at that + # specific time. Absence of this field will default to the API's version of NOW. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -1194,9 +1074,9 @@ module Google class GroupAssetsResponse include Google::Apis::Core::Hashable - # Group results. There exists an element for each existing unique - # combination of property/values. The element contains a count for the number - # of times those specific property/values appear. + # Group results. There exists an element for each existing unique combination of + # property/values. The element contains a count for the number of times those + # specific property/values appear. # Corresponds to the JSON property `groupByResults` # @return [Array] attr_accessor :group_by_results @@ -1235,108 +1115,79 @@ module Google include Google::Apis::Core::Hashable # When compare_duration is set, the GroupResult's "state_change" attribute is - # updated to indicate whether the finding had its state changed, the - # finding's state remained unchanged, or if the finding was added during the - # compare_duration period of time that precedes the read_time. This is the - # time between (read_time - compare_duration) and read_time. - # The state_change value is derived based on the presence and state of the - # finding at the two points in time. Intermediate state changes between the - # two times don't affect the result. For example, the results aren't affected - # if the finding is made inactive and then active again. - # Possible "state_change" values when compare_duration is specified: - # * "CHANGED": indicates that the finding was present and matched the given - # filter at the start of compare_duration, but changed its - # state at read_time. - # * "UNCHANGED": indicates that the finding was present and matched the given - # filter at the start of compare_duration and did not change - # state at read_time. - # * "ADDED": indicates that the finding did not match the given filter or - # was not present at the start of compare_duration, but was - # present at read_time. - # * "REMOVED": indicates that the finding was present and matched the - # filter at the start of compare_duration, but did not match - # the filter at read_time. - # If compare_duration is not specified, then the only possible state_change - # is "UNUSED", which will be the state_change set for all findings present - # at read_time. - # If this field is set then `state_change` must be a specified field in - # `group_by`. + # updated to indicate whether the finding had its state changed, the finding's + # state remained unchanged, or if the finding was added during the + # compare_duration period of time that precedes the read_time. This is the time + # between (read_time - compare_duration) and read_time. The state_change value + # is derived based on the presence and state of the finding at the two points in + # time. Intermediate state changes between the two times don't affect the result. + # For example, the results aren't affected if the finding is made inactive and + # then active again. Possible "state_change" values when compare_duration is + # specified: * "CHANGED": indicates that the finding was present and matched the + # given filter at the start of compare_duration, but changed its state at + # read_time. * "UNCHANGED": indicates that the finding was present and matched + # the given filter at the start of compare_duration and did not change state at + # read_time. * "ADDED": indicates that the finding did not match the given + # filter or was not present at the start of compare_duration, but was present at + # read_time. * "REMOVED": indicates that the finding was present and matched the + # filter at the start of compare_duration, but did not match the filter at + # read_time. If compare_duration is not specified, then the only possible + # state_change is "UNUSED", which will be the state_change set for all findings + # present at read_time. If this field is set then `state_change` must be a + # specified field in `group_by`. # Corresponds to the JSON property `compareDuration` # @return [String] attr_accessor :compare_duration - # Expression that defines the filter to apply across findings. - # The expression is a list of one or more restrictions combined via logical - # operators `AND` and `OR`. - # Parentheses are supported, and `OR` has higher precedence than `AND`. - # Restrictions have the form ` ` and may have a `-` - # character in front of them to indicate negation. Examples include: - # * name - # * source_properties.a_property - # * security_marks.marks.marka - # The supported operators are: - # * `=` for all value types. - # * `>`, `<`, `>=`, `<=` for integer values. - # * `:`, meaning substring matching, for strings. - # The supported value types are: - # * string literals in quotes. - # * integer literals without quotes. - # * boolean literals `true` and `false` without quotes. - # The following field and operator combinations are supported: - # * name: `=` - # * parent: `=`, `:` - # * resource_name: `=`, `:` - # * state: `=`, `:` - # * category: `=`, `:` - # * external_uri: `=`, `:` - # * event_time: `=`, `>`, `<`, `>=`, `<=` - # Usage: This should be milliseconds since epoch or an RFC3339 string. - # Examples: - # `event_time = "2019-06-10T16:07:18-07:00"` - # `event_time = 1560208038000` - # * security_marks.marks: `=`, `:` - # * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` - # For example, `source_properties.size = 100` is a valid filter string. - # Use a partial match on the empty string to filter based on a property - # existing: `source_properties.my_property : ""` - # Use a negated partial match on the empty string to filter based on a - # property not existing: `-source_properties.my_property : ""` + # Expression that defines the filter to apply across findings. The expression is + # a list of one or more restrictions combined via logical operators `AND` and ` + # OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. + # Restrictions have the form ` ` and may have a `-` character in front of them + # to indicate negation. Examples include: * name * source_properties.a_property * + # security_marks.marks.marka The supported operators are: * `=` for all value + # types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring + # matching, for strings. The supported value types are: * string literals in + # quotes. * integer literals without quotes. * boolean literals `true` and ` + # false` without quotes. The following field and operator combinations are + # supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `= + # `, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `< + # `, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 + # string. Examples: `event_time = "2019-06-10T16:07:18-07:00"` `event_time = + # 1560208038000` * security_marks.marks: `=`, `:` * source_properties: `=`, `:`, + # `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid + # filter string. Use a partial match on the empty string to filter based on a + # property existing: `source_properties.my_property : ""` Use a negated partial + # match on the empty string to filter based on a property not existing: `- + # source_properties.my_property : ""` # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter # Required. Expression that defines what assets fields to use for grouping ( - # including - # `state_change`). The string value should follow SQL syntax: comma separated - # list of fields. For example: "parent,resource_name". - # The following fields are supported: - # * resource_name - # * category - # * state - # * parent - # The following fields are supported when compare_duration is set: - # * state_change + # including `state_change`). The string value should follow SQL syntax: comma + # separated list of fields. For example: "parent,resource_name". The following + # fields are supported: * resource_name * category * state * parent The + # following fields are supported when compare_duration is set: * state_change # Corresponds to the JSON property `groupBy` # @return [String] attr_accessor :group_by - # The maximum number of results to return in a single response. Default is - # 10, minimum is 1, maximum is 1000. + # The maximum number of results to return in a single response. Default is 10, + # minimum is 1, maximum is 1000. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size - # The value returned by the last `GroupFindingsResponse`; indicates - # that this is a continuation of a prior `GroupFindings` call, and - # that the system should return the next page of data. + # The value returned by the last `GroupFindingsResponse`; indicates that this is + # a continuation of a prior `GroupFindings` call, and that the system should + # return the next page of data. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token - # Time used as a reference point when filtering findings. The filter is - # limited to findings existing at the supplied time and their values are - # those at that specific time. Absence of this field will default to the - # API's version of NOW. + # Time used as a reference point when filtering findings. The filter is limited + # to findings existing at the supplied time and their values are those at that + # specific time. Absence of this field will default to the API's version of NOW. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -1360,9 +1211,9 @@ module Google class GroupFindingsResponse include Google::Apis::Core::Hashable - # Group results. There exists an element for each existing unique - # combination of property/values. The element contains a count for the number - # of times those specific property/values appear. + # Group results. There exists an element for each existing unique combination of + # property/values. The element contains a count for the number of times those + # specific property/values appear. # Corresponds to the JSON property `groupByResults` # @return [Array] attr_accessor :group_by_results @@ -1463,12 +1314,11 @@ module Google class ListAssetsResult include Google::Apis::Core::Hashable - # Security Command Center representation of a Google Cloud - # resource. - # The Asset is a Security Command Center resource that captures information - # about a single Google Cloud resource. All modifications to an Asset are only - # within the context of Security Command Center and don't affect the referenced - # Google Cloud resource. + # Security Command Center representation of a Google Cloud resource. The Asset + # is a Security Command Center resource that captures information about a single + # Google Cloud resource. All modifications to an Asset are only within the + # context of Security Command Center and don't affect the referenced Google + # Cloud resource. # Corresponds to the JSON property `asset` # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Asset] attr_accessor :asset @@ -1531,17 +1381,16 @@ module Google class ListFindingsResult include Google::Apis::Core::Hashable - # Security Command Center finding. - # A finding is a record of assessment data (security, risk, health or privacy) - # ingested into Security Command Center for presentation, notification, - # analysis, policy testing, and enforcement. For example, an XSS vulnerability - # in an App Engine application is a finding. + # Security Command Center finding. A finding is a record of assessment data ( + # security, risk, health or privacy) ingested into Security Command Center for + # presentation, notification, analysis, policy testing, and enforcement. For + # example, an XSS vulnerability in an App Engine application is a finding. # Corresponds to the JSON property `finding` # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding] attr_accessor :finding - # Information related to the Google Cloud resource that is - # associated with this finding. + # Information related to the Google Cloud resource that is associated with this + # finding. LINT.IfChange # Corresponds to the JSON property `resource` # @return [Google::Apis::SecuritycenterV1p1beta1::Resource] attr_accessor :resource @@ -1640,10 +1489,9 @@ module Google end end - # Security Command Center notification configs. - # A notification config is a Security Command Center resource that contains the - # configuration to send notifications for create/update events of findings, - # assets and etc. + # Security Command Center notification configs. A notification config is a + # Security Command Center resource that contains the configuration to send + # notifications for create/update events of findings, assets and etc. class NotificationConfig include Google::Apis::Core::Hashable @@ -1657,28 +1505,27 @@ module Google # @return [String] attr_accessor :event_type - # The relative resource name of this notification config. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/notificationConfigs/notify_public_bucket". + # The relative resource name of this notification config. See: https://cloud. + # google.com/apis/design/resource_names#relative_resource_name Example: " + # organizations/`organization_id`/notificationConfigs/notify_public_bucket". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The Pub/Sub topic to send notifications to. Its format is - # "projects/[project_id]/topics/[topic]". + # The Pub/Sub topic to send notifications to. Its format is "projects/[ + # project_id]/topics/[topic]". # Corresponds to the JSON property `pubsubTopic` # @return [String] attr_accessor :pubsub_topic - # Output only. The service account that needs "pubsub.topics.publish" - # permission to publish to the Pub/Sub topic. + # Output only. The service account that needs "pubsub.topics.publish" permission + # to publish to the Pub/Sub topic. # Corresponds to the JSON property `serviceAccount` # @return [String] attr_accessor :service_account - # The config for streaming-based notifications, which send each event as soon - # as it is detected. + # The config for streaming-based notifications, which send each event as soon as + # it is detected. # Corresponds to the JSON property `streamingConfig` # @return [Google::Apis::SecuritycenterV1p1beta1::StreamingConfig] attr_accessor :streaming_config @@ -1703,47 +1550,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::SecuritycenterV1p1beta1::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 @@ -1762,8 +1607,8 @@ module Google end end - # User specified settings that are attached to the Security Command - # Center organization. + # User specified settings that are attached to the Security Command Center + # organization. class OrganizationSettings include Google::Apis::Core::Hashable @@ -1772,19 +1617,17 @@ module Google # @return [Google::Apis::SecuritycenterV1p1beta1::AssetDiscoveryConfig] attr_accessor :asset_discovery_config - # A flag that indicates if Asset Discovery should be enabled. If the flag is - # set to `true`, then discovery of assets will occur. If it is set to `false, - # all historical assets will remain, but discovery of future assets will not - # occur. + # A flag that indicates if Asset Discovery should be enabled. If the flag is set + # to `true`, then discovery of assets will occur. If it is set to `false, all + # historical assets will remain, but discovery of future assets will not occur. # Corresponds to the JSON property `enableAssetDiscovery` # @return [Boolean] attr_accessor :enable_asset_discovery alias_method :enable_asset_discovery?, :enable_asset_discovery - # The relative resource name of the settings. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/organizationSettings". + # The relative resource name of the settings. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/organizationSettings". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1802,66 +1645,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 @@ -1870,48 +1679,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 @@ -1929,13 +1734,13 @@ module Google end end - # Information related to the Google Cloud resource that is - # associated with this finding. + # Information related to the Google Cloud resource that is associated with this + # finding. LINT.IfChange class Resource include Google::Apis::Core::Hashable - # The full resource name of the resource. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name + # The full resource name of the resource. See: https://cloud.google.com/apis/ + # design/resource_names#full_resource_name # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1987,30 +1792,26 @@ module Google end end - # User specified security marks that are attached to the parent Security - # Command Center resource. Security marks are scoped within a Security Command - # Center organization -- they can be modified and viewed by all users who have - # proper permissions on the organization. + # User specified security marks that are attached to the parent Security Command + # Center resource. Security marks are scoped within a Security Command Center + # organization -- they can be modified and viewed by all users who have proper + # permissions on the organization. class SecurityMarks include Google::Apis::Core::Hashable # Mutable user specified security marks belonging to the parent resource. - # Constraints are as follows: - # * Keys and values are treated as case insensitive - # * Keys must be between 1 - 256 characters (inclusive) - # * Keys must be letters, numbers, underscores, or dashes - # * Values have leading and trailing whitespace trimmed, remaining - # characters must be between 1 - 4096 characters (inclusive) + # Constraints are as follows: * Keys and values are treated as case insensitive * + # Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, + # numbers, underscores, or dashes * Values have leading and trailing whitespace + # trimmed, remaining characters must be between 1 - 4096 characters (inclusive) # Corresponds to the JSON property `marks` # @return [Hash] attr_accessor :marks - # The relative resource name of the SecurityMarks. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Examples: - # "organizations/`organization_id`/assets/`asset_id`/securityMarks" - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/ - # securityMarks". + # The relative resource name of the SecurityMarks. See: https://cloud.google.com/ + # apis/design/resource_names#relative_resource_name Examples: "organizations/` + # organization_id`/assets/`asset_id`/securityMarks" "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2056,74 +1857,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::SecuritycenterV1p1beta1::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 @@ -2139,36 +1905,32 @@ module Google end end - # Security Command Center finding source. A finding source - # is an entity or a mechanism that can produce a finding. A source is like a - # container of findings that come from the same scanner, logger, monitor, etc. + # Security Command Center finding source. A finding source is an entity or a + # mechanism that can produce a finding. A source is like a container of findings + # that come from the same scanner, logger, monitor, etc. class Source include Google::Apis::Core::Hashable - # The description of the source (max of 1024 characters). - # Example: - # "Web Security Scanner is a web security scanner for common - # vulnerabilities in App Engine applications. It can automatically - # scan and detect four common vulnerabilities, including cross-site-scripting - # (XSS), Flash injection, mixed content (HTTP in HTTPS), and - # outdated/insecure libraries." + # The description of the source (max of 1024 characters). Example: "Web Security + # Scanner is a web security scanner for common vulnerabilities in App Engine + # applications. It can automatically scan and detect four common vulnerabilities, + # including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in + # HTTPS), and outdated/insecure libraries." # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # The source's display name. - # A source's display name must be unique amongst its siblings, for example, - # two sources with the same parent can't share the same display name. - # The display name must have a length between 1 and 64 characters - # (inclusive). + # The source's display name. A source's display name must be unique amongst its + # siblings, for example, two sources with the same parent can't share the same + # display name. The display name must have a length between 1 and 64 characters ( + # inclusive). # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # The relative resource name of this source. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/sources/`source_id`" + # The relative resource name of this source. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/sources/`source_id`" # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2185,12 +1947,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 @@ -2199,15 +1961,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 @@ -2224,27 +1986,21 @@ module Google end end - # The config for streaming-based notifications, which send each event as soon - # as it is detected. + # The config for streaming-based notifications, which send each event as soon as + # it is detected. class StreamingConfig include Google::Apis::Core::Hashable - # Expression that defines the filter to apply across create/update events - # of assets or findings as specified by the event type. The expression is a - # list of zero or more restrictions combined via logical operators `AND` - # and `OR`. Parentheses are supported, and `OR` has higher precedence than - # `AND`. - # Restrictions have the form ` ` and may have a - # `-` character in front of them to indicate negation. The fields map to - # those defined in the corresponding resource. - # The supported operators are: - # * `=` for all value types. - # * `>`, `<`, `>=`, `<=` for integer values. - # * `:`, meaning substring matching, for strings. - # The supported value types are: - # * string literals in quotes. - # * integer literals without quotes. - # * boolean literals `true` and `false` without quotes. + # Expression that defines the filter to apply across create/update events of + # assets or findings as specified by the event type. The expression is a list of + # zero or more restrictions combined via logical operators `AND` and `OR`. + # Parentheses are supported, and `OR` has higher precedence than `AND`. + # Restrictions have the form ` ` and may have a `-` character in front of them + # to indicate negation. The fields map to those defined in the corresponding + # resource. The supported operators are: * `=` for all value types. * `>`, `<`, ` + # >=`, `<=` for integer values. * `:`, meaning substring matching, for strings. + # The supported value types are: * string literals in quotes. * integer literals + # without quotes. * boolean literals `true` and `false` without quotes. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter @@ -2263,10 +2019,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 @@ -2285,8 +2040,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 diff --git a/generated/google/apis/securitycenter_v1p1beta1/service.rb b/generated/google/apis/securitycenter_v1p1beta1/service.rb index 2542dc1a9..cf9da78e1 100644 --- a/generated/google/apis/securitycenter_v1p1beta1/service.rb +++ b/generated/google/apis/securitycenter_v1p1beta1/service.rb @@ -51,8 +51,7 @@ module Google # Gets the settings for an organization. # @param [String] name # Required. Name of the organization to get organization settings for. Its - # format is - # "organizations/[organization_id]/organizationSettings". + # format is "organizations/[organization_id]/organizationSettings". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -82,14 +81,13 @@ module Google # Updates an organization's settings. # @param [String] name - # The relative resource name of the settings. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/organizationSettings". + # The relative resource name of the settings. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/organizationSettings". # @param [Google::Apis::SecuritycenterV1p1beta1::OrganizationSettings] organization_settings_object # @param [String] update_mask - # The FieldMask to use when updating the settings resource. - # If empty all mutable fields will be updated. + # The FieldMask to use when updating the settings resource. If empty all mutable + # fields will be updated. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -120,11 +118,10 @@ module Google execute_or_queue_command(command, &block) end - # Filters an organization's assets and groups them by their specified - # properties. + # Filters an organization's assets and groups them by their specified properties. # @param [String] parent - # Required. Name of the organization to groupBy. Its format is - # "organizations/[organization_id]". + # Required. Name of the organization to groupBy. Its format is "organizations/[ + # organization_id]". # @param [Google::Apis::SecuritycenterV1p1beta1::GroupAssetsRequest] group_assets_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -157,114 +154,86 @@ module Google # Lists an organization's assets. # @param [String] parent - # Required. Name of the organization assets should belong to. Its format is - # "organizations/[organization_id]". + # Required. Name of the organization assets should belong to. Its format is " + # organizations/[organization_id]". # @param [String] compare_duration - # When compare_duration is set, the ListAssetsResult's "state_change" - # attribute is updated to indicate whether the asset was added, removed, or - # remained present during the compare_duration period of time that precedes - # the read_time. This is the time between (read_time - compare_duration) and - # read_time. - # The state_change value is derived based on the presence of the asset at the - # two points in time. Intermediate state changes between the two times don't - # affect the result. For example, the results aren't affected if the asset is - # removed and re-created again. - # Possible "state_change" values when compare_duration is specified: - # * "ADDED": indicates that the asset was not present at the start of - # compare_duration, but present at read_time. - # * "REMOVED": indicates that the asset was present at the start of - # compare_duration, but not present at read_time. - # * "ACTIVE": indicates that the asset was present at both the - # start and the end of the time period defined by - # compare_duration and read_time. - # If compare_duration is not specified, then the only possible state_change - # is "UNUSED", which will be the state_change set for all assets present at + # When compare_duration is set, the ListAssetsResult's "state_change" attribute + # is updated to indicate whether the asset was added, removed, or remained + # present during the compare_duration period of time that precedes the read_time. + # This is the time between (read_time - compare_duration) and read_time. The + # state_change value is derived based on the presence of the asset at the two + # points in time. Intermediate state changes between the two times don't affect + # the result. For example, the results aren't affected if the asset is removed + # and re-created again. Possible "state_change" values when compare_duration is + # specified: * "ADDED": indicates that the asset was not present at the start of + # compare_duration, but present at read_time. * "REMOVED": indicates that the + # asset was present at the start of compare_duration, but not present at + # read_time. * "ACTIVE": indicates that the asset was present at both the start + # and the end of the time period defined by compare_duration and read_time. If + # compare_duration is not specified, then the only possible state_change is " + # UNUSED", which will be the state_change set for all assets present at # read_time. # @param [String] field_mask # A field mask to specify the ListAssetsResult fields to be listed in the - # response. - # An empty field mask will list all fields. + # response. An empty field mask will list all fields. # @param [String] filter - # Expression that defines the filter to apply across assets. - # The expression is a list of zero or more restrictions combined via logical - # operators `AND` and `OR`. - # Parentheses are supported, and `OR` has higher precedence than `AND`. - # Restrictions have the form ` ` and may have a `-` - # character in front of them to indicate negation. The fields map to those - # defined in the Asset resource. Examples include: - # * name - # * security_center_properties.resource_name - # * resource_properties.a_property - # * security_marks.marks.marka - # The supported operators are: - # * `=` for all value types. - # * `>`, `<`, `>=`, `<=` for integer values. - # * `:`, meaning substring matching, for strings. - # The supported value types are: - # * string literals in quotes. - # * integer literals without quotes. - # * boolean literals `true` and `false` without quotes. - # The following are the allowed field and operator combinations: - # * name: `=` - # * update_time: `=`, `>`, `<`, `>=`, `<=` - # Usage: This should be milliseconds since epoch or an RFC3339 string. - # Examples: - # `update_time = "2019-06-10T16:07:18-07:00"` - # `update_time = 1560208038000` - # * create_time: `=`, `>`, `<`, `>=`, `<=` - # Usage: This should be milliseconds since epoch or an RFC3339 string. - # Examples: - # `create_time = "2019-06-10T16:07:18-07:00"` - # `create_time = 1560208038000` - # * iam_policy.policy_blob: `=`, `:` - # * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` - # * security_marks.marks: `=`, `:` - # * security_center_properties.resource_name: `=`, `:` - # * security_center_properties.resource_display_name: `=`, `:` - # * security_center_properties.resource_type: `=`, `:` - # * security_center_properties.resource_parent: `=`, `:` - # * security_center_properties.resource_parent_display_name: `=`, `:` - # * security_center_properties.resource_project: `=`, `:` - # * security_center_properties.resource_project_display_name: `=`, `:` - # * security_center_properties.resource_owners: `=`, `:` - # For example, `resource_properties.size = 100` is a valid filter string. - # Use a partial match on the empty string to filter based on a property - # existing: `resource_properties.my_property : ""` - # Use a negated partial match on the empty string to filter based on a - # property not existing: `-resource_properties.my_property : ""` + # Expression that defines the filter to apply across assets. The expression is a + # list of zero or more restrictions combined via logical operators `AND` and `OR` + # . Parentheses are supported, and `OR` has higher precedence than `AND`. + # Restrictions have the form ` ` and may have a `-` character in front of them + # to indicate negation. The fields map to those defined in the Asset resource. + # Examples include: * name * security_center_properties.resource_name * + # resource_properties.a_property * security_marks.marks.marka The supported + # operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer + # values. * `:`, meaning substring matching, for strings. The supported value + # types are: * string literals in quotes. * integer literals without quotes. * + # boolean literals `true` and `false` without quotes. The following are the + # allowed field and operator combinations: * name: `=` * update_time: `=`, `>`, ` + # <`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 + # string. Examples: `update_time = "2019-06-10T16:07:18-07:00"` `update_time = + # 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be + # milliseconds since epoch or an RFC3339 string. Examples: `create_time = "2019- + # 06-10T16:07:18-07:00"` `create_time = 1560208038000` * iam_policy.policy_blob: + # `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * + # security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, + # `:` * security_center_properties.resource_display_name: `=`, `:` * + # security_center_properties.resource_type: `=`, `:` * + # security_center_properties.resource_parent: `=`, `:` * + # security_center_properties.resource_parent_display_name: `=`, `:` * + # security_center_properties.resource_project: `=`, `:` * + # security_center_properties.resource_project_display_name: `=`, `:` * + # security_center_properties.resource_owners: `=`, `:` For example, ` + # resource_properties.size = 100` is a valid filter string. Use a partial match + # on the empty string to filter based on a property existing: ` + # resource_properties.my_property : ""` Use a negated partial match on the empty + # string to filter based on a property not existing: `-resource_properties. + # my_property : ""` # @param [String] order_by - # Expression that defines what fields and order to use for sorting. The - # string value should follow SQL syntax: comma separated list of fields. For - # example: "name,resource_properties.a_property". The default sorting order - # is ascending. To specify descending order for a field, a suffix " desc" - # should be appended to the field name. For example: "name - # desc,resource_properties.a_property". Redundant space characters in the - # syntax are insignificant. "name desc,resource_properties.a_property" and " - # name desc , resource_properties.a_property " are equivalent. - # The following fields are supported: - # name - # update_time - # resource_properties - # security_marks.marks - # security_center_properties.resource_name - # security_center_properties.resource_display_name - # security_center_properties.resource_parent + # Expression that defines what fields and order to use for sorting. The string + # value should follow SQL syntax: comma separated list of fields. For example: " + # name,resource_properties.a_property". The default sorting order is ascending. + # To specify descending order for a field, a suffix " desc" should be appended + # to the field name. For example: "name desc,resource_properties.a_property". + # Redundant space characters in the syntax are insignificant. "name desc, + # resource_properties.a_property" and " name desc , resource_properties. + # a_property " are equivalent. The following fields are supported: name + # update_time resource_properties security_marks.marks + # security_center_properties.resource_name security_center_properties. + # resource_display_name security_center_properties.resource_parent # security_center_properties.resource_parent_display_name - # security_center_properties.resource_project - # security_center_properties.resource_project_display_name - # security_center_properties.resource_type + # security_center_properties.resource_project security_center_properties. + # resource_project_display_name security_center_properties.resource_type # @param [Fixnum] page_size - # The maximum number of results to return in a single response. Default is - # 10, minimum is 1, maximum is 1000. + # The maximum number of results to return in a single response. Default is 10, + # minimum is 1, maximum is 1000. # @param [String] page_token - # The value returned by the last `ListAssetsResponse`; indicates - # that this is a continuation of a prior `ListAssets` call, and - # that the system should return the next page of data. + # The value returned by the last `ListAssetsResponse`; indicates that this is a + # continuation of a prior `ListAssets` call, and that the system should return + # the next page of data. # @param [String] read_time - # Time used as a reference point when filtering assets. The filter is limited - # to assets existing at the supplied time and their values are those at that - # specific time. Absence of this field will default to the API's version of - # NOW. + # Time used as a reference point when filtering assets. The filter is limited to + # assets existing at the supplied time and their values are those at that + # specific time. Absence of this field will default to the API's version of NOW. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -299,15 +268,12 @@ module Google execute_or_queue_command(command, &block) end - # Runs asset discovery. The discovery is tracked with a long-running - # operation. - # // - # This API can only be called with limited frequency for an organization. If - # it is called too frequently the caller will receive a TOO_MANY_REQUESTS - # error. + # Runs asset discovery. The discovery is tracked with a long-running operation. / + # / This API can only be called with limited frequency for an organization. If + # it is called too frequently the caller will receive a TOO_MANY_REQUESTS error. # @param [String] parent - # Required. Name of the organization to run asset discovery for. Its format is - # "organizations/[organization_id]". + # Required. Name of the organization to run asset discovery for. Its format is " + # organizations/[organization_id]". # @param [Google::Apis::SecuritycenterV1p1beta1::RunAssetDiscoveryRequest] run_asset_discovery_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -340,22 +306,19 @@ module Google # Updates security marks. # @param [String] name - # The relative resource name of the SecurityMarks. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Examples: - # "organizations/`organization_id`/assets/`asset_id`/securityMarks" - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/ - # securityMarks". + # The relative resource name of the SecurityMarks. See: https://cloud.google.com/ + # apis/design/resource_names#relative_resource_name Examples: "organizations/` + # organization_id`/assets/`asset_id`/securityMarks" "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks". # @param [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] google_cloud_securitycenter_v1p1beta1_security_marks_object # @param [String] start_time - # The time at which the updated SecurityMarks take effect. - # If not set uses current server time. Updates will be applied to the - # SecurityMarks that are active immediately preceding this time. + # The time at which the updated SecurityMarks take effect. If not set uses + # current server time. Updates will be applied to the SecurityMarks that are + # active immediately preceding this time. # @param [String] update_mask - # The FieldMask to use when updating the security marks resource. - # The field mask must not contain duplicate fields. - # If empty or set to "marks", all marks will be replaced. Individual - # marks can be updated using "marks.". + # The FieldMask to use when updating the security marks resource. The field mask + # must not contain duplicate fields. If empty or set to "marks", all marks will + # be replaced. Individual marks can be updated using "marks.". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -393,10 +356,9 @@ module Google # "organizations/[organization_id]". # @param [Google::Apis::SecuritycenterV1p1beta1::NotificationConfig] notification_config_object # @param [String] config_id - # Required. - # Unique identifier provided by the client within the parent scope. - # It must be between 1 and 128 characters, and contains alphanumeric - # characters, underscores or hyphens only. + # Required. Unique identifier provided by the client within the parent scope. It + # must be between 1 and 128 characters, and contains alphanumeric characters, + # underscores or hyphens only. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -429,8 +391,8 @@ module Google # Deletes a notification config. # @param [String] name - # Required. Name of the notification config to delete. Its format is - # "organizations/[organization_id]/notificationConfigs/[config_id]". + # Required. Name of the notification config to delete. Its format is " + # organizations/[organization_id]/notificationConfigs/[config_id]". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -460,8 +422,8 @@ module Google # Gets a notification config. # @param [String] name - # Required. Name of the notification config to get. Its format is - # "organizations/[organization_id]/notificationConfigs/[config_id]". + # Required. Name of the notification config to get. Its format is "organizations/ + # [organization_id]/notificationConfigs/[config_id]". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -491,11 +453,11 @@ module Google # Lists notification configs. # @param [String] parent - # Required. Name of the organization to list notification configs. - # Its format is "organizations/[organization_id]". + # Required. Name of the organization to list notification configs. Its format is + # "organizations/[organization_id]". # @param [Fixnum] page_size - # The maximum number of results to return in a single response. Default is - # 10, minimum is 1, maximum is 1000. + # The maximum number of results to return in a single response. Default is 10, + # minimum is 1, maximum is 1000. # @param [String] page_token # The value returned by the last `ListNotificationConfigsResponse`; indicates # that this is a continuation of a prior `ListNotificationConfigs` call, and @@ -529,17 +491,16 @@ module Google execute_or_queue_command(command, &block) end - # Updates a notification config. The following update - # fields are allowed: description, pubsub_topic, streaming_config.filter + # Updates a notification config. The following update fields are allowed: + # description, pubsub_topic, streaming_config.filter # @param [String] name - # The relative resource name of this notification config. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/notificationConfigs/notify_public_bucket". + # The relative resource name of this notification config. See: https://cloud. + # google.com/apis/design/resource_names#relative_resource_name Example: " + # organizations/`organization_id`/notificationConfigs/notify_public_bucket". # @param [Google::Apis::SecuritycenterV1p1beta1::NotificationConfig] notification_config_object # @param [String] update_mask - # The FieldMask to use when updating the notification config. - # If empty all mutable fields will be updated. + # The FieldMask to use when updating the notification config. If empty all + # mutable fields will be updated. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -570,15 +531,13 @@ module Google 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, + # 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. @@ -609,10 +568,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 @@ -642,9 +601,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 @@ -674,15 +632,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 @@ -723,8 +680,8 @@ module Google # Creates a source. # @param [String] parent - # Required. Resource name of the new source's parent. Its format should be - # "organizations/[organization_id]". + # Required. Resource name of the new source's parent. Its format should be " + # organizations/[organization_id]". # @param [Google::Apis::SecuritycenterV1p1beta1::Source] source_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -757,8 +714,8 @@ module Google # Gets a source. # @param [String] name - # Required. Relative resource name of the source. Its format is - # "organizations/[organization_id]/source/[source_id]". + # Required. Relative resource name of the source. Its format is "organizations/[ + # organization_id]/source/[source_id]". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -788,8 +745,8 @@ module Google # Gets the access control policy on the specified Source. # @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::SecuritycenterV1p1beta1::GetIamPolicyRequest] get_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -825,12 +782,12 @@ module Google # Required. Resource name of the parent of sources to list. Its format should be # "organizations/[organization_id]". # @param [Fixnum] page_size - # The maximum number of results to return in a single response. Default is - # 10, minimum is 1, maximum is 1000. + # The maximum number of results to return in a single response. Default is 10, + # minimum is 1, maximum is 1000. # @param [String] page_token - # The value returned by the last `ListSourcesResponse`; indicates - # that this is a continuation of a prior `ListSources` call, and - # that the system should return the next page of data. + # The value returned by the last `ListSourcesResponse`; indicates that this is a + # continuation of a prior `ListSources` call, and that the system should return + # the next page of data. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -862,14 +819,13 @@ module Google # Updates a source. # @param [String] name - # The relative resource name of this source. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/sources/`source_id`" + # The relative resource name of this source. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/sources/`source_id`" # @param [Google::Apis::SecuritycenterV1p1beta1::Source] source_object # @param [String] update_mask - # The FieldMask to use when updating the source resource. - # If empty all mutable fields will be updated. + # The FieldMask to use when updating the source resource. If empty all mutable + # fields will be updated. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -902,8 +858,8 @@ module Google # Sets the access control policy on the specified Source. # @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::SecuritycenterV1p1beta1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -936,8 +892,8 @@ module Google # Returns the permissions that a caller has on the specified source. # @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::SecuritycenterV1p1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -968,11 +924,11 @@ module Google execute_or_queue_command(command, &block) end - # Creates a finding. The corresponding source must exist for finding - # creation to succeed. + # Creates a finding. The corresponding source must exist for finding creation + # to succeed. # @param [String] parent - # Required. Resource name of the new finding's parent. Its format should be - # "organizations/[organization_id]/sources/[source_id]". + # Required. Resource name of the new finding's parent. Its format should be " + # organizations/[organization_id]/sources/[source_id]". # @param [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding] google_cloud_securitycenter_v1p1beta1_finding_object # @param [String] finding_id # Required. Unique identifier provided by the client within the parent scope. @@ -1006,15 +962,13 @@ module Google execute_or_queue_command(command, &block) end - # Filters an organization or source's findings and groups them by their - # specified properties. - # To group across all sources provide a `-` as the source id. - # Example: /v1p1beta1/organizations/`organization_id`/sources/-/findings + # Filters an organization or source's findings and groups them by their + # specified properties. To group across all sources provide a `-` as the source + # id. Example: /v1p1beta1/organizations/`organization_id`/sources/-/findings # @param [String] parent - # Required. Name of the source to groupBy. Its format is - # "organizations/[organization_id]/sources/[source_id]". To groupBy across - # all sources provide a source_id of `-`. For example: - # organizations/`organization_id`/sources/- + # Required. Name of the source to groupBy. Its format is "organizations/[ + # organization_id]/sources/[source_id]". To groupBy across all sources provide a + # source_id of `-`. For example: organizations/`organization_id`/sources/- # @param [Google::Apis::SecuritycenterV1p1beta1::GroupFindingsRequest] group_findings_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1045,111 +999,80 @@ module Google execute_or_queue_command(command, &block) end - # Lists an organization or source's findings. - # To list across all sources provide a `-` as the source id. - # Example: /v1p1beta1/organizations/`organization_id`/sources/-/findings + # Lists an organization or source's findings. To list across all sources provide + # a `-` as the source id. Example: /v1p1beta1/organizations/`organization_id`/ + # sources/-/findings # @param [String] parent - # Required. Name of the source the findings belong to. Its format is - # "organizations/[organization_id]/sources/[source_id]". To list across all - # sources provide a source_id of `-`. For example: - # organizations/`organization_id`/sources/- + # Required. Name of the source the findings belong to. Its format is " + # organizations/[organization_id]/sources/[source_id]". To list across all + # sources provide a source_id of `-`. For example: organizations/` + # organization_id`/sources/- # @param [String] compare_duration # When compare_duration is set, the ListFindingsResult's "state_change" # attribute is updated to indicate whether the finding had its state changed, # the finding's state remained unchanged, or if the finding was added in any - # state during the compare_duration period of time that precedes the - # read_time. This is the time between (read_time - compare_duration) and - # read_time. - # The state_change value is derived based on the presence and state of the - # finding at the two points in time. Intermediate state changes between the - # two times don't affect the result. For example, the results aren't affected - # if the finding is made inactive and then active again. - # Possible "state_change" values when compare_duration is specified: - # * "CHANGED": indicates that the finding was present and matched the given - # filter at the start of compare_duration, but changed its - # state at read_time. - # * "UNCHANGED": indicates that the finding was present and matched the given - # filter at the start of compare_duration and did not change - # state at read_time. - # * "ADDED": indicates that the finding did not match the given filter or - # was not present at the start of compare_duration, but was - # present at read_time. - # * "REMOVED": indicates that the finding was present and matched the - # filter at the start of compare_duration, but did not match - # the filter at read_time. - # If compare_duration is not specified, then the only possible state_change - # is "UNUSED", which will be the state_change set for all findings present at - # read_time. + # state during the compare_duration period of time that precedes the read_time. + # This is the time between (read_time - compare_duration) and read_time. The + # state_change value is derived based on the presence and state of the finding + # at the two points in time. Intermediate state changes between the two times + # don't affect the result. For example, the results aren't affected if the + # finding is made inactive and then active again. Possible "state_change" values + # when compare_duration is specified: * "CHANGED": indicates that the finding + # was present and matched the given filter at the start of compare_duration, but + # changed its state at read_time. * "UNCHANGED": indicates that the finding was + # present and matched the given filter at the start of compare_duration and did + # not change state at read_time. * "ADDED": indicates that the finding did not + # match the given filter or was not present at the start of compare_duration, + # but was present at read_time. * "REMOVED": indicates that the finding was + # present and matched the filter at the start of compare_duration, but did not + # match the filter at read_time. If compare_duration is not specified, then the + # only possible state_change is "UNUSED", which will be the state_change set for + # all findings present at read_time. # @param [String] field_mask - # A field mask to specify the Finding fields to be listed in the response. - # An empty field mask will list all fields. + # A field mask to specify the Finding fields to be listed in the response. An + # empty field mask will list all fields. # @param [String] filter - # Expression that defines the filter to apply across findings. - # The expression is a list of one or more restrictions combined via logical - # operators `AND` and `OR`. - # Parentheses are supported, and `OR` has higher precedence than `AND`. - # Restrictions have the form ` ` and may have a `-` - # character in front of them to indicate negation. Examples include: - # * name - # * source_properties.a_property - # * security_marks.marks.marka - # The supported operators are: - # * `=` for all value types. - # * `>`, `<`, `>=`, `<=` for integer values. - # * `:`, meaning substring matching, for strings. - # The supported value types are: - # * string literals in quotes. - # * integer literals without quotes. - # * boolean literals `true` and `false` without quotes. - # The following field and operator combinations are supported: - # name: `=` - # parent: `=`, `:` - # resource_name: `=`, `:` - # state: `=`, `:` - # category: `=`, `:` - # external_uri: `=`, `:` - # event_time: `=`, `>`, `<`, `>=`, `<=` - # Usage: This should be milliseconds since epoch or an RFC3339 string. - # Examples: - # `event_time = "2019-06-10T16:07:18-07:00"` - # `event_time = 1560208038000` - # security_marks.marks: `=`, `:` - # source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` - # For example, `source_properties.size = 100` is a valid filter string. - # Use a partial match on the empty string to filter based on a property - # existing: `source_properties.my_property : ""` - # Use a negated partial match on the empty string to filter based on a - # property not existing: `-source_properties.my_property : ""` + # Expression that defines the filter to apply across findings. The expression is + # a list of one or more restrictions combined via logical operators `AND` and ` + # OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. + # Restrictions have the form ` ` and may have a `-` character in front of them + # to indicate negation. Examples include: * name * source_properties.a_property * + # security_marks.marks.marka The supported operators are: * `=` for all value + # types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring + # matching, for strings. The supported value types are: * string literals in + # quotes. * integer literals without quotes. * boolean literals `true` and ` + # false` without quotes. The following field and operator combinations are + # supported: name: `=` parent: `=`, `:` resource_name: `=`, `:` state: `=`, `:` + # category: `=`, `:` external_uri: `=`, `:` event_time: `=`, `>`, `<`, `>=`, `<=` + # Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: + # `event_time = "2019-06-10T16:07:18-07:00"` `event_time = 1560208038000` + # security_marks.marks: `=`, `:` source_properties: `=`, `:`, `>`, `<`, `>=`, `<= + # ` For example, `source_properties.size = 100` is a valid filter string. Use a + # partial match on the empty string to filter based on a property existing: ` + # source_properties.my_property : ""` Use a negated partial match on the empty + # string to filter based on a property not existing: `-source_properties. + # my_property : ""` # @param [String] order_by - # Expression that defines what fields and order to use for sorting. The - # string value should follow SQL syntax: comma separated list of fields. For - # example: "name,resource_properties.a_property". The default sorting order - # is ascending. To specify descending order for a field, a suffix " desc" - # should be appended to the field name. For example: "name - # desc,source_properties.a_property". Redundant space characters in the - # syntax are insignificant. "name desc,source_properties.a_property" and " - # name desc , source_properties.a_property " are equivalent. - # The following fields are supported: - # name - # parent - # state - # category - # resource_name - # event_time - # source_properties - # security_marks.marks + # Expression that defines what fields and order to use for sorting. The string + # value should follow SQL syntax: comma separated list of fields. For example: " + # name,resource_properties.a_property". The default sorting order is ascending. + # To specify descending order for a field, a suffix " desc" should be appended + # to the field name. For example: "name desc,source_properties.a_property". + # Redundant space characters in the syntax are insignificant. "name desc, + # source_properties.a_property" and " name desc , source_properties.a_property " + # are equivalent. The following fields are supported: name parent state category + # resource_name event_time source_properties security_marks.marks # @param [Fixnum] page_size - # The maximum number of results to return in a single response. Default is - # 10, minimum is 1, maximum is 1000. + # The maximum number of results to return in a single response. Default is 10, + # minimum is 1, maximum is 1000. # @param [String] page_token - # The value returned by the last `ListFindingsResponse`; indicates - # that this is a continuation of a prior `ListFindings` call, and - # that the system should return the next page of data. + # The value returned by the last `ListFindingsResponse`; indicates that this is + # a continuation of a prior `ListFindings` call, and that the system should + # return the next page of data. # @param [String] read_time - # Time used as a reference point when filtering findings. The filter is - # limited to findings existing at the supplied time and their values are - # those at that specific time. Absence of this field will default to the - # API's version of NOW. + # Time used as a reference point when filtering findings. The filter is limited + # to findings existing at the supplied time and their values are those at that + # specific time. Absence of this field will default to the API's version of NOW. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1187,18 +1110,16 @@ module Google # Creates or updates a finding. The corresponding source must exist for a # finding creation to succeed. # @param [String] name - # The relative resource name of this finding. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`" + # The relative resource name of this finding. See: https://cloud.google.com/apis/ + # design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`" # @param [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding] google_cloud_securitycenter_v1p1beta1_finding_object # @param [String] update_mask - # The FieldMask to use when updating the finding resource. This field should - # not be specified when creating a finding. - # When updating a finding, an empty mask is treated as updating all mutable - # fields and replacing source_properties. Individual source_properties can - # be added/updated by using "source_properties." in the field - # mask. + # The FieldMask to use when updating the finding resource. This field should not + # be specified when creating a finding. When updating a finding, an empty mask + # is treated as updating all mutable fields and replacing source_properties. + # Individual source_properties can be added/updated by using "source_properties." + # in the field mask. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1231,10 +1152,9 @@ module Google # Updates the state of a finding. # @param [String] name - # Required. The relative resource name of the finding. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Example: - # "organizations/`organization_id`/sources/`source_id`/finding/`finding_id`". + # Required. The relative resource name of the finding. See: https://cloud.google. + # com/apis/design/resource_names#relative_resource_name Example: "organizations/` + # organization_id`/sources/`source_id`/finding/`finding_id`". # @param [Google::Apis::SecuritycenterV1p1beta1::SetFindingStateRequest] set_finding_state_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1267,22 +1187,19 @@ module Google # Updates security marks. # @param [String] name - # The relative resource name of the SecurityMarks. See: - # https://cloud.google.com/apis/design/resource_names#relative_resource_name - # Examples: - # "organizations/`organization_id`/assets/`asset_id`/securityMarks" - # "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/ - # securityMarks". + # The relative resource name of the SecurityMarks. See: https://cloud.google.com/ + # apis/design/resource_names#relative_resource_name Examples: "organizations/` + # organization_id`/assets/`asset_id`/securityMarks" "organizations/` + # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks". # @param [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] google_cloud_securitycenter_v1p1beta1_security_marks_object # @param [String] start_time - # The time at which the updated SecurityMarks take effect. - # If not set uses current server time. Updates will be applied to the - # SecurityMarks that are active immediately preceding this time. + # The time at which the updated SecurityMarks take effect. If not set uses + # current server time. Updates will be applied to the SecurityMarks that are + # active immediately preceding this time. # @param [String] update_mask - # The FieldMask to use when updating the security marks resource. - # The field mask must not contain duplicate fields. - # If empty or set to "marks", all marks will be replaced. Individual - # marks can be updated using "marks.". + # The FieldMask to use when updating the security marks resource. The field mask + # must not contain duplicate fields. If empty or set to "marks", all marks will + # be replaced. Individual marks can be updated using "marks.". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/serviceconsumermanagement_v1.rb b/generated/google/apis/serviceconsumermanagement_v1.rb index fc989a29d..f600fe9f0 100644 --- a/generated/google/apis/serviceconsumermanagement_v1.rb +++ b/generated/google/apis/serviceconsumermanagement_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/service-consumer-management/docs/overview module ServiceconsumermanagementV1 VERSION = 'V1' - REVISION = '20200722' + REVISION = '20200801' # 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/serviceconsumermanagement_v1/classes.rb b/generated/google/apis/serviceconsumermanagement_v1/classes.rb index b122eaeae..e0d4bd548 100644 --- a/generated/google/apis/serviceconsumermanagement_v1/classes.rb +++ b/generated/google/apis/serviceconsumermanagement_v1/classes.rb @@ -22,8 +22,7 @@ module Google module Apis module ServiceconsumermanagementV1 - # Request to add a newly created and configured tenant project to a tenancy - # unit. + # Request to add a newly created and configured tenant project to a tenancy unit. class AddTenantProjectRequest include Google::Apis::Core::Hashable @@ -51,14 +50,13 @@ module Google end end - # Api is a light-weight descriptor for an API Interface. - # Interfaces are also described as "protocol buffer services" in some contexts, - # such as by the "service" keyword in a .proto file, but they are different - # from API Services, which represent a concrete implementation of an interface - # as opposed to simply a description of methods and bindings. They are also - # sometimes simply referred to as "APIs" in other contexts, such as the name of - # this message itself. See https://cloud.google.com/apis/design/glossary for - # detailed terminology. + # Api is a light-weight descriptor for an API Interface. Interfaces are also + # described as "protocol buffer services" in some contexts, such as by the " + # service" keyword in a .proto file, but they are different from API Services, + # which represent a concrete implementation of an interface as opposed to simply + # a description of methods and bindings. They are also sometimes simply referred + # to as "APIs" in other contexts, such as the name of this message itself. See + # https://cloud.google.com/apis/design/glossary for detailed terminology. class Api include Google::Apis::Core::Hashable @@ -72,8 +70,8 @@ module Google # @return [Array] attr_accessor :mixins - # The fully qualified name of this interface, including package name - # followed by the interface's simple name. + # The fully qualified name of this interface, including package name followed by + # the interface's simple name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -83,8 +81,8 @@ module Google # @return [Array] attr_accessor :options - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. # Corresponds to the JSON property `sourceContext` # @return [Google::Apis::ServiceconsumermanagementV1::SourceContext] attr_accessor :source_context @@ -94,23 +92,19 @@ module Google # @return [String] attr_accessor :syntax - # A version string for this interface. If specified, must have the form - # `major-version.minor-version`, as in `1.10`. If the minor version is - # omitted, it defaults to zero. If the entire version field is empty, the - # major version is derived from the package name, as outlined below. If the - # field is not empty, the version in the package name will be verified to be - # consistent with what is provided here. - # The versioning schema uses [semantic - # versioning](http://semver.org) where the major version number - # indicates a breaking change and the minor version an additive, - # non-breaking change. Both version numbers are signals to users - # what to expect from different versions, and should be carefully - # chosen based on the product plan. - # The major version is also reflected in the package name of the - # interface, which must end in `v`, as in - # `google.feature.v1`. For major versions 0 and 1, the suffix can - # be omitted. Zero major versions must only be used for - # experimental, non-GA interfaces. + # A version string for this interface. If specified, must have the form `major- + # version.minor-version`, as in `1.10`. If the minor version is omitted, it + # defaults to zero. If the entire version field is empty, the major version is + # derived from the package name, as outlined below. If the field is not empty, + # the version in the package name will be verified to be consistent with what is + # provided here. The versioning schema uses [semantic versioning](http://semver. + # org) where the major version number indicates a breaking change and the minor + # version an additive, non-breaking change. Both version numbers are signals to + # users what to expect from different versions, and should be carefully chosen + # based on the product plan. The major version is also reflected in the package + # name of the interface, which must end in `v`, as in `google.feature.v1`. For + # major versions 0 and 1, the suffix can be omitted. Zero major versions must + # only be used for experimental, non-GA interfaces. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -164,22 +158,21 @@ module Google class AttachTenantProjectRequest include Google::Apis::Core::Hashable - # When attaching an external project, this is in the format of - # `projects/`project_number``. + # When attaching an external project, this is in the format of `projects/` + # project_number``. # Corresponds to the JSON property `externalResource` # @return [String] attr_accessor :external_resource - # When attaching a reserved project already in tenancy units, this is the - # tag of a tenant resource under the tenancy unit for the managed service's - # service producer project. The reserved tenant resource must be in an - # active state. + # When attaching a reserved project already in tenancy units, this is the tag of + # a tenant resource under the tenancy unit for the managed service's service + # producer project. The reserved tenant resource must be in an active state. # Corresponds to the JSON property `reservedResource` # @return [String] attr_accessor :reserved_resource - # Tag of the tenant resource after attachment. - # Must be less than 128 characters. Required. + # Tag of the tenant resource after attachment. Must be less than 128 characters. + # Required. # Corresponds to the JSON property `tag` # @return [String] attr_accessor :tag @@ -196,85 +189,63 @@ module Google end end - # Configuration for an authentication provider, including support for - # [JSON Web Token - # (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + # Configuration for an authentication provider, including support for [JSON Web + # Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). class AuthProvider include Google::Apis::Core::Hashable - # The list of JWT - # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32# - # section-4.1.3). - # that are allowed to access. A JWT containing any of these audiences will - # be accepted. When this setting is absent, JWTs with audiences: - # - "https://[service.name]/[google.protobuf.Api.name]" - # - "https://[service.name]/" - # will be accepted. - # For example, if no audiences are in the setting, LibraryService API will - # accept JWTs with the following audiences: - # - + # The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json- + # web-token-32#section-4.1.3). that are allowed to access. A JWT containing any + # of these audiences will be accepted. When this setting is absent, JWTs with + # audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[ + # service.name]/" will be accepted. For example, if no audiences are in the + # setting, LibraryService API will accept JWTs with the following audiences: - # https://library-example.googleapis.com/google.example.library.v1. - # LibraryService - # - https://library-example.googleapis.com/ - # Example: - # audiences: bookstore_android.apps.googleusercontent.com, - # bookstore_web.apps.googleusercontent.com + # LibraryService - https://library-example.googleapis.com/ Example: audiences: + # bookstore_android.apps.googleusercontent.com, bookstore_web.apps. + # googleusercontent.com # Corresponds to the JSON property `audiences` # @return [String] attr_accessor :audiences - # Redirect URL if JWT token is required but not present or is expired. - # Implement authorizationUrl of securityDefinitions in OpenAPI spec. + # Redirect URL if JWT token is required but not present or is expired. Implement + # authorizationUrl of securityDefinitions in OpenAPI spec. # Corresponds to the JSON property `authorizationUrl` # @return [String] attr_accessor :authorization_url - # The unique identifier of the auth provider. It will be referred to by - # `AuthRequirement.provider_id`. - # Example: "bookstore_auth". + # The unique identifier of the auth provider. It will be referred to by ` + # AuthRequirement.provider_id`. Example: "bookstore_auth". # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Identifies the principal that issued the JWT. See - # https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - # Usually a URL or an email address. - # Example: https://securetoken.google.com - # Example: 1234567-compute@developer.gserviceaccount.com + # Identifies the principal that issued the JWT. See https://tools.ietf.org/html/ + # draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email + # address. Example: https://securetoken.google.com Example: 1234567-compute@ + # developer.gserviceaccount.com # Corresponds to the JSON property `issuer` # @return [String] attr_accessor :issuer - # URL of the provider's public key set to validate signature of the JWT. See - # [OpenID - # Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html# - # ProviderMetadata). - # Optional if the key set document: - # - can be retrieved from - # [OpenID - # Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of - # the issuer. - # - can be inferred from the email domain of the issuer (e.g. a Google - # service account). - # Example: https://www.googleapis.com/oauth2/v1/certs + # URL of the provider's public key set to validate signature of the JWT. See [ + # OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html# + # ProviderMetadata). Optional if the key set document: - can be retrieved from [ + # OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html + # of the issuer. - can be inferred from the email domain of the issuer (e.g. a + # Google service account). Example: https://www.googleapis.com/oauth2/v1/certs # Corresponds to the JSON property `jwksUri` # @return [String] attr_accessor :jwks_uri - # Defines the locations to extract the JWT. - # JWT locations can be either from HTTP headers or URL query parameters. - # The rule is that the first match wins. The checking order is: checking - # all headers first, then URL query parameters. - # If not specified, default to use following 3 locations: - # 1) Authorization: Bearer - # 2) x-goog-iap-jwt-assertion - # 3) access_token query parameter - # Default locations can be specified as followings: - # jwt_locations: - # - header: Authorization - # value_prefix: "Bearer " - # - header: x-goog-iap-jwt-assertion - # - query: access_token + # Defines the locations to extract the JWT. JWT locations can be either from + # HTTP headers or URL query parameters. The rule is that the first match wins. + # The checking order is: checking all headers first, then URL query parameters. + # If not specified, default to use following 3 locations: 1) Authorization: + # Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default + # locations can be specified as followings: jwt_locations: - header: + # Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - + # query: access_token # Corresponds to the JSON property `jwtLocations` # @return [Array] attr_accessor :jwt_locations @@ -294,34 +265,26 @@ module Google end end - # User-defined authentication requirements, including support for - # [JSON Web Token - # (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + # User-defined authentication requirements, including support for [JSON Web + # Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). class AuthRequirement include Google::Apis::Core::Hashable - # NOTE: This will be deprecated soon, once AuthProvider.audiences is - # implemented and accepted in all the runtime components. - # The list of JWT - # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32# - # section-4.1.3). - # that are allowed to access. A JWT containing any of these audiences will - # be accepted. When this setting is absent, only JWTs with audience - # "https://Service_name/API_name" - # will be accepted. For example, if no audiences are in the setting, - # LibraryService API will only accept JWTs with the following audience - # "https://library-example.googleapis.com/google.example.library.v1. - # LibraryService". - # Example: - # audiences: bookstore_android.apps.googleusercontent.com, - # bookstore_web.apps.googleusercontent.com + # NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented + # and accepted in all the runtime components. The list of JWT [audiences](https:/ + # /tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that + # are allowed to access. A JWT containing any of these audiences will be + # accepted. When this setting is absent, only JWTs with audience "https:// + # Service_name/API_name" will be accepted. For example, if no audiences are in + # the setting, LibraryService API will only accept JWTs with the following + # audience "https://library-example.googleapis.com/google.example.library.v1. + # LibraryService". Example: audiences: bookstore_android.apps.googleusercontent. + # com, bookstore_web.apps.googleusercontent.com # Corresponds to the JSON property `audiences` # @return [String] attr_accessor :audiences - # id from authentication provider. - # Example: - # provider_id: bookstore_auth + # id from authentication provider. Example: provider_id: bookstore_auth # Corresponds to the JSON property `providerId` # @return [String] attr_accessor :provider_id @@ -337,18 +300,11 @@ module Google end end - # `Authentication` defines the authentication configuration for an API. - # Example for an API targeted for external use: - # name: calendar.googleapis.com - # authentication: - # providers: - # - id: google_calendar_auth - # jwks_uri: https://www.googleapis.com/oauth2/v1/certs - # issuer: https://securetoken.google.com - # rules: - # - selector: "*" - # requirements: - # provider_id: google_calendar_auth + # `Authentication` defines the authentication configuration for an API. Example + # for an API targeted for external use: name: calendar.googleapis.com + # authentication: providers: - id: google_calendar_auth jwks_uri: https://www. + # googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - + # selector: "*" requirements: provider_id: google_calendar_auth class Authentication include Google::Apis::Core::Hashable @@ -357,8 +313,8 @@ module Google # @return [Array] attr_accessor :providers - # A list of authentication rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of authentication rules that apply to individual API methods. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -374,13 +330,11 @@ module Google end end - # Authentication rules for the service. - # By default, if a method has any authentication requirements, every request - # must include a valid credential matching one of the requirements. - # It's an error to include more than one kind of credential in a single - # request. - # If a method doesn't have any auth requirements, request credentials will be - # ignored. + # Authentication rules for the service. By default, if a method has any + # authentication requirements, every request must include a valid credential + # matching one of the requirements. It's an error to include more than one kind + # of credential in a single request. If a method doesn't have any auth + # requirements, request credentials will be ignored. class AuthenticationRule include Google::Apis::Core::Hashable @@ -391,19 +345,18 @@ module Google alias_method :allow_without_credential?, :allow_without_credential # OAuth scopes are a way to define data and permissions on data. For example, - # there are scopes defined for "Read-only access to Google Calendar" and - # "Access to Cloud Platform". Users can consent to a scope for an application, - # giving it permission to access that data on their behalf. - # OAuth scope specifications should be fairly coarse grained; a user will need - # to see and understand the text description of what your scope means. - # In most cases: use one or at most two OAuth scopes for an entire family of - # products. If your product has multiple APIs, you should probably be sharing - # the OAuth scope across all of those APIs. - # When you need finer grained OAuth consent screens: talk with your product - # management about how developers will use them in practice. - # Please note that even though each of the canonical scopes is enough for a - # request to be accepted and passed to the backend, a request can still fail - # due to the backend requiring additional scopes or permissions. + # there are scopes defined for "Read-only access to Google Calendar" and "Access + # to Cloud Platform". Users can consent to a scope for an application, giving it + # permission to access that data on their behalf. OAuth scope specifications + # should be fairly coarse grained; a user will need to see and understand the + # text description of what your scope means. In most cases: use one or at most + # two OAuth scopes for an entire family of products. If your product has + # multiple APIs, you should probably be sharing the OAuth scope across all of + # those APIs. When you need finer grained OAuth consent screens: talk with your + # product management about how developers will use them in practice. Please note + # that even though each of the canonical scopes is enough for a request to be + # accepted and passed to the backend, a request can still fail due to the + # backend requiring additional scopes or permissions. # Corresponds to the JSON property `oauth` # @return [Google::Apis::ServiceconsumermanagementV1::OAuthRequirements] attr_accessor :oauth @@ -413,8 +366,8 @@ module Google # @return [Array] attr_accessor :requirements - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -436,8 +389,8 @@ module Google class Backend include Google::Apis::Core::Hashable - # A list of API backend rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of API backend rules that apply to individual API methods. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -456,21 +409,13 @@ module Google class BackendRule include Google::Apis::Core::Hashable - # The address of the API backend. - # The scheme is used to determine the backend protocol and security. - # The following schemes are accepted: - # SCHEME PROTOCOL SECURITY - # http:// HTTP None - # https:// HTTP TLS - # grpc:// gRPC None - # grpcs:// gRPC TLS - # It is recommended to explicitly include a scheme. Leaving out the scheme - # may cause constrasting behaviors across platforms. - # If the port is unspecified, the default is: - # - 80 for schemes without TLS - # - 443 for schemes with TLS - # For HTTP backends, use protocol - # to specify the protocol version. + # The address of the API backend. The scheme is used to determine the backend + # protocol and security. The following schemes are accepted: SCHEME PROTOCOL + # SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC + # TLS It is recommended to explicitly include a scheme. Leaving out the scheme + # may cause constrasting behaviors across platforms. If the port is unspecified, + # the default is: - 80 for schemes without TLS - 443 for schemes with TLS For + # HTTP backends, use protocol to specify the protocol version. # Corresponds to the JSON property `address` # @return [String] attr_accessor :address @@ -481,18 +426,18 @@ module Google # @return [Float] attr_accessor :deadline - # When disable_auth is true, a JWT ID token won't be generated and the - # original "Authorization" HTTP header will be preserved. If the header is - # used to carry the original token and is expected by the backend, this - # field must be set to true to preserve the header. + # When disable_auth is true, a JWT ID token won't be generated and the original " + # Authorization" HTTP header will be preserved. If the header is used to carry + # the original token and is expected by the backend, this field must be set to + # true to preserve the header. # Corresponds to the JSON property `disableAuth` # @return [Boolean] attr_accessor :disable_auth alias_method :disable_auth?, :disable_auth - # The JWT audience is used when generating a JWT ID token for the backend. - # This ID token will be added in the HTTP "authorization" header, and sent - # to the backend. + # The JWT audience is used when generating a JWT ID token for the backend. This + # ID token will be added in the HTTP "authorization" header, and sent to the + # backend. # Corresponds to the JSON property `jwtAudience` # @return [String] attr_accessor :jwt_audience @@ -503,8 +448,8 @@ module Google # @return [Float] attr_accessor :min_deadline - # The number of seconds to wait for the completion of a long running - # operation. The default is no deadline. + # The number of seconds to wait for the completion of a long running operation. + # The default is no deadline. # Corresponds to the JSON property `operationDeadline` # @return [Float] attr_accessor :operation_deadline @@ -514,29 +459,21 @@ module Google # @return [String] attr_accessor :path_translation - # The protocol used for sending a request to the backend. - # The supported values are "http/1.1" and "h2". - # The default value is inferred from the scheme in the - # address field: - # SCHEME PROTOCOL - # http:// http/1.1 - # https:// http/1.1 - # grpc:// h2 - # grpcs:// h2 - # For secure HTTP backends (https://) that support HTTP/2, set this field - # to "h2" for improved performance. - # Configuring this field to non-default values is only supported for secure - # HTTP backends. This field will be ignored for all other backends. - # See - # https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype- - # values.xhtml#alpn-protocol-ids - # for more details on the supported values. + # The protocol used for sending a request to the backend. The supported values + # are "http/1.1" and "h2". The default value is inferred from the scheme in the + # address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 + # grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this + # field to "h2" for improved performance. Configuring this field to non-default + # values is only supported for secure HTTP backends. This field will be ignored + # for all other backends. See https://www.iana.org/assignments/tls-extensiontype- + # values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on + # the supported values. # Corresponds to the JSON property `protocol` # @return [String] attr_accessor :protocol - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -559,42 +496,28 @@ module Google end end - # Billing related configuration of the service. - # The following example shows how to configure monitored resources and metrics - # for billing, `consumer_destinations` is the only supported destination and - # the monitored resources need at least one label key - # `cloud.googleapis.com/location` to indicate the location of the billing - # usage, using different monitored resources between monitoring and billing is - # recommended so they can be evolved independently: - # monitored_resources: - # - type: library.googleapis.com/billing_branch - # labels: - # - key: cloud.googleapis.com/location - # description: | - # Predefined label to support billing location restriction. - # - key: city - # description: | - # Custom label to define the city where the library branch is located - # in. - # - key: name - # description: Custom label to define the name of the library branch. - # metrics: - # - name: library.googleapis.com/book/borrowed_count - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # billing: - # consumer_destinations: - # - monitored_resource: library.googleapis.com/billing_branch - # metrics: - # - library.googleapis.com/book/borrowed_count + # Billing related configuration of the service. The following example shows how + # to configure monitored resources and metrics for billing, ` + # consumer_destinations` is the only supported destination and the monitored + # resources need at least one label key `cloud.googleapis.com/location` to + # indicate the location of the billing usage, using different monitored + # resources between monitoring and billing is recommended so they can be evolved + # independently: monitored_resources: - type: library.googleapis.com/ + # billing_branch labels: - key: cloud.googleapis.com/location description: | + # Predefined label to support billing location restriction. - key: city + # description: | Custom label to define the city where the library branch is + # located in. - key: name description: Custom label to define the name of the + # library branch. metrics: - name: library.googleapis.com/book/borrowed_count + # metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: + # - monitored_resource: library.googleapis.com/billing_branch metrics: - library. + # googleapis.com/book/borrowed_count class Billing include Google::Apis::Core::Hashable - # Billing configurations for sending metrics to the consumer project. - # There can be multiple consumer destinations per service, each one must have - # a different monitored resource type. A metric can be used in at most - # one consumer destination. + # Billing configurations for sending metrics to the consumer project. There can + # be multiple consumer destinations per service, each one must have a different + # monitored resource type. A metric can be used in at most one consumer + # destination. # Corresponds to the JSON property `consumerDestinations` # @return [Array] attr_accessor :consumer_destinations @@ -613,8 +536,8 @@ module Google class BillingConfig include Google::Apis::Core::Hashable - # Name of the billing account. - # For example `billingAccounts/012345-567890-ABCDEF`. + # Name of the billing account. For example `billingAccounts/012345-567890-ABCDEF` + # . # Corresponds to the JSON property `billingAccount` # @return [String] attr_accessor :billing_account @@ -629,19 +552,19 @@ module Google end end - # Configuration of a specific billing destination (Currently only support - # bill against consumer project). + # Configuration of a specific billing destination (Currently only support bill + # against consumer project). class BillingDestination include Google::Apis::Core::Hashable - # Names of the metrics to report to this billing destination. - # Each name must be defined in Service.metrics section. + # Names of the metrics to report to this billing destination. Each name must be + # defined in Service.metrics section. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics - # The monitored resource type. The type must be defined in - # Service.monitored_resources section. + # The monitored resource type. The type must be defined in Service. + # monitored_resources section. # Corresponds to the JSON property `monitoredResource` # @return [String] attr_accessor :monitored_resource @@ -670,39 +593,24 @@ module Google end end - # `Context` defines which contexts an API requests. - # Example: - # context: - # rules: - # - selector: "*" - # requested: - # - google.rpc.context.ProjectContext - # - google.rpc.context.OriginContext - # The above specifies that all methods in the API request - # `google.rpc.context.ProjectContext` and - # `google.rpc.context.OriginContext`. - # Available context types are defined in package - # `google.rpc.context`. - # This also provides mechanism to whitelist any protobuf message extension that - # can be sent in grpc metadata using “x-goog-ext--bin” and - # “x-goog-ext--jspb” format. For example, list any service - # specific protobuf types that can appear in grpc metadata as follows in your - # yaml file: - # Example: - # context: - # rules: - # - selector: "google.example.library.v1.LibraryService.CreateBook" - # allowed_request_extensions: - # - google.foo.v1.NewExtension - # allowed_response_extensions: - # - google.foo.v1.NewExtension - # You can also specify extension ID instead of fully qualified extension name - # here. + # `Context` defines which contexts an API requests. Example: context: rules: - + # selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc. + # context.OriginContext The above specifies that all methods in the API request ` + # google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. + # Available context types are defined in package `google.rpc.context`. This also + # provides mechanism to whitelist any protobuf message extension that can be + # sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. + # For example, list any service specific protobuf types that can appear in grpc + # metadata as follows in your yaml file: Example: context: rules: - selector: " + # google.example.library.v1.LibraryService.CreateBook" + # allowed_request_extensions: - google.foo.v1.NewExtension + # allowed_response_extensions: - google.foo.v1.NewExtension You can also specify + # extension ID instead of fully qualified extension name here. class Context include Google::Apis::Core::Hashable - # A list of RPC context rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of RPC context rules that apply to individual API methods. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -722,14 +630,14 @@ module Google class ContextRule include Google::Apis::Core::Hashable - # A list of full type names or extension IDs of extensions allowed in grpc - # side channel from client to backend. + # A list of full type names or extension IDs of extensions allowed in grpc side + # channel from client to backend. # Corresponds to the JSON property `allowedRequestExtensions` # @return [Array] attr_accessor :allowed_request_extensions - # A list of full type names or extension IDs of extensions allowed in grpc - # side channel from backend to client. + # A list of full type names or extension IDs of extensions allowed in grpc side + # channel from backend to client. # Corresponds to the JSON property `allowedResponseExtensions` # @return [Array] attr_accessor :allowed_response_extensions @@ -744,8 +652,8 @@ module Google # @return [Array] attr_accessor :requested - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -764,14 +672,14 @@ module Google end end - # Selects and configures the service controller used by the service. The - # service controller handles features like abuse, quota, billing, logging, - # monitoring, etc. + # Selects and configures the service controller used by the service. The service + # controller handles features like abuse, quota, billing, logging, monitoring, + # etc. class Control include Google::Apis::Core::Hashable - # The service control environment to use. If empty, no control plane - # feature (like quota and billing) will be enabled. + # The service control environment to use. If empty, no control plane feature ( + # like quota and billing) will be enabled. # Corresponds to the JSON property `environment` # @return [String] attr_accessor :environment @@ -791,13 +699,12 @@ module Google include Google::Apis::Core::Hashable # Optional. Optional service producer-provided identifier of the tenancy unit. - # Must be no longer than 40 characters and preferably URI friendly. - # If it isn't provided, a UID for the tenancy unit is automatically - # generated. The identifier must be unique across a managed service. - # If the tenancy unit already exists for the managed service and service - # consumer pair, calling `CreateTenancyUnit` returns the existing tenancy - # unit if the provided identifier is identical or empty, otherwise the call - # fails. + # Must be no longer than 40 characters and preferably URI friendly. If it isn't + # provided, a UID for the tenancy unit is automatically generated. The + # identifier must be unique across a managed service. If the tenancy unit + # already exists for the managed service and service consumer pair, calling ` + # CreateTenancyUnit` returns the existing tenancy unit if the provided + # identifier is identical or empty, otherwise the call fails. # Corresponds to the JSON property `tenancyUnitId` # @return [String] attr_accessor :tenancy_unit_id @@ -812,19 +719,15 @@ module Google end end - # Customize service error responses. For example, list any service - # specific protobuf types that can appear in error detail lists of - # error responses. - # Example: - # custom_error: - # types: - # - google.foo.v1.CustomError - # - google.foo.v1.AnotherError + # Customize service error responses. For example, list any service specific + # protobuf types that can appear in error detail lists of error responses. + # Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1. + # AnotherError class CustomError include Google::Apis::Core::Hashable - # The list of custom error rules that apply to individual API messages. - # **NOTE:** All service configuration rules follow "last one wins" order. + # The list of custom error rules that apply to individual API messages. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -849,15 +752,15 @@ module Google class CustomErrorRule include Google::Apis::Core::Hashable - # Mark this message as possible payload in error response. Otherwise, - # objects of this type will be filtered when they appear in error payload. + # Mark this message as possible payload in error response. Otherwise, objects of + # this type will be filtered when they appear in error payload. # Corresponds to the JSON property `isErrorType` # @return [Boolean] attr_accessor :is_error_type alias_method :is_error_type?, :is_error_type - # Selects messages to which this rule applies. - # Refer to selector for syntax details. + # Selects messages to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -917,56 +820,32 @@ module Google end end - # `Documentation` provides the information for describing a service. - # Example: - # 
documentation:
-      # summary: >
-      # The Google Calendar API gives access
-      # to most calendar features.
-      # pages:
-      # - name: Overview
-      # content: (== include google/foo/overview.md ==)
-      # - name: Tutorial
-      # content: (== include google/foo/tutorial.md ==)
-      # subpages;
-      # - name: Java
-      # content: (== include google/foo/tutorial_java.md ==)
-      # rules:
-      # - selector: google.calendar.Calendar.Get
-      # description: >
-      # ...
-      # - selector: google.calendar.Calendar.Put
-      # description: >
-      # ...
-      #
- # Documentation is provided in markdown syntax. In addition to - # standard markdown features, definition lists, tables and fenced - # code blocks are supported. Section headers can be provided and are - # interpreted relative to the section nesting of the context where - # a documentation fragment is embedded. - # Documentation from the IDL is merged with documentation defined - # via the config at normalization time, where documentation provided - # by config rules overrides IDL provided. - # A number of constructs specific to the API platform are supported - # in documentation text. - # In order to reference a proto element, the following - # notation can be used: - # 
[fully.qualified.proto.name][]
- # To override the display text used for the link, this can be used: - # 
[display text][fully.qualified.proto.name]
- # Text can be excluded from doc using the following notation: - # 
(-- internal comment --)
- # A few directives are available in documentation. Note that - # directives must appear on a single line to be properly - # identified. The `include` directive includes a markdown file from - # an external source: - # 
(== include path/to/file ==)
- # The `resource_for` directive marks a message to be the resource of - # a collection in REST view. If it is not specified, tools attempt - # to infer the resource from the operations in a collection: - # 
(== resource_for v1.shelves.books ==)
- # The directive `suppress_warning` does not directly affect documentation - # and is documented together with service config validation. + # `Documentation` provides the information for describing a service. Example: + # documentation: summary: > The Google Calendar API gives access to most + # calendar features. pages: - name: Overview content: (== include google/foo/ + # overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md == + # ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==) + # rules: - selector: google.calendar.Calendar.Get description: > ... - selector: + # google.calendar.Calendar.Put description: > ... Documentation is provided in + # markdown syntax. In addition to standard markdown features, definition lists, + # tables and fenced code blocks are supported. Section headers can be provided + # and are interpreted relative to the section nesting of the context where a + # documentation fragment is embedded. Documentation from the IDL is merged with + # documentation defined via the config at normalization time, where + # documentation provided by config rules overrides IDL provided. A number of + # constructs specific to the API platform are supported in documentation text. + # In order to reference a proto element, the following notation can be used: [ + # fully.qualified.proto.name][] To override the display text used for the link, + # this can be used: [display text][fully.qualified.proto.name] Text can be + # excluded from doc using the following notation: (-- internal comment --) A few + # directives are available in documentation. Note that directives must appear on + # a single line to be properly identified. The `include` directive includes a + # markdown file from an external source: (== include path/to/file ==) The ` + # resource_for` directive marks a message to be the resource of a collection in + # REST view. If it is not specified, tools attempt to infer the resource from + # the operations in a collection: (== resource_for v1.shelves.books ==) The + # directive `suppress_warning` does not directly affect documentation and is + # documented together with service config validation. class Documentation include Google::Apis::Core::Hashable @@ -975,19 +854,11 @@ module Google # @return [String] attr_accessor :documentation_root_url - # Declares a single overview page. For example: - # 
documentation:
-        # summary: ...
-        # overview: (== include overview.md ==)
-        #
- # This is a shortcut for the following declaration (using pages style): - # 
documentation:
-        # summary: ...
-        # pages:
-        # - name: Overview
-        # content: (== include overview.md ==)
-        #
- # Note: you cannot specify both `overview` field and `pages` field. + # Declares a single overview page. For example: documentation: summary: ... + # overview: (== include overview.md ==) This is a shortcut for the following + # declaration (using pages style): documentation: summary: ... pages: - name: + # Overview content: (== include overview.md ==) Note: you cannot specify both ` + # overview` field and `pages` field. # Corresponds to the JSON property `overview` # @return [String] attr_accessor :overview @@ -997,22 +868,20 @@ module Google # @return [Array] attr_accessor :pages - # A list of documentation rules that apply to individual API elements. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of documentation rules that apply to individual API elements. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules - # Specifies the service root url if the default one (the service name - # from the yaml file) is not suitable. This can be seen in any fully - # specified service urls as well as sections that show a base that other - # urls are relative to. + # Specifies the service root url if the default one (the service name from the + # yaml file) is not suitable. This can be seen in any fully specified service + # urls as well as sections that show a base that other urls are relative to. # Corresponds to the JSON property `serviceRootUrl` # @return [String] attr_accessor :service_root_url - # A short summary of what the service does. Can only be provided by - # plain text. + # A short summary of what the service does. Can only be provided by plain text. # Corresponds to the JSON property `summary` # @return [String] attr_accessor :summary @@ -1036,8 +905,8 @@ module Google class DocumentationRule include Google::Apis::Core::Hashable - # Deprecation description of the selected element(s). It can be provided if - # an element is marked as `deprecated`. + # Deprecation description of the selected element(s). It can be provided if an + # element is marked as `deprecated`. # Corresponds to the JSON property `deprecationDescription` # @return [String] attr_accessor :deprecation_description @@ -1069,13 +938,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 @@ -1088,35 +955,28 @@ module Google end end - # `Endpoint` describes a network endpoint that serves a set of APIs. - # A service may expose any number of endpoints, and all endpoints share the - # same service configuration, such as quota configuration and monitoring - # configuration. - # Example service configuration: - # name: library-example.googleapis.com - # endpoints: - # # Below entry makes 'google.example.library.v1.Library' - # # API be served from endpoint address library-example.googleapis.com. - # # It also allows HTTP OPTIONS calls to be passed to the backend, for - # # it to decide whether the subsequent cross-origin request is - # # allowed to proceed. - # - name: library-example.googleapis.com - # allow_cors: true + # `Endpoint` describes a network endpoint that serves a set of APIs. A service + # may expose any number of endpoints, and all endpoints share the same service + # configuration, such as quota configuration and monitoring configuration. + # Example service configuration: name: library-example.googleapis.com endpoints: + # # Below entry makes 'google.example.library.v1.Library' # API be served from + # endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS + # calls to be passed to the backend, for # it to decide whether the subsequent + # cross-origin request is # allowed to proceed. - name: library-example. + # googleapis.com allow_cors: true class Endpoint include Google::Apis::Core::Hashable # DEPRECATED: This field is no longer supported. Instead of using aliases, - # please specify multiple google.api.Endpoint for each of the intended - # aliases. + # please specify multiple google.api.Endpoint for each of the intended aliases. # Additional names that this endpoint will be hosted on. # Corresponds to the JSON property `aliases` # @return [Array] attr_accessor :aliases - # Allowing - # [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka - # cross-domain traffic, would allow the backends served from this endpoint to - # receive and respond to HTTP OPTIONS requests. The response will be used by + # Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), + # aka cross-domain traffic, would allow the backends served from this endpoint + # to receive and respond to HTTP OPTIONS requests. The response will be used by # the browser to determine whether the subsequent cross-origin request is # allowed to proceed. # Corresponds to the JSON property `allowCors` @@ -1130,10 +990,9 @@ module Google attr_accessor :name # The specification of an Internet routable address of API frontend that will - # handle requests to this [API - # Endpoint](https://cloud.google.com/apis/design/glossary). It should be - # either a valid IPv4 address or a fully-qualified domain name. For example, - # "8.8.8.8" or "myservice.appspot.com". + # handle requests to this [API Endpoint](https://cloud.google.com/apis/design/ + # glossary). It should be either a valid IPv4 address or a fully-qualified + # domain name. For example, "8.8.8.8" or "myservice.appspot.com". # Corresponds to the JSON property `target` # @return [String] attr_accessor :target @@ -1170,8 +1029,8 @@ module Google # @return [Array] attr_accessor :options - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. # Corresponds to the JSON property `sourceContext` # @return [Google::Apis::ServiceconsumermanagementV1::SourceContext] attr_accessor :source_context @@ -1260,8 +1119,8 @@ module Google # @return [Fixnum] attr_accessor :number - # The index of the field type in `Type.oneofs`, for message or enumeration - # types. The first type has index 1; zero means the type is not in the list. + # The index of the field type in `Type.oneofs`, for message or enumeration types. + # The first type has index 1; zero means the type is not in the list. # Corresponds to the JSON property `oneofIndex` # @return [Fixnum] attr_accessor :oneof_index @@ -1277,8 +1136,8 @@ module Google attr_accessor :packed alias_method :packed?, :packed - # The field type URL, without the scheme, for message or enumeration - # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + # The field type URL, without the scheme, for message or enumeration types. + # Example: `"type.googleapis.com/google.protobuf.Timestamp"`. # Corresponds to the JSON property `typeUrl` # @return [String] attr_accessor :type_url @@ -1303,23 +1162,22 @@ module Google end # Defines the HTTP configuration for an API service. It contains a list of - # HttpRule, each specifying the mapping of an RPC method - # to one or more HTTP REST API methods. + # HttpRule, each specifying the mapping of an RPC method to one or more HTTP + # REST API methods. class Http include Google::Apis::Core::Hashable # When set to true, URL path parameters will be fully URI-decoded except in # cases of single segment matches in reserved expansion, where "%2F" will be - # left encoded. - # The default behavior is to not decode RFC 6570 reserved characters in multi - # segment matches. + # left encoded. The default behavior is to not decode RFC 6570 reserved + # characters in multi segment matches. # Corresponds to the JSON property `fullyDecodeReservedExpansion` # @return [Boolean] attr_accessor :fully_decode_reserved_expansion alias_method :fully_decode_reserved_expansion?, :fully_decode_reserved_expansion - # A list of HTTP configuration rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of HTTP configuration rules that apply to individual API methods. ** + # NOTE:** All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -1335,251 +1193,156 @@ module Google end end - # # gRPC Transcoding - # gRPC Transcoding is a feature for mapping between a gRPC method and one or - # more HTTP REST endpoints. It allows developers to build a single API service - # that supports both gRPC APIs and REST APIs. Many systems, including [Google - # APIs](https://github.com/googleapis/googleapis), - # [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC - # Gateway](https://github.com/grpc-ecosystem/grpc-gateway), - # and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature - # and use it for large scale production services. - # `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies - # how different portions of the gRPC request message are mapped to the URL - # path, URL query parameters, and HTTP request body. It also controls how the - # gRPC response message is mapped to the HTTP response body. `HttpRule` is + # # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC + # method and one or more HTTP REST endpoints. It allows developers to build a + # single API service that supports both gRPC APIs and REST APIs. Many systems, + # including [Google APIs](https://github.com/googleapis/googleapis), [Cloud + # Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github. + # com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/ + # envoy) proxy support this feature and use it for large scale production + # services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping + # specifies how different portions of the gRPC request message are mapped to the + # URL path, URL query parameters, and HTTP request body. It also controls how + # the gRPC response message is mapped to the HTTP response body. `HttpRule` is # typically specified as an `google.api.http` annotation on the gRPC method. # Each mapping specifies a URL path template and an HTTP method. The path # template may refer to one or more fields in the gRPC request message, as long - # as each field is a non-repeated field with a primitive (non-message) type. - # The path template controls how fields of the request message are mapped to - # the URL path. - # Example: - # service Messaging ` - # rpc GetMessage(GetMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # get: "/v1/`name=messages/*`" - # `; - # ` - # ` - # message GetMessageRequest ` - # string name = 1; // Mapped to URL path. - # ` - # message Message ` - # string text = 1; // The resource content. - # ` - # This enables an HTTP REST to gRPC mapping as below: - # HTTP | gRPC - # -----|----- - # `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` - # Any fields in the request message which are not bound by the path template - # automatically become HTTP query parameters if there is no HTTP request body. - # For example: - # service Messaging ` - # rpc GetMessage(GetMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # get:"/v1/messages/`message_id`" - # `; - # ` - # ` - # message GetMessageRequest ` - # message SubMessage ` - # string subfield = 1; - # ` - # string message_id = 1; // Mapped to URL path. - # int64 revision = 2; // Mapped to URL query parameter `revision`. - # SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. - # ` - # This enables a HTTP JSON to RPC mapping as below: - # HTTP | gRPC - # -----|----- - # `GET /v1/messages/123456?revision=2&sub.subfield=foo` | - # `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: - # "foo"))` - # Note that fields which are mapped to URL query parameters must have a - # primitive type or a repeated primitive type or a non-repeated message type. - # In the case of a repeated type, the parameter can be repeated in the URL - # as `...?param=A¶m=B`. In the case of a message type, each field of the - # message is mapped to a separate parameter, such as - # `...?foo.a=A&foo.b=B&foo.c=C`. - # For HTTP methods that allow a request body, the `body` field - # specifies the mapping. Consider a REST update method on the - # message resource collection: - # service Messaging ` - # rpc UpdateMessage(UpdateMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # patch: "/v1/messages/`message_id`" - # body: "message" - # `; - # ` - # ` - # message UpdateMessageRequest ` - # string message_id = 1; // mapped to the URL - # Message message = 2; // mapped to the body - # ` - # The following HTTP JSON to RPC mapping is enabled, where the - # representation of the JSON in the request body is determined by - # protos JSON encoding: - # HTTP | gRPC - # -----|----- - # `PATCH /v1/messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: - # "123456" message ` text: "Hi!" `)` - # The special name `*` can be used in the body mapping to define that - # every field not bound by the path template should be mapped to the - # request body. This enables the following alternative definition of - # the update method: - # service Messaging ` - # rpc UpdateMessage(Message) returns (Message) ` - # option (google.api.http) = ` - # patch: "/v1/messages/`message_id`" - # body: "*" - # `; - # ` - # ` - # message Message ` - # string message_id = 1; - # string text = 2; - # ` - # The following HTTP JSON to RPC mapping is enabled: - # HTTP | gRPC - # -----|----- - # `PATCH /v1/messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: - # "123456" text: "Hi!")` - # Note that when using `*` in the body mapping, it is not possible to - # have HTTP parameters, as all fields not bound by the path end in - # the body. This makes this option more rarely used in practice when - # defining REST APIs. The common usage of `*` is in custom methods - # which don't use the URL at all for transferring data. - # It is possible to define multiple HTTP methods for one RPC by using - # the `additional_bindings` option. Example: - # service Messaging ` - # rpc GetMessage(GetMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # get: "/v1/messages/`message_id`" - # additional_bindings ` - # get: "/v1/users/`user_id`/messages/`message_id`" - # ` - # `; - # ` - # ` - # message GetMessageRequest ` - # string message_id = 1; - # string user_id = 2; - # ` - # This enables the following two alternative HTTP JSON to RPC mappings: - # HTTP | gRPC - # -----|----- - # `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` - # `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: - # "123456")` - # ## Rules for HTTP mapping - # 1. Leaf request fields (recursive expansion nested messages in the request - # message) are classified into three categories: - # - Fields referred by the path template. They are passed via the URL path. - # - Fields referred by the HttpRule.body. They are passed via the HTTP - # request body. - # - All other fields are passed via the URL query parameters, and the - # parameter name is the field path in the request message. A repeated - # field can be represented as multiple query parameters under the same - # name. - # 2. If HttpRule.body is "*", there is no URL query parameter, all fields - # are passed via URL path and HTTP request body. - # 3. If HttpRule.body is omitted, there is no HTTP request body, all - # fields are passed via URL path and URL query parameters. - # ### Path template syntax - # Template = "/" Segments [ Verb ] ; - # Segments = Segment ` "/" Segment ` ; - # Segment = "*" | "**" | LITERAL | Variable ; - # Variable = "`" FieldPath [ "=" Segments ] "`" ; - # FieldPath = IDENT ` "." IDENT ` ; - # Verb = ":" LITERAL ; - # The syntax `*` matches a single URL path segment. The syntax `**` matches - # zero or more URL path segments, which must be the last part of the URL path - # except the `Verb`. - # The syntax `Variable` matches part of the URL path as specified by its - # template. A variable template must not contain other variables. If a variable - # matches a single path segment, its template may be omitted, e.g. ``var`` - # is equivalent to ``var=*``. - # The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` - # contains any reserved character, such characters should be percent-encoded - # before the matching. - # If a variable contains exactly one path segment, such as `"`var`"` or - # `"`var=*`"`, when such a variable is expanded into a URL path on the client - # side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The - # server side does the reverse decoding. Such variables show up in the - # [Discovery - # Document](https://developers.google.com/discovery/v1/reference/apis) as - # ``var``. - # If a variable contains multiple path segments, such as `"`var=foo/*`"` - # or `"`var=**`"`, when such a variable is expanded into a URL path on the - # client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. - # The server side does the reverse decoding, except "%2F" and "%2f" are left - # unchanged. Such variables show up in the - # [Discovery - # Document](https://developers.google.com/discovery/v1/reference/apis) as - # ``+var``. - # ## Using gRPC API Service Configuration - # gRPC API Service Configuration (service config) is a configuration language - # for configuring a gRPC service to become a user-facing product. The - # service config is simply the YAML representation of the `google.api.Service` - # proto message. + # as each field is a non-repeated field with a primitive (non-message) type. The + # path template controls how fields of the request message are mapped to the URL + # path. Example: service Messaging ` rpc GetMessage(GetMessageRequest) returns ( + # Message) ` option (google.api.http) = ` get: "/v1/`name=messages/*`" `; ` ` + # message GetMessageRequest ` string name = 1; // Mapped to URL path. ` message + # Message ` string text = 1; // The resource content. ` This enables an HTTP + # REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/ + # 123456` | `GetMessage(name: "messages/123456")` Any fields in the request + # message which are not bound by the path template automatically become HTTP + # query parameters if there is no HTTP request body. For example: service + # Messaging ` rpc GetMessage(GetMessageRequest) returns (Message) ` option ( + # google.api.http) = ` get:"/v1/messages/`message_id`" `; ` ` message + # GetMessageRequest ` message SubMessage ` string subfield = 1; ` string + # message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL + # query parameter `revision`. SubMessage sub = 3; // Mapped to URL query + # parameter `sub.subfield`. ` This enables a HTTP JSON to RPC mapping as below: + # HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | + # `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo")) + # ` Note that fields which are mapped to URL query parameters must have a + # primitive type or a repeated primitive type or a non-repeated message type. In + # the case of a repeated type, the parameter can be repeated in the URL as `...? + # param=A¶m=B`. In the case of a message type, each field of the message is + # mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For + # HTTP methods that allow a request body, the `body` field specifies the mapping. + # Consider a REST update method on the message resource collection: service + # Messaging ` rpc UpdateMessage(UpdateMessageRequest) returns (Message) ` option + # (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "message" `; ` ` + # message UpdateMessageRequest ` string message_id = 1; // mapped to the URL + # Message message = 2; // mapped to the body ` The following HTTP JSON to RPC + # mapping is enabled, where the representation of the JSON in the request body + # is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/ + # messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456" + # message ` text: "Hi!" `)` The special name `*` can be used in the body mapping + # to define that every field not bound by the path template should be mapped to + # the request body. This enables the following alternative definition of the + # update method: service Messaging ` rpc UpdateMessage(Message) returns (Message) + # ` option (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "*" `; + # ` ` message Message ` string message_id = 1; string text = 2; ` The following + # HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/ + # messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456" text: + # "Hi!")` Note that when using `*` in the body mapping, it is not possible to + # have HTTP parameters, as all fields not bound by the path end in the body. + # This makes this option more rarely used in practice when defining REST APIs. + # The common usage of `*` is in custom methods which don't use the URL at all + # for transferring data. It is possible to define multiple HTTP methods for one + # RPC by using the `additional_bindings` option. Example: service Messaging ` + # rpc GetMessage(GetMessageRequest) returns (Message) ` option (google.api.http) + # = ` get: "/v1/messages/`message_id`" additional_bindings ` get: "/v1/users/` + # user_id`/messages/`message_id`" ` `; ` ` message GetMessageRequest ` string + # message_id = 1; string user_id = 2; ` This enables the following two + # alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/ + # messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/ + # messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules + # for HTTP mapping 1. Leaf request fields (recursive expansion nested messages + # in the request message) are classified into three categories: - Fields + # referred by the path template. They are passed via the URL path. - Fields + # referred by the HttpRule.body. They are passed via the HTTP request body. - + # All other fields are passed via the URL query parameters, and the parameter + # name is the field path in the request message. A repeated field can be + # represented as multiple query parameters under the same name. 2. If HttpRule. + # body is "*", there is no URL query parameter, all fields are passed via URL + # path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP + # request body, all fields are passed via URL path and URL query parameters. ### + # Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment ` "/ + # " Segment ` ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "`" + # FieldPath [ "=" Segments ] "`" ; FieldPath = IDENT ` "." IDENT ` ; Verb = ":" + # LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` + # matches zero or more URL path segments, which must be the last part of the URL + # path except the `Verb`. The syntax `Variable` matches part of the URL path as + # specified by its template. A variable template must not contain other + # variables. If a variable matches a single path segment, its template may be + # omitted, e.g. ``var`` is equivalent to ``var=*``. The syntax `LITERAL` matches + # literal text in the URL path. If the `LITERAL` contains any reserved character, + # such characters should be percent-encoded before the matching. If a variable + # contains exactly one path segment, such as `"`var`"` or `"`var=*`"`, when such + # a variable is expanded into a URL path on the client side, all characters + # except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse + # decoding. Such variables show up in the [Discovery Document](https:// + # developers.google.com/discovery/v1/reference/apis) as ``var``. If a variable + # contains multiple path segments, such as `"`var=foo/*`"` or `"`var=**`"`, when + # such a variable is expanded into a URL path on the client side, all characters + # except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the + # reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables + # show up in the [Discovery Document](https://developers.google.com/discovery/v1/ + # reference/apis) as ``+var``. ## Using gRPC API Service Configuration gRPC API + # Service Configuration (service config) is a configuration language for + # configuring a gRPC service to become a user-facing product. The service config + # is simply the YAML representation of the `google.api.Service` proto message. # As an alternative to annotating your proto file, you can configure gRPC - # transcoding in your service config YAML files. You do this by specifying a - # `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same - # effect as the proto annotation. This can be particularly useful if you - # have a proto that is reused in multiple services. Note that any transcoding - # specified in the service config will override any matching transcoding - # configuration in the proto. - # Example: - # http: - # rules: - # # Selects a gRPC method and applies HttpRule to it. - # - selector: example.v1.Messaging.GetMessage - # get: /v1/messages/`message_id`/`sub.subfield` - # ## Special notes - # When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the - # proto to JSON conversion must follow the [proto3 - # specification](https://developers.google.com/protocol-buffers/docs/proto3#json) - # . - # While the single segment variable follows the semantics of - # [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String - # Expansion, the multi segment variable **does not** follow RFC 6570 Section - # 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion - # does not expand special characters like `?` and `#`, which would lead - # to invalid URLs. As the result, gRPC Transcoding uses a custom encoding - # for multi segment variables. - # The path variables **must not** refer to any repeated or mapped field, - # because client libraries are not capable of handling such variable expansion. - # The path variables **must not** capture the leading "/" character. The reason - # is that the most common use case "`var`" does not capture the leading "/" - # character. For consistency, all path variables must share the same behavior. - # Repeated message fields must not be mapped to URL query parameters, because - # no client library can support such complicated mapping. - # If an API needs to use a JSON array for request or response body, it can map - # the request or response body to a repeated field. However, some gRPC - # Transcoding implementations may not support this feature. + # transcoding in your service config YAML files. You do this by specifying a ` + # HttpRule` that maps the gRPC method to a REST endpoint, achieving the same + # effect as the proto annotation. This can be particularly useful if you have a + # proto that is reused in multiple services. Note that any transcoding specified + # in the service config will override any matching transcoding configuration in + # the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule + # to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/` + # message_id`/`sub.subfield` ## Special notes When gRPC Transcoding is used to + # map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow + # the [proto3 specification](https://developers.google.com/protocol-buffers/docs/ + # proto3#json). While the single segment variable follows the semantics of [RFC + # 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String + # Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2. + # 3 Reserved Expansion. The reason is that the Reserved Expansion does not + # expand special characters like `?` and `#`, which would lead to invalid URLs. + # As the result, gRPC Transcoding uses a custom encoding for multi segment + # variables. The path variables **must not** refer to any repeated or mapped + # field, because client libraries are not capable of handling such variable + # expansion. The path variables **must not** capture the leading "/" character. + # The reason is that the most common use case "`var`" does not capture the + # leading "/" character. For consistency, all path variables must share the same + # behavior. Repeated message fields must not be mapped to URL query parameters, + # because no client library can support such complicated mapping. If an API + # needs to use a JSON array for request or response body, it can map the request + # or response body to a repeated field. However, some gRPC Transcoding + # implementations may not support this feature. class HttpRule include Google::Apis::Core::Hashable - # Additional HTTP bindings for the selector. Nested bindings must - # not contain an `additional_bindings` field themselves (that is, - # the nesting may only be one level deep). + # Additional HTTP bindings for the selector. Nested bindings must not contain an + # `additional_bindings` field themselves (that is, the nesting may only be one + # level deep). # Corresponds to the JSON property `additionalBindings` # @return [Array] attr_accessor :additional_bindings - # When this flag is set to true, HTTP requests will be allowed to invoke a - # half-duplex streaming method. + # When this flag is set to true, HTTP requests will be allowed to invoke a half- + # duplex streaming method. # Corresponds to the JSON property `allowHalfDuplex` # @return [Boolean] attr_accessor :allow_half_duplex alias_method :allow_half_duplex?, :allow_half_duplex - # The name of the request field whose value is mapped to the HTTP request - # body, or `*` for mapping all request fields not captured by the path - # pattern to the HTTP body, or omitted for not having any HTTP request body. - # NOTE: the referred field must be present at the top-level of the request - # message type. + # The name of the request field whose value is mapped to the HTTP request body, + # or `*` for mapping all request fields not captured by the path pattern to the + # HTTP body, or omitted for not having any HTTP request body. NOTE: the referred + # field must be present at the top-level of the request message type. # Corresponds to the JSON property `body` # @return [String] attr_accessor :body @@ -1594,8 +1357,7 @@ module Google # @return [String] attr_accessor :delete - # Maps to HTTP GET. Used for listing and getting information about - # resources. + # Maps to HTTP GET. Used for listing and getting information about resources. # Corresponds to the JSON property `get` # @return [String] attr_accessor :get @@ -1616,16 +1378,15 @@ module Google attr_accessor :put # Optional. The name of the response field whose value is mapped to the HTTP - # response body. When omitted, the entire response message will be used - # as the HTTP response body. - # NOTE: The referred field must be present at the top-level of the response - # message type. + # response body. When omitted, the entire response message will be used as the + # HTTP response body. NOTE: The referred field must be present at the top-level + # of the response message type. # Corresponds to the JSON property `responseBody` # @return [String] attr_accessor :response_body - # Selects a method to which this rule applies. - # Refer to selector for syntax details. + # Selects a method to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -1664,13 +1425,12 @@ module Google # @return [String] attr_accessor :query - # The value prefix. The value format is "value_prefix`token`" - # Only applies to "in" header type. Must be empty for "in" query type. - # If not empty, the header value has to match (case sensitive) this prefix. - # If not matched, JWT will not be extracted. If matched, JWT will be - # extracted after the prefix is removed. - # For example, for "Authorization: Bearer `JWT`", - # value_prefix="Bearer " with a space at the end. + # The value prefix. The value format is "value_prefix`token`" Only applies to " + # in" header type. Must be empty for "in" query type. If not empty, the header + # value has to match (case sensitive) this prefix. If not matched, JWT will not + # be extracted. If matched, JWT will be extracted after the prefix is removed. + # For example, for "Authorization: Bearer `JWT`", value_prefix="Bearer " with a + # space at the end. # Corresponds to the JSON property `valuePrefix` # @return [String] attr_accessor :value_prefix @@ -1768,39 +1528,35 @@ module Google end end - # A description of a log type. Example in YAML format: - # - name: library.googleapis.com/activity_history - # description: The history of borrowing and returning library items. - # display_name: Activity - # labels: - # - key: /customer_id + # A description of a log type. Example in YAML format: - name: library. + # googleapis.com/activity_history description: The history of borrowing and + # returning library items. display_name: Activity labels: - key: /customer_id # description: Identifier of a library customer class LogDescriptor include Google::Apis::Core::Hashable - # A human-readable description of this log. This information appears in - # the documentation and can contain details. + # A human-readable description of this log. This information appears in the + # documentation and can contain details. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # The human-readable name for this log. This information appears on - # the user interface and should be concise. + # The human-readable name for this log. This information appears on the user + # interface and should be concise. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # The set of labels that are available to describe a specific log entry. - # Runtime requests that contain labels not specified here are - # considered invalid. + # The set of labels that are available to describe a specific log entry. Runtime + # requests that contain labels not specified here are considered invalid. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels - # The name of the log. It must be less than 512 characters long and can - # include the following characters: upper- and lower-case alphanumeric - # characters [A-Za-z0-9], and punctuation characters including - # slash, underscore, hyphen, period [/_-.]. + # The name of the log. It must be less than 512 characters long and can include + # the following characters: upper- and lower-case alphanumeric characters [A-Za- + # z0-9], and punctuation characters including slash, underscore, hyphen, period [ + # /_-.]. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1818,48 +1574,30 @@ module Google end end - # Logging configuration of the service. - # The following example shows how to configure logs to be sent to the - # producer and consumer projects. In the example, the `activity_history` - # log is sent to both the producer and consumer projects, whereas the - # `purchase_history` log is only sent to the producer project. - # monitored_resources: - # - type: library.googleapis.com/branch - # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. - # logs: - # - name: activity_history - # labels: - # - key: /customer_id - # - name: purchase_history - # logging: - # producer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history - # - purchase_history - # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history + # Logging configuration of the service. The following example shows how to + # configure logs to be sent to the producer and consumer projects. In the + # example, the `activity_history` log is sent to both the producer and consumer + # projects, whereas the `purchase_history` log is only sent to the producer + # project. monitored_resources: - type: library.googleapis.com/branch labels: - + # key: /city description: The city where the library branch is located in. - key: + # /name description: The name of the branch. logs: - name: activity_history + # labels: - key: /customer_id - name: purchase_history logging: + # producer_destinations: - monitored_resource: library.googleapis.com/branch + # logs: - activity_history - purchase_history consumer_destinations: - + # monitored_resource: library.googleapis.com/branch logs: - activity_history class Logging include Google::Apis::Core::Hashable - # Logging configurations for sending logs to the consumer project. - # There can be multiple consumer destinations, each one must have a - # different monitored resource type. A log can be used in at most - # one consumer destination. + # Logging configurations for sending logs to the consumer project. There can be + # multiple consumer destinations, each one must have a different monitored + # resource type. A log can be used in at most one consumer destination. # Corresponds to the JSON property `consumerDestinations` # @return [Array] attr_accessor :consumer_destinations - # Logging configurations for sending logs to the producer project. - # There can be multiple producer destinations, each one must have a - # different monitored resource type. A log can be used in at most - # one producer destination. + # Logging configurations for sending logs to the producer project. There can be + # multiple producer destinations, each one must have a different monitored + # resource type. A log can be used in at most one producer destination. # Corresponds to the JSON property `producerDestinations` # @return [Array] attr_accessor :producer_destinations @@ -1875,21 +1613,20 @@ module Google end end - # Configuration of a specific logging destination (the producer project - # or the consumer project). + # Configuration of a specific logging destination (the producer project or the + # consumer project). class LoggingDestination include Google::Apis::Core::Hashable - # Names of the logs to be sent to this destination. Each name must - # be defined in the Service.logs section. If the log name is - # not a domain scoped name, it will be automatically prefixed with - # the service name followed by "/". + # Names of the logs to be sent to this destination. Each name must be defined in + # the Service.logs section. If the log name is not a domain scoped name, it will + # be automatically prefixed with the service name followed by "/". # Corresponds to the JSON property `logs` # @return [Array] attr_accessor :logs - # The monitored resource type. The type must be defined in the - # Service.monitored_resources section. + # The monitored resource type. The type must be defined in the Service. + # monitored_resources section. # Corresponds to the JSON property `monitoredResource` # @return [String] attr_accessor :monitored_resource @@ -1964,16 +1701,13 @@ module Google # Defines a metric type and its schema. Once a metric descriptor is created, # deleting or altering it stops data collection and makes the metric type's - # existing data unusable. - # The following are specific rules for service defined Monitoring metric - # descriptors: - # * `type`, `metric_kind`, `value_type` and `description` - # fields are all required. The `unit` field must be specified - # if the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. - # * Maximum of default 500 metric descriptors per service is allowed. - # * Maximum of default 10 labels per metric descriptor is allowed. - # The default maximum limit can be overridden. Please follow - # https://cloud.google.com/monitoring/quotas + # existing data unusable. The following are specific rules for service defined + # Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and ` + # description` fields are all required. The `unit` field must be specified if + # the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default + # 500 metric descriptors per service is allowed. * Maximum of default 10 labels + # per metric descriptor is allowed. The default maximum limit can be overridden. + # Please follow https://cloud.google.com/monitoring/quotas class MetricDescriptor include Google::Apis::Core::Hashable @@ -1982,26 +1716,21 @@ module Google # @return [String] attr_accessor :description - # A concise name for the metric, which can be displayed in user interfaces. - # Use sentence case without an ending period, for example "Request count". - # This field is optional but it is recommended to be set for any metrics - # associated with user-visible concepts, such as Quota. + # A concise name for the metric, which can be displayed in user interfaces. Use + # sentence case without an ending period, for example "Request count". This + # field is optional but it is recommended to be set for any metrics associated + # with user-visible concepts, such as Quota. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # The set of labels that can be used to describe a specific - # instance of this metric type. - # The label key name must follow: - # * Only upper and lower-case letters, digits and underscores (_) are - # allowed. - # * Label name must start with a letter or digit. - # * The maximum length of a label name is 100 characters. - # For example, the - # `appengine.googleapis.com/http/server/response_latencies` metric - # type has a label for the HTTP response code, `response_code`, so - # you can look at latencies for successful responses or just - # for responses that failed. + # The set of labels that can be used to describe a specific instance of this + # metric type. The label key name must follow: * Only upper and lower-case + # letters, digits and underscores (_) are allowed. * Label name must start with + # a letter or digit. * The maximum length of a label name is 100 characters. For + # example, the `appengine.googleapis.com/http/server/response_latencies` metric + # type has a label for the HTTP response code, `response_code`, so you can look + # at latencies for successful responses or just for responses that failed. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels @@ -2016,17 +1745,16 @@ module Google # @return [Google::Apis::ServiceconsumermanagementV1::MetricDescriptorMetadata] attr_accessor :metadata - # Whether the metric records instantaneous values, changes to a value, etc. - # Some combinations of `metric_kind` and `value_type` might not be supported. + # Whether the metric records instantaneous values, changes to a value, etc. Some + # combinations of `metric_kind` and `value_type` might not be supported. # Corresponds to the JSON property `metricKind` # @return [String] attr_accessor :metric_kind - # Read-only. If present, then a time - # series, which is identified partially by - # a metric type and a MonitoredResourceDescriptor, that is associated - # with this metric type can only be associated with one of the monitored - # resource types listed here. + # Read-only. If present, then a time series, which is identified partially by a + # metric type and a MonitoredResourceDescriptor, that is associated with this + # metric type can only be associated with one of the monitored resource types + # listed here. # Corresponds to the JSON property `monitoredResourceTypes` # @return [Array] attr_accessor :monitored_resource_types @@ -2036,116 +1764,73 @@ module Google # @return [String] attr_accessor :name - # The metric type, including its DNS name prefix. The type is not - # URL-encoded. + # The metric type, including its DNS name prefix. The type is not URL-encoded. # All service defined metrics must be prefixed with the service name, in the - # format of ``service name`/`relative metric name``, such as - # `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric - # name must follow: + # format of ``service name`/`relative metric name``, such as `cloudsql. + # googleapis.com/database/cpu/utilization`. The relative metric name must follow: # * Only upper and lower-case letters, digits, '/' and underscores '_' are - # allowed. - # * The maximum number of characters allowed for the relative_metric_name is - # 100. - # All user-defined metric types have the DNS name - # `custom.googleapis.com`, `external.googleapis.com`, or - # `logging.googleapis.com/user/`. - # Metric types should use a natural hierarchical grouping. For example: - # "custom.googleapis.com/invoice/paid/amount" - # "external.googleapis.com/prometheus/up" - # "appengine.googleapis.com/http/server/response_latencies" + # allowed. * The maximum number of characters allowed for the + # relative_metric_name is 100. All user-defined metric types have the DNS name ` + # custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/ + # user/`. Metric types should use a natural hierarchical grouping. For example: " + # custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/ + # up" "appengine.googleapis.com/http/server/response_latencies" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # The units in which the metric value is reported. It is only applicable - # if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` - # defines the representation of the stored metric values. - # Different systems may scale the values to be more easily displayed (so a - # value of `0.02KBy` _might_ be displayed as `20By`, and a value of - # `3523KBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is - # `KBy`, then the value of the metric is always in thousands of bytes, no - # matter how it may be displayed.. - # If you want a custom metric to record the exact number of CPU-seconds used - # by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is - # `s`CPU`` (or equivalently `1s`CPU`` or just `s`). If the job uses 12,005 - # CPU-seconds, then the value is written as `12005`. - # Alternatively, if you want a custom metric to record data in a more - # granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is - # `ks`CPU``, and then write the value `12.005` (which is `12005/1000`), - # or use `Kis`CPU`` and write `11.723` (which is `12005/1024`). - # The supported units are a subset of [The Unified Code for Units of - # Measure](http://unitsofmeasure.org/ucum.html) standard: - # **Basic units (UNIT)** - # * `bit` bit - # * `By` byte - # * `s` second - # * `min` minute - # * `h` hour - # * `d` day - # * `1` dimensionless - # **Prefixes (PREFIX)** - # * `k` kilo (10^3) - # * `M` mega (10^6) - # * `G` giga (10^9) - # * `T` tera (10^12) - # * `P` peta (10^15) - # * `E` exa (10^18) - # * `Z` zetta (10^21) - # * `Y` yotta (10^24) - # * `m` milli (10^-3) - # * `u` micro (10^-6) - # * `n` nano (10^-9) - # * `p` pico (10^-12) - # * `f` femto (10^-15) - # * `a` atto (10^-18) - # * `z` zepto (10^-21) - # * `y` yocto (10^-24) - # * `Ki` kibi (2^10) - # * `Mi` mebi (2^20) - # * `Gi` gibi (2^30) - # * `Ti` tebi (2^40) - # * `Pi` pebi (2^50) - # **Grammar** - # The grammar also includes these connectors: - # * `/` division or ratio (as an infix operator). For examples, - # `kBy/`email`` or `MiBy/10ms` (although you should almost never - # have `/s` in a metric `unit`; rates should always be computed at - # query time from the underlying cumulative or delta value). - # * `.` multiplication or composition (as an infix operator). For - # examples, `GBy.d` or `k`watt`.h`. - # The grammar for a unit is as follows: - # Expression = Component ` "." Component ` ` "/" Component ` ; - # Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] - # | Annotation - # | "1" - # ; - # Annotation = "`" NAME "`" ; - # Notes: - # * `Annotation` is just a comment if it follows a `UNIT`. If the annotation - # is used alone, then the unit is equivalent to `1`. For examples, - # ``request`/s == 1/s`, `By`transmitted`/s == By/s`. - # * `NAME` is a sequence of non-blank printable ASCII characters not - # containing ``` or ```. - # * `1` represents a unitary [dimensionless - # unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such - # as in `1/s`. It is typically used when none of the basic units are - # appropriate. For example, "new users per day" can be represented as - # `1/d` or ``new-users`/d` (and a metric value `5` would mean "5 new - # users). Alternatively, "thousands of page views per day" would be - # represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric - # value of `5.3` would mean "5300 page views per day"). - # * `%` represents dimensionless value of 1/100, and annotates values giving - # a percentage (so the metric values are typically in the range of 0..100, - # and a metric value `3` means "3 percent"). - # * `10^2.%` indicates a metric contains a ratio, typically in the range - # 0..1, that will be multiplied by 100 and displayed as a percentage - # (so a metric value `0.03` means "3 percent"). + # The units in which the metric value is reported. It is only applicable if the ` + # value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the + # representation of the stored metric values. Different systems may scale the + # values to be more easily displayed (so a value of `0.02KBy` _might_ be + # displayed as `20By`, and a value of `3523KBy` _might_ be displayed as `3.5MBy`) + # . However, if the `unit` is `KBy`, then the value of the metric is always in + # thousands of bytes, no matter how it may be displayed.. If you want a custom + # metric to record the exact number of CPU-seconds used by a job, you can create + # an `INT64 CUMULATIVE` metric whose `unit` is `s`CPU`` (or equivalently `1s`CPU` + # ` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written + # as `12005`. Alternatively, if you want a custom metric to record data in a + # more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is + # `ks`CPU``, and then write the value `12.005` (which is `12005/1000`), or use ` + # Kis`CPU`` and write `11.723` (which is `12005/1024`). The supported units are + # a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ + # ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` + # second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes ( + # PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^ + # 12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^ + # 24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^- + # 12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto ( + # 10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi ( + # 2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these + # connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/ + # `email`` or `MiBy/10ms` (although you should almost never have `/s` in a + # metric `unit`; rates should always be computed at query time from the + # underlying cumulative or delta value). * `.` multiplication or composition (as + # an infix operator). For examples, `GBy.d` or `k`watt`.h`. The grammar for a + # unit is as follows: Expression = Component ` "." Component ` ` "/" Component ` + # ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; + # Annotation = "`" NAME "`" ; Notes: * `Annotation` is just a comment if it + # follows a `UNIT`. If the annotation is used alone, then the unit is equivalent + # to `1`. For examples, ``request`/s == 1/s`, `By`transmitted`/s == By/s`. * ` + # NAME` is a sequence of non-blank printable ASCII characters not containing ``` + # or ```. * `1` represents a unitary [dimensionless unit](https://en.wikipedia. + # org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used + # when none of the basic units are appropriate. For example, "new users per day" + # can be represented as `1/d` or ``new-users`/d` (and a metric value `5` would + # mean "5 new users). Alternatively, "thousands of page views per day" would be + # represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric value of ` + # 5.3` would mean "5300 page views per day"). * `%` represents dimensionless + # value of 1/100, and annotates values giving a percentage (so the metric values + # are typically in the range of 0..100, and a metric value `3` means "3 percent") + # . * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, + # that will be multiplied by 100 and displayed as a percentage (so a metric + # value `0.03` means "3 percent"). # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit - # Whether the measurement is an integer, a floating-point number, etc. - # Some combinations of `metric_kind` and `value_type` might not be supported. + # Whether the measurement is an integer, a floating-point number, etc. Some + # combinations of `metric_kind` and `value_type` might not be supported. # Corresponds to the JSON property `valueType` # @return [String] attr_accessor :value_type @@ -2174,9 +1859,9 @@ module Google class MetricDescriptorMetadata include Google::Apis::Core::Hashable - # The delay of data points caused by ingestion. Data points older than this - # age are guaranteed to be ingested and available to be read, excluding - # data loss due to errors. + # The delay of data points caused by ingestion. Data points older than this age + # are guaranteed to be ingested and available to be read, excluding data loss + # due to errors. # Corresponds to the JSON property `ingestDelay` # @return [String] attr_accessor :ingest_delay @@ -2188,8 +1873,8 @@ module Google # The sampling period of metric data points. For metrics which are written # periodically, consecutive data points are stored at this time interval, - # excluding data loss due to errors. Metrics with a higher granularity have - # a smaller sampling period. + # excluding data loss due to errors. Metrics with a higher granularity have a + # smaller sampling period. # Corresponds to the JSON property `samplePeriod` # @return [String] attr_accessor :sample_period @@ -2206,22 +1891,21 @@ module Google end end - # Bind API methods to metrics. Binding a method to a metric causes that - # metric's configured quota behaviors to apply to the method call. + # Bind API methods to metrics. Binding a method to a metric causes that metric's + # configured quota behaviors to apply to the method call. class MetricRule include Google::Apis::Core::Hashable # Metrics to update when the selected methods are called, and the associated - # cost applied to each metric. - # The key of the map is the metric name, and the values are the amount - # increased for the metric against which the quota limits are defined. - # The value must not be negative. + # cost applied to each metric. The key of the map is the metric name, and the + # values are the amount increased for the metric against which the quota limits + # are defined. The value must not be negative. # Corresponds to the JSON property `metricCosts` # @return [Hash] attr_accessor :metric_costs - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -2239,66 +1923,33 @@ module Google # Declares an API Interface to be included in this interface. The including # interface must redeclare all the methods from the included interface, but - # documentation and options are inherited as follows: - # - If after comment and whitespace stripping, the documentation - # string of the redeclared method is empty, it will be inherited - # from the original method. - # - Each annotation belonging to the service config (http, - # visibility) which is not set in the redeclared method will be - # inherited. - # - If an http annotation is inherited, the path pattern will be - # modified as follows. Any version prefix will be replaced by the - # version of the including interface plus the root path if - # specified. - # Example of a simple mixin: - # package google.acl.v1; - # service AccessControl ` - # // Get the underlying ACL object. - # rpc GetAcl(GetAclRequest) returns (Acl) ` - # option (google.api.http).get = "/v1/`resource=**`:getAcl"; - # ` - # ` - # package google.storage.v2; - # service Storage ` - # // rpc GetAcl(GetAclRequest) returns (Acl); - # // Get a data record. - # rpc GetData(GetDataRequest) returns (Data) ` - # option (google.api.http).get = "/v2/`resource=**`"; - # ` - # ` - # Example of a mixin configuration: - # apis: - # - name: google.storage.v2.Storage - # mixins: - # - name: google.acl.v1.AccessControl - # The mixin construct implies that all methods in `AccessControl` are - # also declared with same name and request/response types in - # `Storage`. A documentation generator or annotation processor will - # see the effective `Storage.GetAcl` method after inherting - # documentation and annotations as follows: - # service Storage ` - # // Get the underlying ACL object. - # rpc GetAcl(GetAclRequest) returns (Acl) ` - # option (google.api.http).get = "/v2/`resource=**`:getAcl"; - # ` - # ... - # ` - # Note how the version in the path pattern changed from `v1` to `v2`. - # If the `root` field in the mixin is specified, it should be a - # relative path under which inherited HTTP paths are placed. Example: - # apis: - # - name: google.storage.v2.Storage - # mixins: - # - name: google.acl.v1.AccessControl - # root: acls - # This implies the following inherited HTTP annotation: - # service Storage ` - # // Get the underlying ACL object. - # rpc GetAcl(GetAclRequest) returns (Acl) ` - # option (google.api.http).get = "/v2/acls/`resource=**`:getAcl"; - # ` - # ... - # ` + # documentation and options are inherited as follows: - If after comment and + # whitespace stripping, the documentation string of the redeclared method is + # empty, it will be inherited from the original method. - Each annotation + # belonging to the service config (http, visibility) which is not set in the + # redeclared method will be inherited. - If an http annotation is inherited, the + # path pattern will be modified as follows. Any version prefix will be replaced + # by the version of the including interface plus the root path if specified. + # Example of a simple mixin: package google.acl.v1; service AccessControl ` // + # Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) ` + # option (google.api.http).get = "/v1/`resource=**`:getAcl"; ` ` package google. + # storage.v2; service Storage ` // rpc GetAcl(GetAclRequest) returns (Acl); // + # Get a data record. rpc GetData(GetDataRequest) returns (Data) ` option (google. + # api.http).get = "/v2/`resource=**`"; ` ` Example of a mixin configuration: + # apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1. + # AccessControl The mixin construct implies that all methods in `AccessControl` + # are also declared with same name and request/response types in `Storage`. A + # documentation generator or annotation processor will see the effective ` + # Storage.GetAcl` method after inherting documentation and annotations as + # follows: service Storage ` // Get the underlying ACL object. rpc GetAcl( + # GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=** + # `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1` + # to `v2`. If the `root` field in the mixin is specified, it should be a + # relative path under which inherited HTTP paths are placed. Example: apis: - + # name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl + # root: acls This implies the following inherited HTTP annotation: service + # Storage ` // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns ( + # Acl) ` option (google.api.http).get = "/v2/acls/`resource=**`:getAcl"; ` ... ` class Mixin include Google::Apis::Core::Hashable @@ -2307,8 +1958,7 @@ module Google # @return [String] attr_accessor :name - # If non-empty specifies a path under which inherited HTTP paths - # are rooted. + # If non-empty specifies a path under which inherited HTTP paths are rooted. # Corresponds to the JSON property `root` # @return [String] attr_accessor :root @@ -2324,51 +1974,42 @@ module Google end end - # An object that describes the schema of a MonitoredResource object using a - # type name and a set of labels. For example, the monitored resource - # descriptor for Google Compute Engine VM instances has a type of - # `"gce_instance"` and specifies the use of the labels `"instance_id"` and - # `"zone"` to identify particular VM instances. - # Different services can support different monitored resource types. - # The following are specific rules to service defined monitored resources for - # Monitoring and Logging: - # * The `type`, `display_name`, `description`, `labels` and `launch_stage` - # fields are all required. - # * The first label of the monitored resource descriptor must be - # `resource_container`. There are legacy monitored resource descritptors - # start with `project_id`. - # * It must include a `location` label. - # * Maximum of default 5 service defined monitored resource descriptors - # is allowed per service. - # * Maximum of default 10 labels per monitored resource is allowed. - # The default maximum limit can be overridden. Please follow - # https://cloud.google.com/monitoring/quotas + # An object that describes the schema of a MonitoredResource object using a type + # name and a set of labels. For example, the monitored resource descriptor for + # Google Compute Engine VM instances has a type of `"gce_instance"` and + # specifies the use of the labels `"instance_id"` and `"zone"` to identify + # particular VM instances. Different services can support different monitored + # resource types. The following are specific rules to service defined monitored + # resources for Monitoring and Logging: * The `type`, `display_name`, ` + # description`, `labels` and `launch_stage` fields are all required. * The first + # label of the monitored resource descriptor must be `resource_container`. There + # are legacy monitored resource descritptors start with `project_id`. * It must + # include a `location` label. * Maximum of default 5 service defined monitored + # resource descriptors is allowed per service. * Maximum of default 10 labels + # per monitored resource is allowed. The default maximum limit can be overridden. + # Please follow https://cloud.google.com/monitoring/quotas class MonitoredResourceDescriptor include Google::Apis::Core::Hashable - # Optional. A detailed description of the monitored resource type that might - # be used in documentation. + # Optional. A detailed description of the monitored resource type that might be + # used in documentation. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Optional. A concise name for the monitored resource type that might be - # displayed in user interfaces. It should be a Title Cased Noun Phrase, - # without any article or other determiners. For example, - # `"Google Cloud SQL Database"`. + # displayed in user interfaces. It should be a Title Cased Noun Phrase, without + # any article or other determiners. For example, `"Google Cloud SQL Database"`. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Required. A set of labels used to describe instances of this monitored - # resource type. - # The label key name must follow: - # * Only upper and lower-case letters, digits and underscores (_) are - # allowed. - # * Label name must start with a letter or digit. - # * The maximum length of a label name is 100 characters. - # For example, an individual Google Cloud SQL database is - # identified by values for the labels `database_id` and `location`. + # resource type. The label key name must follow: * Only upper and lower-case + # letters, digits and underscores (_) are allowed. * Label name must start with + # a letter or digit. * The maximum length of a label name is 100 characters. For + # example, an individual Google Cloud SQL database is identified by values for + # the labels `database_id` and `location`. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels @@ -2378,27 +2019,25 @@ module Google # @return [String] attr_accessor :launch_stage - # Optional. The resource name of the monitored resource descriptor: - # `"projects/`project_id`/monitoredResourceDescriptors/`type`"` where - # `type` is the value of the `type` field in this object and - # `project_id` is a project ID that provides API-specific context for - # accessing the type. APIs that do not use project information can use the - # resource name format `"monitoredResourceDescriptors/`type`"`. + # Optional. The resource name of the monitored resource descriptor: `"projects/` + # project_id`/monitoredResourceDescriptors/`type`"` where `type` is the value of + # the `type` field in this object and `project_id` is a project ID that provides + # API-specific context for accessing the type. APIs that do not use project + # information can use the resource name format `"monitoredResourceDescriptors/` + # type`"`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The monitored resource type. For example, the type - # `cloudsql_database` represents databases in Google Cloud SQL. - # All service defined monitored resource types must be prefixed with the - # service name, in the format of ``service name`/`relative resource name``. - # The relative resource name must follow: - # * Only upper and lower-case letters and digits are allowed. - # * It must start with upper case character and is recommended to use Upper - # Camel Case style. - # * The maximum number of characters allowed for the relative_resource_name - # is 100. - # Note there are legacy service monitored resources not following this rule. + # Required. The monitored resource type. For example, the type ` + # cloudsql_database` represents databases in Google Cloud SQL. All service + # defined monitored resource types must be prefixed with the service name, in + # the format of ``service name`/`relative resource name``. The relative resource + # name must follow: * Only upper and lower-case letters and digits are allowed. * + # It must start with upper case character and is recommended to use Upper Camel + # Case style. * The maximum number of characters allowed for the + # relative_resource_name is 100. Note there are legacy service monitored + # resources not following this rule. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -2418,75 +2057,47 @@ module Google end end - # Monitoring configuration of the service. - # The example below shows how to configure monitored resources and metrics - # for monitoring. In the example, a monitored resource and two metrics are - # defined. The `library.googleapis.com/book/returned_count` metric is sent - # to both producer and consumer projects, whereas the - # `library.googleapis.com/book/num_overdue` metric is only sent to the - # consumer project. - # monitored_resources: - # - type: library.googleapis.com/Branch - # display_name: "Library Branch" - # description: "A branch of a library." - # launch_stage: GA - # labels: - # - key: resource_container - # description: "The Cloud container (ie. project id) for the Branch." - # - key: location - # description: "The location of the library branch." - # - key: branch_id - # description: "The id of the branch." - # metrics: - # - name: library.googleapis.com/book/returned_count - # display_name: "Books Returned" - # description: "The count of books that have been returned." - # launch_stage: GA - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # - name: library.googleapis.com/book/num_overdue - # display_name: "Books Overdue" - # description: "The current number of overdue books." - # launch_stage: GA - # metric_kind: GAUGE - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # monitoring: - # producer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # consumer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # - library.googleapis.com/book/num_overdue + # Monitoring configuration of the service. The example below shows how to + # configure monitored resources and metrics for monitoring. In the example, a + # monitored resource and two metrics are defined. The `library.googleapis.com/ + # book/returned_count` metric is sent to both producer and consumer projects, + # whereas the `library.googleapis.com/book/num_overdue` metric is only sent to + # the consumer project. monitored_resources: - type: library.googleapis.com/ + # Branch display_name: "Library Branch" description: "A branch of a library." + # launch_stage: GA labels: - key: resource_container description: "The Cloud + # container (ie. project id) for the Branch." - key: location description: "The + # location of the library branch." - key: branch_id description: "The id of the + # branch." metrics: - name: library.googleapis.com/book/returned_count + # display_name: "Books Returned" description: "The count of books that have been + # returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" + # labels: - key: customer_id description: "The id of the customer." - name: + # library.googleapis.com/book/num_overdue display_name: "Books Overdue" + # description: "The current number of overdue books." launch_stage: GA + # metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id + # description: "The id of the customer." monitoring: producer_destinations: - + # monitored_resource: library.googleapis.com/Branch metrics: - library. + # googleapis.com/book/returned_count consumer_destinations: - monitored_resource: + # library.googleapis.com/Branch metrics: - library.googleapis.com/book/ + # returned_count - library.googleapis.com/book/num_overdue class Monitoring include Google::Apis::Core::Hashable - # Monitoring configurations for sending metrics to the consumer project. - # There can be multiple consumer destinations. A monitored resource type may - # appear in multiple monitoring destinations if different aggregations are - # needed for different sets of metrics associated with that monitored - # resource type. A monitored resource and metric pair may only be used once - # in the Monitoring configuration. + # Monitoring configurations for sending metrics to the consumer project. There + # can be multiple consumer destinations. A monitored resource type may appear in + # multiple monitoring destinations if different aggregations are needed for + # different sets of metrics associated with that monitored resource type. A + # monitored resource and metric pair may only be used once in the Monitoring + # configuration. # Corresponds to the JSON property `consumerDestinations` # @return [Array] attr_accessor :consumer_destinations - # Monitoring configurations for sending metrics to the producer project. - # There can be multiple producer destinations. A monitored resource type may - # appear in multiple monitoring destinations if different aggregations are - # needed for different sets of metrics associated with that monitored - # resource type. A monitored resource and metric pair may only be used once - # in the Monitoring configuration. + # Monitoring configurations for sending metrics to the producer project. There + # can be multiple producer destinations. A monitored resource type may appear in + # multiple monitoring destinations if different aggregations are needed for + # different sets of metrics associated with that monitored resource type. A + # monitored resource and metric pair may only be used once in the Monitoring + # configuration. # Corresponds to the JSON property `producerDestinations` # @return [Array] attr_accessor :producer_destinations @@ -2502,19 +2113,19 @@ module Google end end - # Configuration of a specific monitoring destination (the producer project - # or the consumer project). + # Configuration of a specific monitoring destination (the producer project or + # the consumer project). class MonitoringDestination include Google::Apis::Core::Hashable - # Types of the metrics to report to this monitoring destination. - # Each type must be defined in Service.metrics section. + # Types of the metrics to report to this monitoring destination. Each type must + # be defined in Service.metrics section. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics - # The monitored resource type. The type must be defined in - # Service.monitored_resources section. + # The monitored resource type. The type must be defined in Service. + # monitored_resources section. # Corresponds to the JSON property `monitoredResource` # @return [String] attr_accessor :monitored_resource @@ -2531,27 +2142,25 @@ module Google end # OAuth scopes are a way to define data and permissions on data. For example, - # there are scopes defined for "Read-only access to Google Calendar" and - # "Access to Cloud Platform". Users can consent to a scope for an application, - # giving it permission to access that data on their behalf. - # OAuth scope specifications should be fairly coarse grained; a user will need - # to see and understand the text description of what your scope means. - # In most cases: use one or at most two OAuth scopes for an entire family of - # products. If your product has multiple APIs, you should probably be sharing - # the OAuth scope across all of those APIs. - # When you need finer grained OAuth consent screens: talk with your product - # management about how developers will use them in practice. - # Please note that even though each of the canonical scopes is enough for a - # request to be accepted and passed to the backend, a request can still fail - # due to the backend requiring additional scopes or permissions. + # there are scopes defined for "Read-only access to Google Calendar" and "Access + # to Cloud Platform". Users can consent to a scope for an application, giving it + # permission to access that data on their behalf. OAuth scope specifications + # should be fairly coarse grained; a user will need to see and understand the + # text description of what your scope means. In most cases: use one or at most + # two OAuth scopes for an entire family of products. If your product has + # multiple APIs, you should probably be sharing the OAuth scope across all of + # those APIs. When you need finer grained OAuth consent screens: talk with your + # product management about how developers will use them in practice. Please note + # that even though each of the canonical scopes is enough for a request to be + # accepted and passed to the backend, a request can still fail due to the + # backend requiring additional scopes or permissions. class OAuthRequirements include Google::Apis::Core::Hashable - # The list of publicly documented OAuth scopes that are allowed access. An - # OAuth token containing any of these scopes will be accepted. - # Example: - # canonical_scopes: https://www.googleapis.com/auth/calendar, - # https://www.googleapis.com/auth/calendar.read + # The list of publicly documented OAuth scopes that are allowed access. An OAuth + # token containing any of these scopes will be accepted. Example: + # canonical_scopes: https://www.googleapis.com/auth/calendar, https://www. + # googleapis.com/auth/calendar.read # Corresponds to the JSON property `canonicalScopes` # @return [String] attr_accessor :canonical_scopes @@ -2571,47 +2180,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::ServiceconsumermanagementV1::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 @@ -2636,17 +2243,17 @@ module Google include Google::Apis::Core::Hashable # The option's name. For protobuf built-in options (options defined in - # descriptor.proto), this is the short name. For example, `"map_entry"`. - # For custom options, it should be the fully-qualified name. For example, - # `"google.api.http"`. + # descriptor.proto), this is the short name. For example, `"map_entry"`. For + # custom options, it should be the fully-qualified name. For example, `"google. + # api.http"`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The option's value packed in an Any message. If the value is a primitive, - # the corresponding wrapper type defined in google/protobuf/wrappers.proto - # should be used. If the value is an enum, it should be stored as an int32 - # value using the google.protobuf.Int32Value type. + # The option's value packed in an Any message. If the value is a primitive, the + # corresponding wrapper type defined in google/protobuf/wrappers.proto should be + # used. If the value is an enum, it should be stored as an int32 value using the + # google.protobuf.Int32Value type. # Corresponds to the JSON property `value` # @return [Hash] attr_accessor :value @@ -2667,32 +2274,25 @@ module Google class Page include Google::Apis::Core::Hashable - # The Markdown content of the page. You can use (== include `path` - # ==) to include content from a Markdown file. + # The Markdown content of the page. You can use (== include `path` ==) to + # include content from a Markdown file. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content - # The name of the page. It will be used as an identity of the page to - # generate URI of the page, text of the link to this page in navigation, - # etc. The full page name (start from the root page name to this page - # concatenated with `.`) can be used as reference to the page in your - # documentation. For example: - # 
pages:
-        # - name: Tutorial
-        # content: (== include tutorial.md ==)
-        # subpages:
-        # - name: Java
-        # content: (== include tutorial_java.md ==)
-        #
- # You can reference `Java` page using Markdown reference link syntax: - # `Java`. + # The name of the page. It will be used as an identity of the page to generate + # URI of the page, text of the link to this page in navigation, etc. The full + # page name (start from the root page name to this page concatenated with `.`) + # can be used as reference to the page in your documentation. For example: pages: + # - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java + # content: (== include tutorial_java.md ==) You can reference `Java` page using + # Markdown reference link syntax: `Java`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Subpages of this page. The order of subpages specified here will be - # honored in the generated docset. + # Subpages of this page. The order of subpages specified here will be honored in + # the generated docset. # Corresponds to the JSON property `subpages` # @return [Array] attr_accessor :subpages @@ -2713,15 +2313,15 @@ module Google class PolicyBinding include Google::Apis::Core::Hashable - # Uses the same format as in IAM policy. - # `member` must include both a prefix and ID. For example, `user:`emailId``, - # `serviceAccount:`emailId``, `group:`emailId``. + # Uses the same format as in IAM policy. `member` must include both a prefix and + # ID. For example, `user:`emailId``, `serviceAccount:`emailId``, `group:`emailId` + # `. # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members - # Role. (https://cloud.google.com/iam/docs/understanding-roles) - # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + # Role. (https://cloud.google.com/iam/docs/understanding-roles) For example, ` + # roles/viewer`, `roles/editor`, or `roles/owner`. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role @@ -2737,46 +2337,25 @@ module Google end end - # Quota configuration helps to achieve fairness and budgeting in service - # usage. - # The metric based quota configuration works this way: - # - The service configuration defines a set of metrics. - # - For API calls, the quota.metric_rules maps methods to metrics with - # corresponding costs. - # - The quota.limits defines limits on the metrics, which will be used for - # quota checks at runtime. - # An example quota configuration in yaml format: - # quota: - # limits: - # - name: apiWriteQpsPerProject - # metric: library.googleapis.com/write_calls - # unit: "1/min/`project`" # rate limit for consumer projects - # values: - # STANDARD: 10000 - # # The metric rules bind all methods to the read_calls metric, - # # except for the UpdateBook and DeleteBook methods. These two methods - # # are mapped to the write_calls metric, with the UpdateBook method - # # consuming at twice rate as the DeleteBook method. - # metric_rules: - # - selector: "*" - # metric_costs: - # library.googleapis.com/read_calls: 1 - # - selector: google.example.library.v1.LibraryService.UpdateBook - # metric_costs: - # library.googleapis.com/write_calls: 2 - # - selector: google.example.library.v1.LibraryService.DeleteBook - # metric_costs: - # library.googleapis.com/write_calls: 1 - # Corresponding Metric definition: - # metrics: - # - name: library.googleapis.com/read_calls - # display_name: Read requests - # metric_kind: DELTA - # value_type: INT64 - # - name: library.googleapis.com/write_calls - # display_name: Write requests - # metric_kind: DELTA - # value_type: INT64 + # Quota configuration helps to achieve fairness and budgeting in service usage. + # The metric based quota configuration works this way: - The service + # configuration defines a set of metrics. - For API calls, the quota. + # metric_rules maps methods to metrics with corresponding costs. - The quota. + # limits defines limits on the metrics, which will be used for quota checks at + # runtime. An example quota configuration in yaml format: quota: limits: - name: + # apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/` + # project`" # rate limit for consumer projects values: STANDARD: 10000 # The + # metric rules bind all methods to the read_calls metric, # except for the + # UpdateBook and DeleteBook methods. These two methods # are mapped to the + # write_calls metric, with the UpdateBook method # consuming at twice rate as + # the DeleteBook method. metric_rules: - selector: "*" metric_costs: library. + # googleapis.com/read_calls: 1 - selector: google.example.library.v1. + # LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - + # selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: + # library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: + # - name: library.googleapis.com/read_calls display_name: Read requests + # metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/ + # write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 class Quota include Google::Apis::Core::Hashable @@ -2785,8 +2364,8 @@ module Google # @return [Array] attr_accessor :limits - # List of `MetricRule` definitions, each one mapping a selected method to one - # or more metrics. + # List of `MetricRule` definitions, each one mapping a selected method to one or + # more metrics. # Corresponds to the JSON property `metricRules` # @return [Array] attr_accessor :metric_rules @@ -2803,95 +2382,89 @@ module Google end # `QuotaLimit` defines a specific limit that applies over a specified duration - # for a limit type. There can be at most one limit for a duration and limit - # type combination defined within a `QuotaGroup`. + # for a limit type. There can be at most one limit for a duration and limit type + # combination defined within a `QuotaGroup`. class QuotaLimit include Google::Apis::Core::Hashable - # Default number of tokens that can be consumed during the specified - # duration. This is the number of tokens assigned when a client - # application developer activates the service for his/her project. - # Specifying a value of 0 will block all requests. This can be used if you - # are provisioning quota to selected consumers and blocking others. - # Similarly, a value of -1 will indicate an unlimited quota. No other - # negative values are allowed. - # Used by group-based quotas only. + # Default number of tokens that can be consumed during the specified duration. + # This is the number of tokens assigned when a client application developer + # activates the service for his/her project. Specifying a value of 0 will block + # all requests. This can be used if you are provisioning quota to selected + # consumers and blocking others. Similarly, a value of -1 will indicate an + # unlimited quota. No other negative values are allowed. Used by group-based + # quotas only. # Corresponds to the JSON property `defaultLimit` # @return [Fixnum] attr_accessor :default_limit - # Optional. User-visible, extended description for this quota limit. - # Should be used only when more context is needed to understand this limit - # than provided by the limit's display name (see: `display_name`). + # Optional. User-visible, extended description for this quota limit. Should be + # used only when more context is needed to understand this limit than provided + # by the limit's display name (see: `display_name`). # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # User-visible display name for this limit. - # Optional. If not set, the UI will provide a default display name based on - # the quota configuration. This field can be used to override the default - # display name generated from the configuration. + # User-visible display name for this limit. Optional. If not set, the UI will + # provide a default display name based on the quota configuration. This field + # can be used to override the default display name generated from the + # configuration. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Duration of this limit in textual notation. Must be "100s" or "1d". - # Used by group-based quotas only. + # Duration of this limit in textual notation. Must be "100s" or "1d". Used by + # group-based quotas only. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration - # Free tier value displayed in the Developers Console for this limit. - # The free tier is the number of tokens that will be subtracted from the - # billed amount when billing is enabled. - # This field can only be set on a limit with duration "1d", in a billable - # group; it is invalid on any other limit. If this field is not set, it - # defaults to 0, indicating that there is no free tier for this service. - # Used by group-based quotas only. + # Free tier value displayed in the Developers Console for this limit. The free + # tier is the number of tokens that will be subtracted from the billed amount + # when billing is enabled. This field can only be set on a limit with duration " + # 1d", in a billable group; it is invalid on any other limit. If this field is + # not set, it defaults to 0, indicating that there is no free tier for this + # service. Used by group-based quotas only. # Corresponds to the JSON property `freeTier` # @return [Fixnum] attr_accessor :free_tier - # Maximum number of tokens that can be consumed during the specified - # duration. Client application developers can override the default limit up - # to this maximum. If specified, this value cannot be set to a value less - # than the default limit. If not specified, it is set to the default limit. - # To allow clients to apply overrides with no upper bound, set this to -1, - # indicating unlimited maximum quota. - # Used by group-based quotas only. + # Maximum number of tokens that can be consumed during the specified duration. + # Client application developers can override the default limit up to this + # maximum. If specified, this value cannot be set to a value less than the + # default limit. If not specified, it is set to the default limit. To allow + # clients to apply overrides with no upper bound, set this to -1, indicating + # unlimited maximum quota. Used by group-based quotas only. # Corresponds to the JSON property `maxLimit` # @return [Fixnum] attr_accessor :max_limit - # The name of the metric this quota limit applies to. The quota limits with - # the same metric will be checked together during runtime. The metric must be + # The name of the metric this quota limit applies to. The quota limits with the + # same metric will be checked together during runtime. The metric must be # defined within the service config. # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric - # Name of the quota limit. - # The name must be provided, and it must be unique within the service. The - # name can only include alphanumeric characters as well as '-'. - # The maximum length of the limit name is 64 characters. + # Name of the quota limit. The name must be provided, and it must be unique + # within the service. The name can only include alphanumeric characters as well + # as '-'. The maximum length of the limit name is 64 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Specify the unit of the quota limit. It uses the same syntax as - # Metric.unit. The supported unit kinds are determined by the quota - # backend system. - # Here are some examples: - # * "1/min/`project`" for quota per minute per project. - # Note: the order of unit components is insignificant. - # The "1" at the beginning is required to follow the metric unit syntax. + # Specify the unit of the quota limit. It uses the same syntax as Metric.unit. + # The supported unit kinds are determined by the quota backend system. Here are + # some examples: * "1/min/`project`" for quota per minute per project. Note: the + # order of unit components is insignificant. The "1" at the beginning is + # required to follow the metric unit syntax. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit # Tiered limit values. You must specify this as a key:value pair, with an - # integer value that is the maximum number of requests allowed for the - # specified unit. Currently only STANDARD is supported. + # integer value that is the maximum number of requests allowed for the specified + # unit. Currently only STANDARD is supported. # Corresponds to the JSON property `values` # @return [Hash] attr_accessor :values @@ -2960,50 +2533,32 @@ module Google end # `Service` is the root object of Google service configuration schema. It - # describes basic information about a service, such as the name and the - # title, and delegates other aspects to sub-sections. Each sub-section is - # either a proto message or a repeated proto message that configures a - # specific aspect, such as auth. See each proto message definition for details. - # Example: - # type: google.api.Service - # config_version: 3 - # name: calendar.googleapis.com - # title: Google Calendar API - # apis: - # - name: google.calendar.v3.Calendar - # authentication: - # providers: - # - id: google_calendar_auth - # jwks_uri: https://www.googleapis.com/oauth2/v1/certs - # issuer: https://securetoken.google.com - # rules: - # - selector: "*" - # requirements: - # provider_id: google_calendar_auth + # describes basic information about a service, such as the name and the title, + # and delegates other aspects to sub-sections. Each sub-section is either a + # proto message or a repeated proto message that configures a specific aspect, + # such as auth. See each proto message definition for details. Example: type: + # google.api.Service config_version: 3 name: calendar.googleapis.com title: + # Google Calendar API apis: - name: google.calendar.v3.Calendar authentication: + # providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/ + # oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" + # requirements: provider_id: google_calendar_auth class Service include Google::Apis::Core::Hashable - # A list of API interfaces exported by this service. Only the `name` field - # of the google.protobuf.Api needs to be provided by the configuration - # author, as the remaining fields will be derived from the IDL during the - # normalization process. It is an error to specify an API interface here - # which cannot be resolved against the associated IDL files. + # A list of API interfaces exported by this service. Only the `name` field of + # the google.protobuf.Api needs to be provided by the configuration author, as + # the remaining fields will be derived from the IDL during the normalization + # process. It is an error to specify an API interface here which cannot be + # resolved against the associated IDL files. # Corresponds to the JSON property `apis` # @return [Array] attr_accessor :apis - # `Authentication` defines the authentication configuration for an API. - # Example for an API targeted for external use: - # name: calendar.googleapis.com - # authentication: - # providers: - # - id: google_calendar_auth - # jwks_uri: https://www.googleapis.com/oauth2/v1/certs - # issuer: https://securetoken.google.com - # rules: - # - selector: "*" - # requirements: - # provider_id: google_calendar_auth + # `Authentication` defines the authentication configuration for an API. Example + # for an API targeted for external use: name: calendar.googleapis.com + # authentication: providers: - id: google_calendar_auth jwks_uri: https://www. + # googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - + # selector: "*" requirements: provider_id: google_calendar_auth # Corresponds to the JSON property `authentication` # @return [Google::Apis::ServiceconsumermanagementV1::Authentication] attr_accessor :authentication @@ -3013,211 +2568,136 @@ module Google # @return [Google::Apis::ServiceconsumermanagementV1::Backend] attr_accessor :backend - # Billing related configuration of the service. - # The following example shows how to configure monitored resources and metrics - # for billing, `consumer_destinations` is the only supported destination and - # the monitored resources need at least one label key - # `cloud.googleapis.com/location` to indicate the location of the billing - # usage, using different monitored resources between monitoring and billing is - # recommended so they can be evolved independently: - # monitored_resources: - # - type: library.googleapis.com/billing_branch - # labels: - # - key: cloud.googleapis.com/location - # description: | - # Predefined label to support billing location restriction. - # - key: city - # description: | - # Custom label to define the city where the library branch is located - # in. - # - key: name - # description: Custom label to define the name of the library branch. - # metrics: - # - name: library.googleapis.com/book/borrowed_count - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # billing: - # consumer_destinations: - # - monitored_resource: library.googleapis.com/billing_branch - # metrics: - # - library.googleapis.com/book/borrowed_count + # Billing related configuration of the service. The following example shows how + # to configure monitored resources and metrics for billing, ` + # consumer_destinations` is the only supported destination and the monitored + # resources need at least one label key `cloud.googleapis.com/location` to + # indicate the location of the billing usage, using different monitored + # resources between monitoring and billing is recommended so they can be evolved + # independently: monitored_resources: - type: library.googleapis.com/ + # billing_branch labels: - key: cloud.googleapis.com/location description: | + # Predefined label to support billing location restriction. - key: city + # description: | Custom label to define the city where the library branch is + # located in. - key: name description: Custom label to define the name of the + # library branch. metrics: - name: library.googleapis.com/book/borrowed_count + # metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: + # - monitored_resource: library.googleapis.com/billing_branch metrics: - library. + # googleapis.com/book/borrowed_count # Corresponds to the JSON property `billing` # @return [Google::Apis::ServiceconsumermanagementV1::Billing] attr_accessor :billing - # The semantic version of the service configuration. The config version - # affects the interpretation of the service configuration. For example, - # certain features are enabled by default for certain config versions. - # The latest config version is `3`. + # The semantic version of the service configuration. The config version affects + # the interpretation of the service configuration. For example, certain features + # are enabled by default for certain config versions. The latest config version + # is `3`. # Corresponds to the JSON property `configVersion` # @return [Fixnum] attr_accessor :config_version - # `Context` defines which contexts an API requests. - # Example: - # context: - # rules: - # - selector: "*" - # requested: - # - google.rpc.context.ProjectContext - # - google.rpc.context.OriginContext - # The above specifies that all methods in the API request - # `google.rpc.context.ProjectContext` and - # `google.rpc.context.OriginContext`. - # Available context types are defined in package - # `google.rpc.context`. - # This also provides mechanism to whitelist any protobuf message extension that - # can be sent in grpc metadata using “x-goog-ext--bin” and - # “x-goog-ext--jspb” format. For example, list any service - # specific protobuf types that can appear in grpc metadata as follows in your - # yaml file: - # Example: - # context: - # rules: - # - selector: "google.example.library.v1.LibraryService.CreateBook" - # allowed_request_extensions: - # - google.foo.v1.NewExtension - # allowed_response_extensions: - # - google.foo.v1.NewExtension - # You can also specify extension ID instead of fully qualified extension name - # here. + # `Context` defines which contexts an API requests. Example: context: rules: - + # selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc. + # context.OriginContext The above specifies that all methods in the API request ` + # google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. + # Available context types are defined in package `google.rpc.context`. This also + # provides mechanism to whitelist any protobuf message extension that can be + # sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. + # For example, list any service specific protobuf types that can appear in grpc + # metadata as follows in your yaml file: Example: context: rules: - selector: " + # google.example.library.v1.LibraryService.CreateBook" + # allowed_request_extensions: - google.foo.v1.NewExtension + # allowed_response_extensions: - google.foo.v1.NewExtension You can also specify + # extension ID instead of fully qualified extension name here. # Corresponds to the JSON property `context` # @return [Google::Apis::ServiceconsumermanagementV1::Context] attr_accessor :context - # Selects and configures the service controller used by the service. The - # service controller handles features like abuse, quota, billing, logging, - # monitoring, etc. + # Selects and configures the service controller used by the service. The service + # controller handles features like abuse, quota, billing, logging, monitoring, + # etc. # Corresponds to the JSON property `control` # @return [Google::Apis::ServiceconsumermanagementV1::Control] attr_accessor :control - # Customize service error responses. For example, list any service - # specific protobuf types that can appear in error detail lists of - # error responses. - # Example: - # custom_error: - # types: - # - google.foo.v1.CustomError - # - google.foo.v1.AnotherError + # Customize service error responses. For example, list any service specific + # protobuf types that can appear in error detail lists of error responses. + # Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1. + # AnotherError # Corresponds to the JSON property `customError` # @return [Google::Apis::ServiceconsumermanagementV1::CustomError] attr_accessor :custom_error - # `Documentation` provides the information for describing a service. - # Example: - # 
documentation:
-        # summary: >
-        # The Google Calendar API gives access
-        # to most calendar features.
-        # pages:
-        # - name: Overview
-        # content: (== include google/foo/overview.md ==)
-        # - name: Tutorial
-        # content: (== include google/foo/tutorial.md ==)
-        # subpages;
-        # - name: Java
-        # content: (== include google/foo/tutorial_java.md ==)
-        # rules:
-        # - selector: google.calendar.Calendar.Get
-        # description: >
-        # ...
-        # - selector: google.calendar.Calendar.Put
-        # description: >
-        # ...
-        #
- # Documentation is provided in markdown syntax. In addition to - # standard markdown features, definition lists, tables and fenced - # code blocks are supported. Section headers can be provided and are - # interpreted relative to the section nesting of the context where - # a documentation fragment is embedded. - # Documentation from the IDL is merged with documentation defined - # via the config at normalization time, where documentation provided - # by config rules overrides IDL provided. - # A number of constructs specific to the API platform are supported - # in documentation text. - # In order to reference a proto element, the following - # notation can be used: - # 
[fully.qualified.proto.name][]
- # To override the display text used for the link, this can be used: - # 
[display text][fully.qualified.proto.name]
- # Text can be excluded from doc using the following notation: - # 
(-- internal comment --)
- # A few directives are available in documentation. Note that - # directives must appear on a single line to be properly - # identified. The `include` directive includes a markdown file from - # an external source: - # 
(== include path/to/file ==)
- # The `resource_for` directive marks a message to be the resource of - # a collection in REST view. If it is not specified, tools attempt - # to infer the resource from the operations in a collection: - # 
(== resource_for v1.shelves.books ==)
- # The directive `suppress_warning` does not directly affect documentation - # and is documented together with service config validation. + # `Documentation` provides the information for describing a service. Example: + # documentation: summary: > The Google Calendar API gives access to most + # calendar features. pages: - name: Overview content: (== include google/foo/ + # overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md == + # ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==) + # rules: - selector: google.calendar.Calendar.Get description: > ... - selector: + # google.calendar.Calendar.Put description: > ... Documentation is provided in + # markdown syntax. In addition to standard markdown features, definition lists, + # tables and fenced code blocks are supported. Section headers can be provided + # and are interpreted relative to the section nesting of the context where a + # documentation fragment is embedded. Documentation from the IDL is merged with + # documentation defined via the config at normalization time, where + # documentation provided by config rules overrides IDL provided. A number of + # constructs specific to the API platform are supported in documentation text. + # In order to reference a proto element, the following notation can be used: [ + # fully.qualified.proto.name][] To override the display text used for the link, + # this can be used: [display text][fully.qualified.proto.name] Text can be + # excluded from doc using the following notation: (-- internal comment --) A few + # directives are available in documentation. Note that directives must appear on + # a single line to be properly identified. The `include` directive includes a + # markdown file from an external source: (== include path/to/file ==) The ` + # resource_for` directive marks a message to be the resource of a collection in + # REST view. If it is not specified, tools attempt to infer the resource from + # the operations in a collection: (== resource_for v1.shelves.books ==) The + # directive `suppress_warning` does not directly affect documentation and is + # documented together with service config validation. # Corresponds to the JSON property `documentation` # @return [Google::Apis::ServiceconsumermanagementV1::Documentation] attr_accessor :documentation - # Configuration for network endpoints. If this is empty, then an endpoint - # with the same name as the service is automatically generated to service all - # defined APIs. + # Configuration for network endpoints. If this is empty, then an endpoint with + # the same name as the service is automatically generated to service all defined + # APIs. # Corresponds to the JSON property `endpoints` # @return [Array] attr_accessor :endpoints - # A list of all enum types included in this API service. Enums - # referenced directly or indirectly by the `apis` are automatically - # included. Enums which are not referenced but shall be included - # should be listed here by name. Example: - # enums: - # - name: google.someapi.v1.SomeEnum + # A list of all enum types included in this API service. Enums referenced + # directly or indirectly by the `apis` are automatically included. Enums which + # are not referenced but shall be included should be listed here by name. + # Example: enums: - name: google.someapi.v1.SomeEnum # Corresponds to the JSON property `enums` # @return [Array] attr_accessor :enums # Defines the HTTP configuration for an API service. It contains a list of - # HttpRule, each specifying the mapping of an RPC method - # to one or more HTTP REST API methods. + # HttpRule, each specifying the mapping of an RPC method to one or more HTTP + # REST API methods. # Corresponds to the JSON property `http` # @return [Google::Apis::ServiceconsumermanagementV1::Http] attr_accessor :http - # A unique ID for a specific instance of this message, typically assigned - # by the client for tracking purpose. Must be no longer than 63 characters - # and only lower case letters, digits, '.', '_' and '-' are allowed. If - # empty, the server may choose to generate one instead. + # A unique ID for a specific instance of this message, typically assigned by the + # client for tracking purpose. Must be no longer than 63 characters and only + # lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server + # may choose to generate one instead. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Logging configuration of the service. - # The following example shows how to configure logs to be sent to the - # producer and consumer projects. In the example, the `activity_history` - # log is sent to both the producer and consumer projects, whereas the - # `purchase_history` log is only sent to the producer project. - # monitored_resources: - # - type: library.googleapis.com/branch - # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. - # logs: - # - name: activity_history - # labels: - # - key: /customer_id - # - name: purchase_history - # logging: - # producer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history - # - purchase_history - # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history + # Logging configuration of the service. The following example shows how to + # configure logs to be sent to the producer and consumer projects. In the + # example, the `activity_history` log is sent to both the producer and consumer + # projects, whereas the `purchase_history` log is only sent to the producer + # project. monitored_resources: - type: library.googleapis.com/branch labels: - + # key: /city description: The city where the library branch is located in. - key: + # /name description: The name of the branch. logs: - name: activity_history + # labels: - key: /customer_id - name: purchase_history logging: + # producer_destinations: - monitored_resource: library.googleapis.com/branch + # logs: - activity_history - purchase_history consumer_destinations: - + # monitored_resource: library.googleapis.com/branch logs: - activity_history # Corresponds to the JSON property `logging` # @return [Google::Apis::ServiceconsumermanagementV1::Logging] attr_accessor :logging @@ -3232,70 +2712,41 @@ module Google # @return [Array] attr_accessor :metrics - # Defines the monitored resources used by this service. This is required - # by the Service.monitoring and Service.logging configurations. + # Defines the monitored resources used by this service. This is required by the + # Service.monitoring and Service.logging configurations. # Corresponds to the JSON property `monitoredResources` # @return [Array] attr_accessor :monitored_resources - # Monitoring configuration of the service. - # The example below shows how to configure monitored resources and metrics - # for monitoring. In the example, a monitored resource and two metrics are - # defined. The `library.googleapis.com/book/returned_count` metric is sent - # to both producer and consumer projects, whereas the - # `library.googleapis.com/book/num_overdue` metric is only sent to the - # consumer project. - # monitored_resources: - # - type: library.googleapis.com/Branch - # display_name: "Library Branch" - # description: "A branch of a library." - # launch_stage: GA - # labels: - # - key: resource_container - # description: "The Cloud container (ie. project id) for the Branch." - # - key: location - # description: "The location of the library branch." - # - key: branch_id - # description: "The id of the branch." - # metrics: - # - name: library.googleapis.com/book/returned_count - # display_name: "Books Returned" - # description: "The count of books that have been returned." - # launch_stage: GA - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # - name: library.googleapis.com/book/num_overdue - # display_name: "Books Overdue" - # description: "The current number of overdue books." - # launch_stage: GA - # metric_kind: GAUGE - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # monitoring: - # producer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # consumer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # - library.googleapis.com/book/num_overdue + # Monitoring configuration of the service. The example below shows how to + # configure monitored resources and metrics for monitoring. In the example, a + # monitored resource and two metrics are defined. The `library.googleapis.com/ + # book/returned_count` metric is sent to both producer and consumer projects, + # whereas the `library.googleapis.com/book/num_overdue` metric is only sent to + # the consumer project. monitored_resources: - type: library.googleapis.com/ + # Branch display_name: "Library Branch" description: "A branch of a library." + # launch_stage: GA labels: - key: resource_container description: "The Cloud + # container (ie. project id) for the Branch." - key: location description: "The + # location of the library branch." - key: branch_id description: "The id of the + # branch." metrics: - name: library.googleapis.com/book/returned_count + # display_name: "Books Returned" description: "The count of books that have been + # returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" + # labels: - key: customer_id description: "The id of the customer." - name: + # library.googleapis.com/book/num_overdue display_name: "Books Overdue" + # description: "The current number of overdue books." launch_stage: GA + # metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id + # description: "The id of the customer." monitoring: producer_destinations: - + # monitored_resource: library.googleapis.com/Branch metrics: - library. + # googleapis.com/book/returned_count consumer_destinations: - monitored_resource: + # library.googleapis.com/Branch metrics: - library.googleapis.com/book/ + # returned_count - library.googleapis.com/book/num_overdue # Corresponds to the JSON property `monitoring` # @return [Google::Apis::ServiceconsumermanagementV1::Monitoring] attr_accessor :monitoring - # The service name, which is a DNS-like logical identifier for the - # service, such as `calendar.googleapis.com`. The service name - # typically goes through DNS verification to make sure the owner - # of the service also owns the DNS name. + # The service name, which is a DNS-like logical identifier for the service, such + # as `calendar.googleapis.com`. The service name typically goes through DNS + # verification to make sure the owner of the service also owns the DNS name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3305,46 +2756,25 @@ module Google # @return [String] attr_accessor :producer_project_id - # Quota configuration helps to achieve fairness and budgeting in service - # usage. - # The metric based quota configuration works this way: - # - The service configuration defines a set of metrics. - # - For API calls, the quota.metric_rules maps methods to metrics with - # corresponding costs. - # - The quota.limits defines limits on the metrics, which will be used for - # quota checks at runtime. - # An example quota configuration in yaml format: - # quota: - # limits: - # - name: apiWriteQpsPerProject - # metric: library.googleapis.com/write_calls - # unit: "1/min/`project`" # rate limit for consumer projects - # values: - # STANDARD: 10000 - # # The metric rules bind all methods to the read_calls metric, - # # except for the UpdateBook and DeleteBook methods. These two methods - # # are mapped to the write_calls metric, with the UpdateBook method - # # consuming at twice rate as the DeleteBook method. - # metric_rules: - # - selector: "*" - # metric_costs: - # library.googleapis.com/read_calls: 1 - # - selector: google.example.library.v1.LibraryService.UpdateBook - # metric_costs: - # library.googleapis.com/write_calls: 2 - # - selector: google.example.library.v1.LibraryService.DeleteBook - # metric_costs: - # library.googleapis.com/write_calls: 1 - # Corresponding Metric definition: - # metrics: - # - name: library.googleapis.com/read_calls - # display_name: Read requests - # metric_kind: DELTA - # value_type: INT64 - # - name: library.googleapis.com/write_calls - # display_name: Write requests - # metric_kind: DELTA - # value_type: INT64 + # Quota configuration helps to achieve fairness and budgeting in service usage. + # The metric based quota configuration works this way: - The service + # configuration defines a set of metrics. - For API calls, the quota. + # metric_rules maps methods to metrics with corresponding costs. - The quota. + # limits defines limits on the metrics, which will be used for quota checks at + # runtime. An example quota configuration in yaml format: quota: limits: - name: + # apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/` + # project`" # rate limit for consumer projects values: STANDARD: 10000 # The + # metric rules bind all methods to the read_calls metric, # except for the + # UpdateBook and DeleteBook methods. These two methods # are mapped to the + # write_calls metric, with the UpdateBook method # consuming at twice rate as + # the DeleteBook method. metric_rules: - selector: "*" metric_costs: library. + # googleapis.com/read_calls: 1 - selector: google.example.library.v1. + # LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - + # selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: + # library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: + # - name: library.googleapis.com/read_calls display_name: Read requests + # metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/ + # write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 # Corresponds to the JSON property `quota` # @return [Google::Apis::ServiceconsumermanagementV1::Quota] attr_accessor :quota @@ -3354,20 +2784,18 @@ module Google # @return [Google::Apis::ServiceconsumermanagementV1::SourceInfo] attr_accessor :source_info - # ### System parameter configuration - # A system parameter is a special kind of parameter defined by the API - # system, not by an individual API. It is typically mapped to an HTTP header - # and/or a URL query parameter. This configuration specifies which methods - # change the names of the system parameters. + # ### System parameter configuration A system parameter is a special kind of + # parameter defined by the API system, not by an individual API. It is typically + # mapped to an HTTP header and/or a URL query parameter. This configuration + # specifies which methods change the names of the system parameters. # Corresponds to the JSON property `systemParameters` # @return [Google::Apis::ServiceconsumermanagementV1::SystemParameters] attr_accessor :system_parameters - # A list of all proto message types included in this API service. - # It serves similar purpose as [google.api.Service.types], except that - # these types are not needed by user-defined APIs. Therefore, they will not - # show up in the generated discovery doc. This field should only be used - # to define system APIs in ESF. + # A list of all proto message types included in this API service. It serves + # similar purpose as [google.api.Service.types], except that these types are not + # needed by user-defined APIs. Therefore, they will not show up in the generated + # discovery doc. This field should only be used to define system APIs in ESF. # Corresponds to the JSON property `systemTypes` # @return [Array] attr_accessor :system_types @@ -3377,12 +2805,10 @@ module Google # @return [String] attr_accessor :title - # A list of all proto message types included in this API service. - # Types referenced directly or indirectly by the `apis` are - # automatically included. Messages which are not referenced but - # shall be included, such as types used by the `google.protobuf.Any` type, - # should be listed here by name. Example: - # types: + # A list of all proto message types included in this API service. Types + # referenced directly or indirectly by the `apis` are automatically included. + # Messages which are not referenced but shall be included, such as types used by + # the `google.protobuf.Any` type, should be listed here by name. Example: types: # - name: google.protobuf.Int32 # Corresponds to the JSON property `types` # @return [Array] @@ -3433,12 +2859,11 @@ module Google class ServiceAccountConfig include Google::Apis::Core::Hashable - # ID of the IAM service account to be created in tenant project. - # The email format of the service account is - # "@.iam.gserviceaccount.com". - # This account ID must be unique within tenant project and service - # producers have to guarantee it. The ID must be 6-30 characters long, and - # match the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])`. + # ID of the IAM service account to be created in tenant project. The email + # format of the service account is "@.iam.gserviceaccount.com". This account ID + # must be unique within tenant project and service producers have to guarantee + # it. The ID must be 6-30 characters long, and match the following regular + # expression: `[a-z]([-a-z0-9]*[a-z0-9])`. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id @@ -3459,32 +2884,28 @@ module Google end end - # The per-product per-project service identity for a service. - # Use this field to configure per-product per-project service identity. - # Example of a service identity configuration. - # usage: - # service_identity: - # - service_account_parent: "projects/123456789" - # display_name: "Cloud XXX Service Agent" - # description: "Used as the identity of Cloud XXX to access resources" + # The per-product per-project service identity for a service. Use this field to + # configure per-product per-project service identity. Example of a service + # identity configuration. usage: service_identity: - service_account_parent: " + # projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used + # as the identity of Cloud XXX to access resources" class ServiceIdentity include Google::Apis::Core::Hashable - # Optional. A user-specified opaque description of the service account. - # Must be less than or equal to 256 UTF-8 bytes. + # Optional. A user-specified opaque description of the service account. Must be + # less than or equal to 256 UTF-8 bytes. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Optional. A user-specified name for the service account. - # Must be less than or equal to 100 UTF-8 bytes. + # Optional. A user-specified name for the service account. Must be less than or + # equal to 100 UTF-8 bytes. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # A service account project that hosts the service accounts. - # An example name would be: - # `projects/123456789` + # A service account project that hosts the service accounts. An example name + # would be: `projects/123456789` # Corresponds to the JSON property `serviceAccountParent` # @return [String] attr_accessor :service_account_parent @@ -3501,13 +2922,13 @@ module Google end end - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. class SourceContext include Google::Apis::Core::Hashable # The path-qualified name of the .proto file that contained the associated - # protobuf element. For example: `"google/protobuf/source_context.proto"`. + # protobuf element. For example: `"google/protobuf/source_context.proto"`. # Corresponds to the JSON property `fileName` # @return [String] attr_accessor :file_name @@ -3541,12 +2962,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 @@ -3555,15 +2976,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 @@ -3586,8 +3007,7 @@ module Google class SystemParameter include Google::Apis::Core::Hashable - # Define the HTTP header name to use for the parameter. It is case - # insensitive. + # Define the HTTP header name to use for the parameter. It is case insensitive. # Corresponds to the JSON property `httpHeader` # @return [String] attr_accessor :http_header @@ -3615,23 +3035,20 @@ module Google end end - # Define a system parameter rule mapping system parameter definitions to - # methods. + # Define a system parameter rule mapping system parameter definitions to methods. class SystemParameterRule include Google::Apis::Core::Hashable - # Define parameters. Multiple names may be defined for a parameter. - # For a given method call, only one of them should be used. If multiple - # names are used the behavior is implementation-dependent. - # If none of the specified names are present the behavior is - # parameter-dependent. + # Define parameters. Multiple names may be defined for a parameter. For a given + # method call, only one of them should be used. If multiple names are used the + # behavior is implementation-dependent. If none of the specified names are + # present the behavior is parameter-dependent. # Corresponds to the JSON property `parameters` # @return [Array] attr_accessor :parameters # Selects the methods to which this rule applies. Use '*' to indicate all - # methods in all APIs. - # Refer to selector for syntax details. + # methods in all APIs. Refer to selector for syntax details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -3647,36 +3064,23 @@ module Google end end - # ### System parameter configuration - # A system parameter is a special kind of parameter defined by the API - # system, not by an individual API. It is typically mapped to an HTTP header - # and/or a URL query parameter. This configuration specifies which methods - # change the names of the system parameters. + # ### System parameter configuration A system parameter is a special kind of + # parameter defined by the API system, not by an individual API. It is typically + # mapped to an HTTP header and/or a URL query parameter. This configuration + # specifies which methods change the names of the system parameters. class SystemParameters include Google::Apis::Core::Hashable - # Define system parameters. - # The parameters defined here will override the default parameters - # implemented by the system. If this field is missing from the service - # config, default system parameters will be used. Default system parameters - # and names is implementation-dependent. - # Example: define api key for all methods - # system_parameters - # rules: - # - selector: "*" - # parameters: - # - name: api_key - # url_query_parameter: api_key - # Example: define 2 api key names for a specific method. - # system_parameters - # rules: - # - selector: "/ListShelves" - # parameters: - # - name: api_key - # http_header: Api-Key1 - # - name: api_key - # http_header: Api-Key2 - # **NOTE:** All service configuration rules follow "last one wins" order. + # Define system parameters. The parameters defined here will override the + # default parameters implemented by the system. If this field is missing from + # the service config, default system parameters will be used. Default system + # parameters and names is implementation-dependent. Example: define api key for + # all methods system_parameters rules: - selector: "*" parameters: - name: + # api_key url_query_parameter: api_key Example: define 2 api key names for a + # specific method. system_parameters rules: - selector: "/ListShelves" + # parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: + # Api-Key2 **NOTE:** All service configuration rules follow "last one wins" + # order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -3695,8 +3099,8 @@ module Google class TenancyUnit include Google::Apis::Core::Hashable - # @OutputOnly Cloud resource name of the consumer of this service. - # For example 'projects/123456'. + # @OutputOnly Cloud resource name of the consumer of this service. For example ' + # projects/123456'. # Corresponds to the JSON property `consumer` # @return [String] attr_accessor :consumer @@ -3706,21 +3110,20 @@ module Google # @return [String] attr_accessor :create_time - # Globally unique identifier of this tenancy unit - # "services/`service`/`collection id`/`resource id`/tenancyUnits/`unit`" + # Globally unique identifier of this tenancy unit "services/`service`/` + # collection id`/`resource id`/tenancyUnits/`unit`" # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Output only. Google Cloud API name of the managed service owning this - # tenancy unit. - # For example 'serviceconsumermanagement.googleapis.com'. + # Output only. Google Cloud API name of the managed service owning this tenancy + # unit. For example 'serviceconsumermanagement.googleapis.com'. # Corresponds to the JSON property `service` # @return [String] attr_accessor :service - # Resources constituting the tenancy unit. - # There can be at most 512 tenant resources in a tenancy unit. + # Resources constituting the tenancy unit. There can be at most 512 tenant + # resources in a tenancy unit. # Corresponds to the JSON property `tenantResources` # @return [Array] attr_accessor :tenant_resources @@ -3751,11 +3154,10 @@ module Google # @return [Google::Apis::ServiceconsumermanagementV1::BillingConfig] attr_accessor :billing_config - # Folder where project in this tenancy unit must be located - # This folder must have been previously created with the required - # permissions for the caller to create and configure a project in it. - # Valid folder resource names have the format `folders/`folder_number`` - # (for example, `folders/123456`). + # Folder where project in this tenancy unit must be located This folder must + # have been previously created with the required permissions for the caller to + # create and configure a project in it. Valid folder resource names have the + # format `folders/`folder_number`` (for example, `folders/123456`). # Corresponds to the JSON property `folder` # @return [String] attr_accessor :folder @@ -3770,16 +3172,15 @@ module Google # @return [Google::Apis::ServiceconsumermanagementV1::ServiceAccountConfig] attr_accessor :service_account_config - # Google Cloud API names of services that are activated on this project - # during provisioning. If any of these services can't be activated, - # the request fails. + # Google Cloud API names of services that are activated on this project during + # provisioning. If any of these services can't be activated, the request fails. # For example: 'compute.googleapis.com','cloudfunctions.googleapis.com' # Corresponds to the JSON property `services` # @return [Array] attr_accessor :services - # Describes policy settings that need to be applied to a newly - # created tenant project. + # Describes policy settings that need to be applied to a newly created tenant + # project. # Corresponds to the JSON property `tenantProjectPolicy` # @return [Google::Apis::ServiceconsumermanagementV1::TenantProjectPolicy] attr_accessor :tenant_project_policy @@ -3799,17 +3200,16 @@ module Google end end - # Describes policy settings that need to be applied to a newly - # created tenant project. + # Describes policy settings that need to be applied to a newly created tenant + # project. class TenantProjectPolicy include Google::Apis::Core::Hashable - # Policy bindings to be applied to the tenant project, in addition to the - # 'roles/owner' role granted to the Service Consumer Management service - # account. - # At least one binding must have the role `roles/owner`. Among the list of - # members for `roles/owner`, at least one of them must be either the `user` - # or `group` type. + # Policy bindings to be applied to the tenant project, in addition to the 'roles/ + # owner' role granted to the Service Consumer Management service account. At + # least one binding must have the role `roles/owner`. Among the list of members + # for `roles/owner`, at least one of them must be either the `user` or `group` + # type. # Corresponds to the JSON property `policyBindings` # @return [Array] attr_accessor :policy_bindings @@ -3828,9 +3228,8 @@ module Google class TenantResource include Google::Apis::Core::Hashable - # @OutputOnly Identifier of the tenant resource. - # For cloud projects, it is in the form 'projects/`number`'. - # For example 'projects/123456'. + # @OutputOnly Identifier of the tenant resource. For cloud projects, it is in + # the form 'projects/`number`'. For example 'projects/123456'. # Corresponds to the JSON property `resource` # @return [String] attr_accessor :resource @@ -3881,8 +3280,8 @@ module Google # @return [Array] attr_accessor :options - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. # Corresponds to the JSON property `sourceContext` # @return [Google::Apis::ServiceconsumermanagementV1::SourceContext] attr_accessor :source_context @@ -3932,37 +3331,33 @@ module Google include Google::Apis::Core::Hashable # The full resource name of a channel used for sending notifications to the - # service producer. - # Google Service Management currently only supports - # [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification - # channel. To use Google Cloud Pub/Sub as the channel, this must be the name - # of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format - # documented in https://cloud.google.com/pubsub/docs/overview. + # service producer. Google Service Management currently only supports [Google + # Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To + # use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/ + # Sub topic that uses the Cloud Pub/Sub topic name format documented in https:// + # cloud.google.com/pubsub/docs/overview. # Corresponds to the JSON property `producerNotificationChannel` # @return [String] attr_accessor :producer_notification_channel # Requirements that must be satisfied before a consumer project can use the - # service. Each requirement is of the form /; - # for example 'serviceusage.googleapis.com/billing-enabled'. + # service. Each requirement is of the form /; for example 'serviceusage. + # googleapis.com/billing-enabled'. # Corresponds to the JSON property `requirements` # @return [Array] attr_accessor :requirements - # A list of usage rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of usage rules that apply to individual API methods. **NOTE:** All + # service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules - # The per-product per-project service identity for a service. - # Use this field to configure per-product per-project service identity. - # Example of a service identity configuration. - # usage: - # service_identity: - # - service_account_parent: "projects/123456789" - # display_name: "Cloud XXX Service Agent" - # description: "Used as the identity of Cloud XXX to access resources" + # The per-product per-project service identity for a service. Use this field to + # configure per-product per-project service identity. Example of a service + # identity configuration. usage: service_identity: - service_account_parent: " + # projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used + # as the identity of Cloud XXX to access resources" # Corresponds to the JSON property `serviceIdentity` # @return [Google::Apis::ServiceconsumermanagementV1::ServiceIdentity] attr_accessor :service_identity @@ -3980,45 +3375,36 @@ module Google end end - # Usage configuration rules for the service. - # NOTE: Under development. - # Use this rule to configure unregistered calls for the service. Unregistered - # calls are calls that do not contain consumer project identity. - # (Example: calls that do not contain an API key). - # By default, API methods do not allow unregistered calls, and each method call - # must be identified by a consumer project identity. Use this rule to - # allow/disallow unregistered calls. - # Example of an API that wants to allow unregistered calls for entire service. - # usage: - # rules: - # - selector: "*" - # allow_unregistered_calls: true - # Example of a method that wants to allow unregistered calls. - # usage: - # rules: - # - selector: "google.example.library.v1.LibraryService.CreateBook" - # allow_unregistered_calls: true + # Usage configuration rules for the service. NOTE: Under development. Use this + # rule to configure unregistered calls for the service. Unregistered calls are + # calls that do not contain consumer project identity. (Example: calls that do + # not contain an API key). By default, API methods do not allow unregistered + # calls, and each method call must be identified by a consumer project identity. + # Use this rule to allow/disallow unregistered calls. Example of an API that + # wants to allow unregistered calls for entire service. usage: rules: - selector: + # "*" allow_unregistered_calls: true Example of a method that wants to allow + # unregistered calls. usage: rules: - selector: "google.example.library.v1. + # LibraryService.CreateBook" allow_unregistered_calls: true class UsageRule include Google::Apis::Core::Hashable - # If true, the selected method allows unregistered calls, e.g. calls - # that don't identify any user or application. + # If true, the selected method allows unregistered calls, e.g. calls that don't + # identify any user or application. # Corresponds to the JSON property `allowUnregisteredCalls` # @return [Boolean] attr_accessor :allow_unregistered_calls alias_method :allow_unregistered_calls?, :allow_unregistered_calls # Selects the methods to which this rule applies. Use '*' to indicate all - # methods in all APIs. - # Refer to selector for syntax details. + # methods in all APIs. Refer to selector for syntax details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector - # If true, the selected method should skip service control and the control - # plane features, such as quota and billing, will not be available. - # This flag is used by Google Cloud Endpoints to bypass checks for internal - # methods, such as service health check methods. + # If true, the selected method should skip service control and the control plane + # features, such as quota and billing, will not be available. This flag is used + # by Google Cloud Endpoints to bypass checks for internal methods, such as + # service health check methods. # Corresponds to the JSON property `skipServiceControl` # @return [Boolean] attr_accessor :skip_service_control @@ -4036,9 +3422,9 @@ module Google end end - # Response message for the `AddVisibilityLabels` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `AddVisibilityLabels` method. This response message + # is assigned to the `response` field of the returned Operation when that + # operation is done. class V1AddVisibilityLabelsResponse include Google::Apis::Core::Hashable @@ -4076,9 +3462,9 @@ module Google end end - # Response message for the `DisableConsumer` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `DisableConsumer` method. This response message is + # assigned to the `response` field of the returned Operation when that operation + # is done. class V1Beta1DisableConsumerResponse include Google::Apis::Core::Hashable @@ -4091,9 +3477,9 @@ module Google end end - # Response message for the `EnableConsumer` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `EnableConsumer` method. This response message is + # assigned to the `response` field of the returned Operation when that operation + # is done. class V1Beta1EnableConsumerResponse include Google::Apis::Core::Hashable @@ -4106,9 +3492,9 @@ module Google end end - # Response message for the `GenerateServiceIdentity` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `GenerateServiceIdentity` method. This response + # message is assigned to the `response` field of the returned Operation when + # that operation is done. class V1Beta1GenerateServiceIdentityResponse include Google::Apis::Core::Hashable @@ -4169,61 +3555,54 @@ module Google class V1Beta1ProducerQuotaPolicy include Google::Apis::Core::Hashable - # The cloud resource container at which the quota policy is created. The - # format is `container_type`/`container_number` + # The cloud resource container at which the quota policy is created. The format + # is `container_type`/`container_number` # Corresponds to the JSON property `container` # @return [String] attr_accessor :container - # If this map is nonempty, then this policy applies only to specific values - # for dimensions defined in the limit unit. - # For example, an policy on a limit with the unit 1/`project`/`region` - # could contain an entry with the key "region" and the value "us-east-1"; - # the policy is only applied to quota consumed in that region. - # This map has the following restrictions: - # * Keys that are not defined in the limit's unit are not valid keys. - # Any string appearing in `brackets` in the unit (besides `project` or - # `user`) is a defined key. - # * "project" is not a valid key; the project is already specified in - # the parent resource name. - # * "user" is not a valid key; the API does not support quota polcies - # that apply only to a specific user. - # * If "region" appears as a key, its value must be a valid Cloud region. - # * If "zone" appears as a key, its value must be a valid Cloud zone. - # * If any valid key other than "region" or "zone" appears in the map, then - # all valid keys other than "region" or "zone" must also appear in the + # If this map is nonempty, then this policy applies only to specific values for + # dimensions defined in the limit unit. For example, an policy on a limit with + # the unit 1/`project`/`region` could contain an entry with the key "region" and + # the value "us-east-1"; the policy is only applied to quota consumed in that + # region. This map has the following restrictions: * Keys that are not defined + # in the limit's unit are not valid keys. Any string appearing in `brackets` in + # the unit (besides `project` or `user`) is a defined key. * "project" is not a + # valid key; the project is already specified in the parent resource name. * " + # user" is not a valid key; the API does not support quota polcies that apply + # only to a specific user. * If "region" appears as a key, its value must be a + # valid Cloud region. * If "zone" appears as a key, its value must be a valid + # Cloud zone. * If any valid key other than "region" or "zone" appears in the + # map, then all valid keys other than "region" or "zone" must also appear in the # map. # Corresponds to the JSON property `dimensions` # @return [Hash] attr_accessor :dimensions - # The name of the metric to which this policy applies. - # An example name would be: + # The name of the metric to which this policy applies. An example name would be: # `compute.googleapis.com/cpus` # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric - # The resource name of the producer policy. - # An example name would be: - # `services/compute.googleapis.com/organizations/123/consumerQuotaMetrics/ - # compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/ + # The resource name of the producer policy. An example name would be: `services/ + # compute.googleapis.com/organizations/123/consumerQuotaMetrics/compute. + # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/ # 4a3f2c1d` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The quota policy value. - # Can be any nonnegative integer, or -1 (unlimited quota). + # The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota) + # . # Corresponds to the JSON property `policyValue` # @return [Fixnum] attr_accessor :policy_value - # The limit unit of the limit to which this policy applies. - # An example unit would be: - # `1/`project`/`region`` - # Note that ``project`` and ``region`` are not placeholders in this example; - # the literal characters ``` and ``` occur in the string. + # The limit unit of the limit to which this policy applies. An example unit + # would be: `1/`project`/`region`` Note that ``project`` and ``region`` are not + # placeholders in this example; the literal characters ``` and ``` occur in the + # string. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit @@ -4247,61 +3626,53 @@ module Google class V1Beta1QuotaOverride include Google::Apis::Core::Hashable - # The resource name of the ancestor that requested the override. For example: - # "organizations/12345" or "folders/67890". - # Used by admin overrides only. + # The resource name of the ancestor that requested the override. For example: " + # organizations/12345" or "folders/67890". Used by admin overrides only. # Corresponds to the JSON property `adminOverrideAncestor` # @return [String] attr_accessor :admin_override_ancestor # If this map is nonempty, then this override applies only to specific values - # for dimensions defined in the limit unit. - # For example, an override on a limit with the unit 1/`project`/`region` - # could contain an entry with the key "region" and the value "us-east-1"; - # the override is only applied to quota consumed in that region. - # This map has the following restrictions: - # * Keys that are not defined in the limit's unit are not valid keys. - # Any string appearing in `brackets` in the unit (besides `project` or - # `user`) is a defined key. - # * "project" is not a valid key; the project is already specified in - # the parent resource name. - # * "user" is not a valid key; the API does not support quota overrides - # that apply only to a specific user. - # * If "region" appears as a key, its value must be a valid Cloud region. - # * If "zone" appears as a key, its value must be a valid Cloud zone. - # * If any valid key other than "region" or "zone" appears in the map, then - # all valid keys other than "region" or "zone" must also appear in the - # map. + # for dimensions defined in the limit unit. For example, an override on a limit + # with the unit 1/`project`/`region` could contain an entry with the key "region" + # and the value "us-east-1"; the override is only applied to quota consumed in + # that region. This map has the following restrictions: * Keys that are not + # defined in the limit's unit are not valid keys. Any string appearing in ` + # brackets` in the unit (besides `project` or `user`) is a defined key. * " + # project" is not a valid key; the project is already specified in the parent + # resource name. * "user" is not a valid key; the API does not support quota + # overrides that apply only to a specific user. * If "region" appears as a key, + # its value must be a valid Cloud region. * If "zone" appears as a key, its + # value must be a valid Cloud zone. * If any valid key other than "region" or " + # zone" appears in the map, then all valid keys other than "region" or "zone" + # must also appear in the map. # Corresponds to the JSON property `dimensions` # @return [Hash] attr_accessor :dimensions - # The name of the metric to which this override applies. - # An example name would be: - # `compute.googleapis.com/cpus` + # The name of the metric to which this override applies. An example name would + # be: `compute.googleapis.com/cpus` # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric - # The resource name of the producer override. - # An example name would be: - # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. + # The resource name of the producer override. An example name would be: ` + # services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The overriding quota limit value. - # Can be any nonnegative integer, or -1 (unlimited quota). + # The overriding quota limit value. Can be any nonnegative integer, or -1 ( + # unlimited quota). # Corresponds to the JSON property `overrideValue` # @return [Fixnum] attr_accessor :override_value - # The limit unit of the limit to which this override applies. - # An example unit would be: - # `1/`project`/`region`` - # Note that ``project`` and ``region`` are not placeholders in this example; - # the literal characters ``` and ``` occur in the string. + # The limit unit of the limit to which this override applies. An example unit + # would be: `1/`project`/`region`` Note that ``project`` and ``region`` are not + # placeholders in this example; the literal characters ``` and ``` occur in the + # string. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit @@ -4321,9 +3692,9 @@ module Google end end - # Response message for the `RefreshConsumer` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `RefreshConsumer` method. This response message is + # assigned to the `response` field of the returned Operation when that operation + # is done. class V1Beta1RefreshConsumerResponse include Google::Apis::Core::Hashable @@ -4345,17 +3716,16 @@ module Google # @return [String] attr_accessor :email - # P4 service identity resource name. - # An example name would be: - # `services/serviceconsumermanagement.googleapis.com/projects/123/ - # serviceIdentities/default` + # P4 service identity resource name. An example name would be: `services/ + # serviceconsumermanagement.googleapis.com/projects/123/serviceIdentities/ + # default` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The P4 service identity configuration tag. This must be defined in - # activation_grants. If not specified when creating the account, the tag is - # set to "default". + # activation_grants. If not specified when creating the account, the tag is set + # to "default". # Corresponds to the JSON property `tag` # @return [String] attr_accessor :tag @@ -4387,10 +3757,8 @@ module Google # @return [String] attr_accessor :email - # Default identity resource name. - # An example name would be: - # `services/serviceconsumermanagement.googleapis.com/projects/123/ - # defaultIdentity` + # Default identity resource name. An example name would be: `services/ + # serviceconsumermanagement.googleapis.com/projects/123/defaultIdentity` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4412,9 +3780,9 @@ module Google end end - # Response message for the `DisableConsumer` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `DisableConsumer` method. This response message is + # assigned to the `response` field of the returned Operation when that operation + # is done. class V1DisableConsumerResponse include Google::Apis::Core::Hashable @@ -4427,9 +3795,9 @@ module Google end end - # Response message for the `EnableConsumer` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `EnableConsumer` method. This response message is + # assigned to the `response` field of the returned Operation when that operation + # is done. class V1EnableConsumerResponse include Google::Apis::Core::Hashable @@ -4442,9 +3810,9 @@ module Google end end - # Response message for the `GenerateDefaultIdentity` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `GenerateDefaultIdentity` method. This response + # message is assigned to the `response` field of the returned Operation when + # that operation is done. class V1GenerateDefaultIdentityResponse include Google::Apis::Core::Hashable @@ -4459,8 +3827,8 @@ module Google # @return [Google::Apis::ServiceconsumermanagementV1::V1DefaultIdentity] attr_accessor :identity - # Role attached to consumer project. Empty if not attached in this - # request. (Under development, currently always return empty.) + # Role attached to consumer project. Empty if not attached in this request. ( + # Under development, currently always return empty.) # Corresponds to the JSON property `role` # @return [String] attr_accessor :role @@ -4477,9 +3845,9 @@ module Google end end - # Response message for the `GenerateServiceAccount` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `GenerateServiceAccount` method. This response + # message is assigned to the `response` field of the returned Operation when + # that operation is done. class V1GenerateServiceAccountResponse include Google::Apis::Core::Hashable @@ -4498,9 +3866,9 @@ module Google end end - # Response message for the `RefreshConsumer` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `RefreshConsumer` method. This response message is + # assigned to the `response` field of the returned Operation when that operation + # is done. class V1RefreshConsumerResponse include Google::Apis::Core::Hashable @@ -4513,9 +3881,9 @@ module Google end end - # Response message for the `RemoveVisibilityLabels` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `RemoveVisibilityLabels` method. This response + # message is assigned to the `response` field of the returned Operation when + # that operation is done. class V1RemoveVisibilityLabelsResponse include Google::Apis::Core::Hashable @@ -4548,16 +3916,14 @@ module Google # @return [String] attr_accessor :iam_account_name - # P4 SA resource name. - # An example name would be: - # `services/serviceconsumermanagement.googleapis.com/projects/123/ - # serviceAccounts/default` + # P4 SA resource name. An example name would be: `services/ + # serviceconsumermanagement.googleapis.com/projects/123/serviceAccounts/default` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The P4 SA configuration tag. This must be defined in activation_grants. - # If not specified when creating the account, the tag is set to "default". + # The P4 SA configuration tag. This must be defined in activation_grants. If not + # specified when creating the account, the tag is set to "default". # Corresponds to the JSON property `tag` # @return [String] attr_accessor :tag diff --git a/generated/google/apis/serviceconsumermanagement_v1/service.rb b/generated/google/apis/serviceconsumermanagement_v1/service.rb index 614058e69..b1dafa455 100644 --- a/generated/google/apis/serviceconsumermanagement_v1/service.rb +++ b/generated/google/apis/serviceconsumermanagement_v1/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. @@ -89,10 +87,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 @@ -122,9 +120,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 @@ -154,15 +151,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 @@ -203,33 +199,28 @@ module Google # Search tenancy units for a managed service. # @param [String] parent - # Service for which search is performed. - # services/`service` - # `service` the name of a service, for example 'service.googleapis.com'. + # Service for which search is performed. services/`service` `service` the name + # of a service, for example 'service.googleapis.com'. # @param [Fixnum] page_size # Optional. The maximum number of results returned by this request. Currently, - # the - # default maximum is set to 1000. If `page_size` isn't provided or the size + # the default maximum is set to 1000. If `page_size` isn't provided or the size # provided is a number larger than 1000, it's automatically set to 1000. # @param [String] page_token # Optional. The continuation token, which is used to page through large result - # sets. - # To get the next page of results, set this parameter to the value of - # `nextPageToken` from the previous response. + # sets. To get the next page of results, set this parameter to the value of ` + # nextPageToken` from the previous response. # @param [String] query # Optional. Set a query ``expression`` for querying tenancy units. Your `` - # expression`` - # must be in the format: `field_name=literal_string`. The `field_name` is the - # name of the field you want to compare. Supported fields are - # `tenant_resources.tag` and `tenant_resources.resource`. - # For example, to search tenancy units that contain at least one tenant - # resource with a given tag 'xyz', use the query `tenant_resources.tag=xyz`. - # To search tenancy units that contain at least one tenant resource with - # a given resource name 'projects/123456', use the query - # `tenant_resources.resource=projects/123456`. - # Multiple expressions can be joined with `AND`s. Tenancy units must match - # all expressions to be included in the result set. For example, - # `tenant_resources.tag=xyz AND tenant_resources.resource=projects/123456` + # expression`` must be in the format: `field_name=literal_string`. The ` + # field_name` is the name of the field you want to compare. Supported fields are + # `tenant_resources.tag` and `tenant_resources.resource`. For example, to search + # tenancy units that contain at least one tenant resource with a given tag 'xyz', + # use the query `tenant_resources.tag=xyz`. To search tenancy units that + # contain at least one tenant resource with a given resource name 'projects/ + # 123456', use the query `tenant_resources.resource=projects/123456`. Multiple + # expressions can be joined with `AND`s. Tenancy units must match all + # expressions to be included in the result set. For example, `tenant_resources. + # tag=xyz AND tenant_resources.resource=projects/123456` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -260,15 +251,14 @@ module Google execute_or_queue_command(command, &block) end - # Add a new tenant project to the tenancy unit. - # There can be a maximum of 512 tenant projects in a tenancy unit. - # If there are previously failed `AddTenantProject` calls, you might need to - # call `RemoveTenantProject` first to resolve them before you can make - # another call to `AddTenantProject` with the same tag. - # Operation. + # Add a new tenant project to the tenancy unit. There can be a maximum of 512 + # tenant projects in a tenancy unit. If there are previously failed ` + # AddTenantProject` calls, you might need to call `RemoveTenantProject` first to + # resolve them before you can make another call to `AddTenantProject` with the + # same tag. Operation. # @param [String] parent - # Name of the tenancy unit. - # Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. + # Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/ + # 12345/tenancyUnits/abcd'. # @param [Google::Apis::ServiceconsumermanagementV1::AddTenantProjectRequest] add_tenant_project_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -299,26 +289,22 @@ module Google execute_or_queue_command(command, &block) end - # Apply a configuration to an existing tenant project. - # This project must exist in an active state and have the original owner - # account. The caller must have permission to add a project to the given - # tenancy unit. The configuration is applied, but any existing settings on - # the project aren't modified. - # Specified policy bindings are applied. Existing bindings aren't modified. - # Specified services are activated. No service is deactivated. - # If specified, new billing configuration is applied. - # Omit a billing configuration to keep the existing one. - # A service account in the project is created if previously non existed. + # Apply a configuration to an existing tenant project. This project must exist + # in an active state and have the original owner account. The caller must have + # permission to add a project to the given tenancy unit. The configuration is + # applied, but any existing settings on the project aren't modified. Specified + # policy bindings are applied. Existing bindings aren't modified. Specified + # services are activated. No service is deactivated. If specified, new billing + # configuration is applied. Omit a billing configuration to keep the existing + # one. A service account in the project is created if previously non existed. # Specified labels will be appended to tenant project, note that the value of - # existing label key will be updated if the same label key is requested. - # The specified folder is ignored, as moving a tenant project to a different - # folder isn't supported. - # The operation fails if any of the steps fail, but no rollback of already - # applied configuration changes is attempted. - # Operation. + # existing label key will be updated if the same label key is requested. The + # specified folder is ignored, as moving a tenant project to a different folder + # isn't supported. The operation fails if any of the steps fail, but no rollback + # of already applied configuration changes is attempted. Operation. # @param [String] name - # Name of the tenancy unit. - # Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. + # Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/ + # 12345/tenancyUnits/abcd'. # @param [Google::Apis::ServiceconsumermanagementV1::ApplyTenantProjectConfigRequest] apply_tenant_project_config_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -349,20 +335,18 @@ module Google execute_or_queue_command(command, &block) end - # Attach an existing project to the tenancy unit as a new tenant - # resource. The project could either be the tenant project reserved by - # calling `AddTenantProject` under a tenancy unit of a service producer's - # project of a managed service, or from a separate project. - # The caller is checked against a set of permissions as if calling - # `AddTenantProject` on the same service consumer. - # To trigger the attachment, the targeted tenant project must be in a - # folder. Make sure the ServiceConsumerManagement service account is - # the owner of that project. These two requirements are already met - # if the project is reserved by calling `AddTenantProject`. - # Operation. + # Attach an existing project to the tenancy unit as a new tenant resource. The + # project could either be the tenant project reserved by calling ` + # AddTenantProject` under a tenancy unit of a service producer's project of a + # managed service, or from a separate project. The caller is checked against a + # set of permissions as if calling `AddTenantProject` on the same service + # consumer. To trigger the attachment, the targeted tenant project must be in a + # folder. Make sure the ServiceConsumerManagement service account is the owner + # of that project. These two requirements are already met if the project is + # reserved by calling `AddTenantProject`. Operation. # @param [String] name - # Name of the tenancy unit that the project will be attached to. - # Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. + # Name of the tenancy unit that the project will be attached to. Such as ' + # services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. # @param [Google::Apis::ServiceconsumermanagementV1::AttachTenantProjectRequest] attach_tenant_project_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -393,18 +377,16 @@ module Google execute_or_queue_command(command, &block) end - # Creates a tenancy unit with no tenant resources. - # If tenancy unit already exists, it will be returned, - # however, in this case, returned TenancyUnit does not have tenant_resources - # field set and ListTenancyUnits has to be used to get a complete - # TenancyUnit with all fields populated. + # Creates a tenancy unit with no tenant resources. If tenancy unit already + # exists, it will be returned, however, in this case, returned TenancyUnit does + # not have tenant_resources field set and ListTenancyUnits has to be used to get + # a complete TenancyUnit with all fields populated. # @param [String] parent - # services/`service`/`collection id`/`resource id` - # `collection id` is the cloud resource collection type representing the - # service consumer, for example 'projects', or 'organizations'. - # `resource id` is the consumer numeric id, such as project number: '123456'. - # `service` the name of a managed service, such as 'service.googleapis.com'. - # Enables service binding using the new tenancy unit. + # services/`service`/`collection id`/`resource id` `collection id` is the cloud + # resource collection type representing the service consumer, for example ' + # projects', or 'organizations'. `resource id` is the consumer numeric id, such + # as project number: '123456'. `service` the name of a managed service, such as ' + # service.googleapis.com'. Enables service binding using the new tenancy unit. # @param [Google::Apis::ServiceconsumermanagementV1::CreateTenancyUnitRequest] create_tenancy_unit_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -435,9 +417,8 @@ module Google execute_or_queue_command(command, &block) end - # Delete a tenancy unit. Before you delete the tenancy unit, there should be - # no tenant resources in it that aren't in a DELETED state. - # Operation. + # Delete a tenancy unit. Before you delete the tenancy unit, there should be no + # tenant resources in it that aren't in a DELETED state. Operation. # @param [String] name # Name of the tenancy unit to be deleted. # @param [String] fields @@ -470,16 +451,13 @@ module Google # Deletes the specified project resource identified by a tenant resource tag. # The mothod removes a project lien with a 'TenantManager' origin if that was # added. It will then attempt to delete the project. If that operation fails, - # this method also fails. - # After the project has been deleted, the tenant resource state is set to - # DELETED. To permanently remove resource metadata, call the - # `RemoveTenantProject` method. - # New resources with the same tag can't be added if there are existing - # resources in a DELETED state. - # Operation. + # this method also fails. After the project has been deleted, the tenant + # resource state is set to DELETED. To permanently remove resource metadata, + # call the `RemoveTenantProject` method. New resources with the same tag can't + # be added if there are existing resources in a DELETED state. Operation. # @param [String] name - # Name of the tenancy unit. - # Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. + # Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/ + # 12345/tenancyUnits/abcd'. # @param [Google::Apis::ServiceconsumermanagementV1::DeleteTenantProjectRequest] delete_tenant_project_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -510,26 +488,24 @@ module Google execute_or_queue_command(command, &block) end - # Find the tenancy unit for a managed service and service consumer. - # This method shouldn't be used in a service producer's runtime path, for - # example to find the tenant project number when creating VMs. Service - # producers must persist the tenant project's information after the project - # is created. + # Find the tenancy unit for a managed service and service consumer. This method + # shouldn't be used in a service producer's runtime path, for example to find + # the tenant project number when creating VMs. Service producers must persist + # the tenant project's information after the project is created. # @param [String] parent - # Managed service and service consumer. Required. - # services/`service`/`collection id`/`resource id` - # `collection id` is the cloud resource collection type representing the - # service consumer, for example 'projects', or 'organizations'. - # `resource id` is the consumer numeric id, such as project number: '123456'. - # `service` the name of a service, such as 'service.googleapis.com'. + # Managed service and service consumer. Required. services/`service`/`collection + # id`/`resource id` `collection id` is the cloud resource collection type + # representing the service consumer, for example 'projects', or 'organizations'. + # `resource id` is the consumer numeric id, such as project number: '123456'. ` + # service` the name of a service, such as 'service.googleapis.com'. # @param [String] filter # Filter expression over tenancy resources field. Optional. # @param [Fixnum] page_size # The maximum number of results returned by this request. # @param [String] page_token - # The continuation token, which is used to page through large result sets. - # To get the next page of results, set this parameter to the value of - # `nextPageToken` from the previous response. + # The continuation token, which is used to page through large result sets. To + # get the next page of results, set this parameter to the value of ` + # nextPageToken` from the previous response. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -561,16 +537,15 @@ module Google end # Removes the specified project resource identified by a tenant resource tag. - # The method removes the project lien with 'TenantManager' origin if that - # was added. It then attempts to delete the project. If that operation - # fails, this method also fails. - # Calls to remove already removed or non-existent tenant project succeed. - # After the project has been deleted, or if was already in a DELETED state, - # resource metadata is permanently removed from the tenancy unit. - # Operation. + # The method removes the project lien with 'TenantManager' origin if that was + # added. It then attempts to delete the project. If that operation fails, this + # method also fails. Calls to remove already removed or non-existent tenant + # project succeed. After the project has been deleted, or if was already in a + # DELETED state, resource metadata is permanently removed from the tenancy unit. + # Operation. # @param [String] name - # Name of the tenancy unit. - # Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. + # Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/ + # 12345/tenancyUnits/abcd'. # @param [Google::Apis::ServiceconsumermanagementV1::RemoveTenantProjectRequest] remove_tenant_project_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -601,16 +576,14 @@ module Google execute_or_queue_command(command, &block) end - # Attempts to undelete a previously deleted tenant project. The project must - # be in a DELETED state. - # There are no guarantees that an undeleted project will be in - # a fully restored and functional state. Call the `ApplyTenantProjectConfig` + # Attempts to undelete a previously deleted tenant project. The project must be + # in a DELETED state. There are no guarantees that an undeleted project will be + # in a fully restored and functional state. Call the `ApplyTenantProjectConfig` # method to update its configuration and then validate all managed service - # resources. - # Operation. + # resources. Operation. # @param [String] name - # Name of the tenancy unit. - # Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. + # Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/ + # 12345/tenancyUnits/abcd'. # @param [Google::Apis::ServiceconsumermanagementV1::UndeleteTenantProjectRequest] undelete_tenant_project_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/serviceconsumermanagement_v1beta1.rb b/generated/google/apis/serviceconsumermanagement_v1beta1.rb index 73b3ce8a1..0407c3d35 100644 --- a/generated/google/apis/serviceconsumermanagement_v1beta1.rb +++ b/generated/google/apis/serviceconsumermanagement_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/service-consumer-management/docs/overview module ServiceconsumermanagementV1beta1 VERSION = 'V1beta1' - REVISION = '20200721' + REVISION = '20200801' # 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/serviceconsumermanagement_v1beta1/classes.rb b/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb index 33b91e2cd..71ba3fa12 100644 --- a/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb +++ b/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb @@ -22,14 +22,13 @@ module Google module Apis module ServiceconsumermanagementV1beta1 - # Api is a light-weight descriptor for an API Interface. - # Interfaces are also described as "protocol buffer services" in some contexts, - # such as by the "service" keyword in a .proto file, but they are different - # from API Services, which represent a concrete implementation of an interface - # as opposed to simply a description of methods and bindings. They are also - # sometimes simply referred to as "APIs" in other contexts, such as the name of - # this message itself. See https://cloud.google.com/apis/design/glossary for - # detailed terminology. + # Api is a light-weight descriptor for an API Interface. Interfaces are also + # described as "protocol buffer services" in some contexts, such as by the " + # service" keyword in a .proto file, but they are different from API Services, + # which represent a concrete implementation of an interface as opposed to simply + # a description of methods and bindings. They are also sometimes simply referred + # to as "APIs" in other contexts, such as the name of this message itself. See + # https://cloud.google.com/apis/design/glossary for detailed terminology. class Api include Google::Apis::Core::Hashable @@ -43,8 +42,8 @@ module Google # @return [Array] attr_accessor :mixins - # The fully qualified name of this interface, including package name - # followed by the interface's simple name. + # The fully qualified name of this interface, including package name followed by + # the interface's simple name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -54,8 +53,8 @@ module Google # @return [Array] attr_accessor :options - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. # Corresponds to the JSON property `sourceContext` # @return [Google::Apis::ServiceconsumermanagementV1beta1::SourceContext] attr_accessor :source_context @@ -65,23 +64,19 @@ module Google # @return [String] attr_accessor :syntax - # A version string for this interface. If specified, must have the form - # `major-version.minor-version`, as in `1.10`. If the minor version is - # omitted, it defaults to zero. If the entire version field is empty, the - # major version is derived from the package name, as outlined below. If the - # field is not empty, the version in the package name will be verified to be - # consistent with what is provided here. - # The versioning schema uses [semantic - # versioning](http://semver.org) where the major version number - # indicates a breaking change and the minor version an additive, - # non-breaking change. Both version numbers are signals to users - # what to expect from different versions, and should be carefully - # chosen based on the product plan. - # The major version is also reflected in the package name of the - # interface, which must end in `v`, as in - # `google.feature.v1`. For major versions 0 and 1, the suffix can - # be omitted. Zero major versions must only be used for - # experimental, non-GA interfaces. + # A version string for this interface. If specified, must have the form `major- + # version.minor-version`, as in `1.10`. If the minor version is omitted, it + # defaults to zero. If the entire version field is empty, the major version is + # derived from the package name, as outlined below. If the field is not empty, + # the version in the package name will be verified to be consistent with what is + # provided here. The versioning schema uses [semantic versioning](http://semver. + # org) where the major version number indicates a breaking change and the minor + # version an additive, non-breaking change. Both version numbers are signals to + # users what to expect from different versions, and should be carefully chosen + # based on the product plan. The major version is also reflected in the package + # name of the interface, which must end in `v`, as in `google.feature.v1`. For + # major versions 0 and 1, the suffix can be omitted. Zero major versions must + # only be used for experimental, non-GA interfaces. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -102,85 +97,63 @@ module Google end end - # Configuration for an authentication provider, including support for - # [JSON Web Token - # (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + # Configuration for an authentication provider, including support for [JSON Web + # Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). class AuthProvider include Google::Apis::Core::Hashable - # The list of JWT - # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32# - # section-4.1.3). - # that are allowed to access. A JWT containing any of these audiences will - # be accepted. When this setting is absent, JWTs with audiences: - # - "https://[service.name]/[google.protobuf.Api.name]" - # - "https://[service.name]/" - # will be accepted. - # For example, if no audiences are in the setting, LibraryService API will - # accept JWTs with the following audiences: - # - + # The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json- + # web-token-32#section-4.1.3). that are allowed to access. A JWT containing any + # of these audiences will be accepted. When this setting is absent, JWTs with + # audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[ + # service.name]/" will be accepted. For example, if no audiences are in the + # setting, LibraryService API will accept JWTs with the following audiences: - # https://library-example.googleapis.com/google.example.library.v1. - # LibraryService - # - https://library-example.googleapis.com/ - # Example: - # audiences: bookstore_android.apps.googleusercontent.com, - # bookstore_web.apps.googleusercontent.com + # LibraryService - https://library-example.googleapis.com/ Example: audiences: + # bookstore_android.apps.googleusercontent.com, bookstore_web.apps. + # googleusercontent.com # Corresponds to the JSON property `audiences` # @return [String] attr_accessor :audiences - # Redirect URL if JWT token is required but not present or is expired. - # Implement authorizationUrl of securityDefinitions in OpenAPI spec. + # Redirect URL if JWT token is required but not present or is expired. Implement + # authorizationUrl of securityDefinitions in OpenAPI spec. # Corresponds to the JSON property `authorizationUrl` # @return [String] attr_accessor :authorization_url - # The unique identifier of the auth provider. It will be referred to by - # `AuthRequirement.provider_id`. - # Example: "bookstore_auth". + # The unique identifier of the auth provider. It will be referred to by ` + # AuthRequirement.provider_id`. Example: "bookstore_auth". # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Identifies the principal that issued the JWT. See - # https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - # Usually a URL or an email address. - # Example: https://securetoken.google.com - # Example: 1234567-compute@developer.gserviceaccount.com + # Identifies the principal that issued the JWT. See https://tools.ietf.org/html/ + # draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email + # address. Example: https://securetoken.google.com Example: 1234567-compute@ + # developer.gserviceaccount.com # Corresponds to the JSON property `issuer` # @return [String] attr_accessor :issuer - # URL of the provider's public key set to validate signature of the JWT. See - # [OpenID - # Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html# - # ProviderMetadata). - # Optional if the key set document: - # - can be retrieved from - # [OpenID - # Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of - # the issuer. - # - can be inferred from the email domain of the issuer (e.g. a Google - # service account). - # Example: https://www.googleapis.com/oauth2/v1/certs + # URL of the provider's public key set to validate signature of the JWT. See [ + # OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html# + # ProviderMetadata). Optional if the key set document: - can be retrieved from [ + # OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html + # of the issuer. - can be inferred from the email domain of the issuer (e.g. a + # Google service account). Example: https://www.googleapis.com/oauth2/v1/certs # Corresponds to the JSON property `jwksUri` # @return [String] attr_accessor :jwks_uri - # Defines the locations to extract the JWT. - # JWT locations can be either from HTTP headers or URL query parameters. - # The rule is that the first match wins. The checking order is: checking - # all headers first, then URL query parameters. - # If not specified, default to use following 3 locations: - # 1) Authorization: Bearer - # 2) x-goog-iap-jwt-assertion - # 3) access_token query parameter - # Default locations can be specified as followings: - # jwt_locations: - # - header: Authorization - # value_prefix: "Bearer " - # - header: x-goog-iap-jwt-assertion - # - query: access_token + # Defines the locations to extract the JWT. JWT locations can be either from + # HTTP headers or URL query parameters. The rule is that the first match wins. + # The checking order is: checking all headers first, then URL query parameters. + # If not specified, default to use following 3 locations: 1) Authorization: + # Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default + # locations can be specified as followings: jwt_locations: - header: + # Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - + # query: access_token # Corresponds to the JSON property `jwtLocations` # @return [Array] attr_accessor :jwt_locations @@ -200,34 +173,26 @@ module Google end end - # User-defined authentication requirements, including support for - # [JSON Web Token - # (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + # User-defined authentication requirements, including support for [JSON Web + # Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). class AuthRequirement include Google::Apis::Core::Hashable - # NOTE: This will be deprecated soon, once AuthProvider.audiences is - # implemented and accepted in all the runtime components. - # The list of JWT - # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32# - # section-4.1.3). - # that are allowed to access. A JWT containing any of these audiences will - # be accepted. When this setting is absent, only JWTs with audience - # "https://Service_name/API_name" - # will be accepted. For example, if no audiences are in the setting, - # LibraryService API will only accept JWTs with the following audience - # "https://library-example.googleapis.com/google.example.library.v1. - # LibraryService". - # Example: - # audiences: bookstore_android.apps.googleusercontent.com, - # bookstore_web.apps.googleusercontent.com + # NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented + # and accepted in all the runtime components. The list of JWT [audiences](https:/ + # /tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that + # are allowed to access. A JWT containing any of these audiences will be + # accepted. When this setting is absent, only JWTs with audience "https:// + # Service_name/API_name" will be accepted. For example, if no audiences are in + # the setting, LibraryService API will only accept JWTs with the following + # audience "https://library-example.googleapis.com/google.example.library.v1. + # LibraryService". Example: audiences: bookstore_android.apps.googleusercontent. + # com, bookstore_web.apps.googleusercontent.com # Corresponds to the JSON property `audiences` # @return [String] attr_accessor :audiences - # id from authentication provider. - # Example: - # provider_id: bookstore_auth + # id from authentication provider. Example: provider_id: bookstore_auth # Corresponds to the JSON property `providerId` # @return [String] attr_accessor :provider_id @@ -243,18 +208,11 @@ module Google end end - # `Authentication` defines the authentication configuration for an API. - # Example for an API targeted for external use: - # name: calendar.googleapis.com - # authentication: - # providers: - # - id: google_calendar_auth - # jwks_uri: https://www.googleapis.com/oauth2/v1/certs - # issuer: https://securetoken.google.com - # rules: - # - selector: "*" - # requirements: - # provider_id: google_calendar_auth + # `Authentication` defines the authentication configuration for an API. Example + # for an API targeted for external use: name: calendar.googleapis.com + # authentication: providers: - id: google_calendar_auth jwks_uri: https://www. + # googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - + # selector: "*" requirements: provider_id: google_calendar_auth class Authentication include Google::Apis::Core::Hashable @@ -263,8 +221,8 @@ module Google # @return [Array] attr_accessor :providers - # A list of authentication rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of authentication rules that apply to individual API methods. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -280,13 +238,11 @@ module Google end end - # Authentication rules for the service. - # By default, if a method has any authentication requirements, every request - # must include a valid credential matching one of the requirements. - # It's an error to include more than one kind of credential in a single - # request. - # If a method doesn't have any auth requirements, request credentials will be - # ignored. + # Authentication rules for the service. By default, if a method has any + # authentication requirements, every request must include a valid credential + # matching one of the requirements. It's an error to include more than one kind + # of credential in a single request. If a method doesn't have any auth + # requirements, request credentials will be ignored. class AuthenticationRule include Google::Apis::Core::Hashable @@ -297,19 +253,18 @@ module Google alias_method :allow_without_credential?, :allow_without_credential # OAuth scopes are a way to define data and permissions on data. For example, - # there are scopes defined for "Read-only access to Google Calendar" and - # "Access to Cloud Platform". Users can consent to a scope for an application, - # giving it permission to access that data on their behalf. - # OAuth scope specifications should be fairly coarse grained; a user will need - # to see and understand the text description of what your scope means. - # In most cases: use one or at most two OAuth scopes for an entire family of - # products. If your product has multiple APIs, you should probably be sharing - # the OAuth scope across all of those APIs. - # When you need finer grained OAuth consent screens: talk with your product - # management about how developers will use them in practice. - # Please note that even though each of the canonical scopes is enough for a - # request to be accepted and passed to the backend, a request can still fail - # due to the backend requiring additional scopes or permissions. + # there are scopes defined for "Read-only access to Google Calendar" and "Access + # to Cloud Platform". Users can consent to a scope for an application, giving it + # permission to access that data on their behalf. OAuth scope specifications + # should be fairly coarse grained; a user will need to see and understand the + # text description of what your scope means. In most cases: use one or at most + # two OAuth scopes for an entire family of products. If your product has + # multiple APIs, you should probably be sharing the OAuth scope across all of + # those APIs. When you need finer grained OAuth consent screens: talk with your + # product management about how developers will use them in practice. Please note + # that even though each of the canonical scopes is enough for a request to be + # accepted and passed to the backend, a request can still fail due to the + # backend requiring additional scopes or permissions. # Corresponds to the JSON property `oauth` # @return [Google::Apis::ServiceconsumermanagementV1beta1::OAuthRequirements] attr_accessor :oauth @@ -319,8 +274,8 @@ module Google # @return [Array] attr_accessor :requirements - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -342,8 +297,8 @@ module Google class Backend include Google::Apis::Core::Hashable - # A list of API backend rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of API backend rules that apply to individual API methods. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -362,21 +317,13 @@ module Google class BackendRule include Google::Apis::Core::Hashable - # The address of the API backend. - # The scheme is used to determine the backend protocol and security. - # The following schemes are accepted: - # SCHEME PROTOCOL SECURITY - # http:// HTTP None - # https:// HTTP TLS - # grpc:// gRPC None - # grpcs:// gRPC TLS - # It is recommended to explicitly include a scheme. Leaving out the scheme - # may cause constrasting behaviors across platforms. - # If the port is unspecified, the default is: - # - 80 for schemes without TLS - # - 443 for schemes with TLS - # For HTTP backends, use protocol - # to specify the protocol version. + # The address of the API backend. The scheme is used to determine the backend + # protocol and security. The following schemes are accepted: SCHEME PROTOCOL + # SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC + # TLS It is recommended to explicitly include a scheme. Leaving out the scheme + # may cause constrasting behaviors across platforms. If the port is unspecified, + # the default is: - 80 for schemes without TLS - 443 for schemes with TLS For + # HTTP backends, use protocol to specify the protocol version. # Corresponds to the JSON property `address` # @return [String] attr_accessor :address @@ -387,18 +334,18 @@ module Google # @return [Float] attr_accessor :deadline - # When disable_auth is true, a JWT ID token won't be generated and the - # original "Authorization" HTTP header will be preserved. If the header is - # used to carry the original token and is expected by the backend, this - # field must be set to true to preserve the header. + # When disable_auth is true, a JWT ID token won't be generated and the original " + # Authorization" HTTP header will be preserved. If the header is used to carry + # the original token and is expected by the backend, this field must be set to + # true to preserve the header. # Corresponds to the JSON property `disableAuth` # @return [Boolean] attr_accessor :disable_auth alias_method :disable_auth?, :disable_auth - # The JWT audience is used when generating a JWT ID token for the backend. - # This ID token will be added in the HTTP "authorization" header, and sent - # to the backend. + # The JWT audience is used when generating a JWT ID token for the backend. This + # ID token will be added in the HTTP "authorization" header, and sent to the + # backend. # Corresponds to the JSON property `jwtAudience` # @return [String] attr_accessor :jwt_audience @@ -409,8 +356,8 @@ module Google # @return [Float] attr_accessor :min_deadline - # The number of seconds to wait for the completion of a long running - # operation. The default is no deadline. + # The number of seconds to wait for the completion of a long running operation. + # The default is no deadline. # Corresponds to the JSON property `operationDeadline` # @return [Float] attr_accessor :operation_deadline @@ -420,29 +367,21 @@ module Google # @return [String] attr_accessor :path_translation - # The protocol used for sending a request to the backend. - # The supported values are "http/1.1" and "h2". - # The default value is inferred from the scheme in the - # address field: - # SCHEME PROTOCOL - # http:// http/1.1 - # https:// http/1.1 - # grpc:// h2 - # grpcs:// h2 - # For secure HTTP backends (https://) that support HTTP/2, set this field - # to "h2" for improved performance. - # Configuring this field to non-default values is only supported for secure - # HTTP backends. This field will be ignored for all other backends. - # See - # https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype- - # values.xhtml#alpn-protocol-ids - # for more details on the supported values. + # The protocol used for sending a request to the backend. The supported values + # are "http/1.1" and "h2". The default value is inferred from the scheme in the + # address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 + # grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this + # field to "h2" for improved performance. Configuring this field to non-default + # values is only supported for secure HTTP backends. This field will be ignored + # for all other backends. See https://www.iana.org/assignments/tls-extensiontype- + # values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on + # the supported values. # Corresponds to the JSON property `protocol` # @return [String] attr_accessor :protocol - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -465,42 +404,28 @@ module Google end end - # Billing related configuration of the service. - # The following example shows how to configure monitored resources and metrics - # for billing, `consumer_destinations` is the only supported destination and - # the monitored resources need at least one label key - # `cloud.googleapis.com/location` to indicate the location of the billing - # usage, using different monitored resources between monitoring and billing is - # recommended so they can be evolved independently: - # monitored_resources: - # - type: library.googleapis.com/billing_branch - # labels: - # - key: cloud.googleapis.com/location - # description: | - # Predefined label to support billing location restriction. - # - key: city - # description: | - # Custom label to define the city where the library branch is located - # in. - # - key: name - # description: Custom label to define the name of the library branch. - # metrics: - # - name: library.googleapis.com/book/borrowed_count - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # billing: - # consumer_destinations: - # - monitored_resource: library.googleapis.com/billing_branch - # metrics: - # - library.googleapis.com/book/borrowed_count + # Billing related configuration of the service. The following example shows how + # to configure monitored resources and metrics for billing, ` + # consumer_destinations` is the only supported destination and the monitored + # resources need at least one label key `cloud.googleapis.com/location` to + # indicate the location of the billing usage, using different monitored + # resources between monitoring and billing is recommended so they can be evolved + # independently: monitored_resources: - type: library.googleapis.com/ + # billing_branch labels: - key: cloud.googleapis.com/location description: | + # Predefined label to support billing location restriction. - key: city + # description: | Custom label to define the city where the library branch is + # located in. - key: name description: Custom label to define the name of the + # library branch. metrics: - name: library.googleapis.com/book/borrowed_count + # metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: + # - monitored_resource: library.googleapis.com/billing_branch metrics: - library. + # googleapis.com/book/borrowed_count class Billing include Google::Apis::Core::Hashable - # Billing configurations for sending metrics to the consumer project. - # There can be multiple consumer destinations per service, each one must have - # a different monitored resource type. A metric can be used in at most - # one consumer destination. + # Billing configurations for sending metrics to the consumer project. There can + # be multiple consumer destinations per service, each one must have a different + # monitored resource type. A metric can be used in at most one consumer + # destination. # Corresponds to the JSON property `consumerDestinations` # @return [Array] attr_accessor :consumer_destinations @@ -515,19 +440,19 @@ module Google end end - # Configuration of a specific billing destination (Currently only support - # bill against consumer project). + # Configuration of a specific billing destination (Currently only support bill + # against consumer project). class BillingDestination include Google::Apis::Core::Hashable - # Names of the metrics to report to this billing destination. - # Each name must be defined in Service.metrics section. + # Names of the metrics to report to this billing destination. Each name must be + # defined in Service.metrics section. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics - # The monitored resource type. The type must be defined in - # Service.monitored_resources section. + # The monitored resource type. The type must be defined in Service. + # monitored_resources section. # Corresponds to the JSON property `monitoredResource` # @return [String] attr_accessor :monitored_resource @@ -543,39 +468,24 @@ module Google end end - # `Context` defines which contexts an API requests. - # Example: - # context: - # rules: - # - selector: "*" - # requested: - # - google.rpc.context.ProjectContext - # - google.rpc.context.OriginContext - # The above specifies that all methods in the API request - # `google.rpc.context.ProjectContext` and - # `google.rpc.context.OriginContext`. - # Available context types are defined in package - # `google.rpc.context`. - # This also provides mechanism to whitelist any protobuf message extension that - # can be sent in grpc metadata using “x-goog-ext--bin” and - # “x-goog-ext--jspb” format. For example, list any service - # specific protobuf types that can appear in grpc metadata as follows in your - # yaml file: - # Example: - # context: - # rules: - # - selector: "google.example.library.v1.LibraryService.CreateBook" - # allowed_request_extensions: - # - google.foo.v1.NewExtension - # allowed_response_extensions: - # - google.foo.v1.NewExtension - # You can also specify extension ID instead of fully qualified extension name - # here. + # `Context` defines which contexts an API requests. Example: context: rules: - + # selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc. + # context.OriginContext The above specifies that all methods in the API request ` + # google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. + # Available context types are defined in package `google.rpc.context`. This also + # provides mechanism to whitelist any protobuf message extension that can be + # sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. + # For example, list any service specific protobuf types that can appear in grpc + # metadata as follows in your yaml file: Example: context: rules: - selector: " + # google.example.library.v1.LibraryService.CreateBook" + # allowed_request_extensions: - google.foo.v1.NewExtension + # allowed_response_extensions: - google.foo.v1.NewExtension You can also specify + # extension ID instead of fully qualified extension name here. class Context include Google::Apis::Core::Hashable - # A list of RPC context rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of RPC context rules that apply to individual API methods. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -595,14 +505,14 @@ module Google class ContextRule include Google::Apis::Core::Hashable - # A list of full type names or extension IDs of extensions allowed in grpc - # side channel from client to backend. + # A list of full type names or extension IDs of extensions allowed in grpc side + # channel from client to backend. # Corresponds to the JSON property `allowedRequestExtensions` # @return [Array] attr_accessor :allowed_request_extensions - # A list of full type names or extension IDs of extensions allowed in grpc - # side channel from backend to client. + # A list of full type names or extension IDs of extensions allowed in grpc side + # channel from backend to client. # Corresponds to the JSON property `allowedResponseExtensions` # @return [Array] attr_accessor :allowed_response_extensions @@ -617,8 +527,8 @@ module Google # @return [Array] attr_accessor :requested - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -637,14 +547,14 @@ module Google end end - # Selects and configures the service controller used by the service. The - # service controller handles features like abuse, quota, billing, logging, - # monitoring, etc. + # Selects and configures the service controller used by the service. The service + # controller handles features like abuse, quota, billing, logging, monitoring, + # etc. class Control include Google::Apis::Core::Hashable - # The service control environment to use. If empty, no control plane - # feature (like quota and billing) will be enabled. + # The service control environment to use. If empty, no control plane feature ( + # like quota and billing) will be enabled. # Corresponds to the JSON property `environment` # @return [String] attr_accessor :environment @@ -659,19 +569,15 @@ module Google end end - # Customize service error responses. For example, list any service - # specific protobuf types that can appear in error detail lists of - # error responses. - # Example: - # custom_error: - # types: - # - google.foo.v1.CustomError - # - google.foo.v1.AnotherError + # Customize service error responses. For example, list any service specific + # protobuf types that can appear in error detail lists of error responses. + # Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1. + # AnotherError class CustomError include Google::Apis::Core::Hashable - # The list of custom error rules that apply to individual API messages. - # **NOTE:** All service configuration rules follow "last one wins" order. + # The list of custom error rules that apply to individual API messages. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -696,15 +602,15 @@ module Google class CustomErrorRule include Google::Apis::Core::Hashable - # Mark this message as possible payload in error response. Otherwise, - # objects of this type will be filtered when they appear in error payload. + # Mark this message as possible payload in error response. Otherwise, objects of + # this type will be filtered when they appear in error payload. # Corresponds to the JSON property `isErrorType` # @return [Boolean] attr_accessor :is_error_type alias_method :is_error_type?, :is_error_type - # Selects messages to which this rule applies. - # Refer to selector for syntax details. + # Selects messages to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -745,56 +651,32 @@ module Google end end - # `Documentation` provides the information for describing a service. - # Example: - # 
documentation:
-      # summary: >
-      # The Google Calendar API gives access
-      # to most calendar features.
-      # pages:
-      # - name: Overview
-      # content: (== include google/foo/overview.md ==)
-      # - name: Tutorial
-      # content: (== include google/foo/tutorial.md ==)
-      # subpages;
-      # - name: Java
-      # content: (== include google/foo/tutorial_java.md ==)
-      # rules:
-      # - selector: google.calendar.Calendar.Get
-      # description: >
-      # ...
-      # - selector: google.calendar.Calendar.Put
-      # description: >
-      # ...
-      #
- # Documentation is provided in markdown syntax. In addition to - # standard markdown features, definition lists, tables and fenced - # code blocks are supported. Section headers can be provided and are - # interpreted relative to the section nesting of the context where - # a documentation fragment is embedded. - # Documentation from the IDL is merged with documentation defined - # via the config at normalization time, where documentation provided - # by config rules overrides IDL provided. - # A number of constructs specific to the API platform are supported - # in documentation text. - # In order to reference a proto element, the following - # notation can be used: - # 
[fully.qualified.proto.name][]
- # To override the display text used for the link, this can be used: - # 
[display text][fully.qualified.proto.name]
- # Text can be excluded from doc using the following notation: - # 
(-- internal comment --)
- # A few directives are available in documentation. Note that - # directives must appear on a single line to be properly - # identified. The `include` directive includes a markdown file from - # an external source: - # 
(== include path/to/file ==)
- # The `resource_for` directive marks a message to be the resource of - # a collection in REST view. If it is not specified, tools attempt - # to infer the resource from the operations in a collection: - # 
(== resource_for v1.shelves.books ==)
- # The directive `suppress_warning` does not directly affect documentation - # and is documented together with service config validation. + # `Documentation` provides the information for describing a service. Example: + # documentation: summary: > The Google Calendar API gives access to most + # calendar features. pages: - name: Overview content: (== include google/foo/ + # overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md == + # ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==) + # rules: - selector: google.calendar.Calendar.Get description: > ... - selector: + # google.calendar.Calendar.Put description: > ... Documentation is provided in + # markdown syntax. In addition to standard markdown features, definition lists, + # tables and fenced code blocks are supported. Section headers can be provided + # and are interpreted relative to the section nesting of the context where a + # documentation fragment is embedded. Documentation from the IDL is merged with + # documentation defined via the config at normalization time, where + # documentation provided by config rules overrides IDL provided. A number of + # constructs specific to the API platform are supported in documentation text. + # In order to reference a proto element, the following notation can be used: [ + # fully.qualified.proto.name][] To override the display text used for the link, + # this can be used: [display text][fully.qualified.proto.name] Text can be + # excluded from doc using the following notation: (-- internal comment --) A few + # directives are available in documentation. Note that directives must appear on + # a single line to be properly identified. The `include` directive includes a + # markdown file from an external source: (== include path/to/file ==) The ` + # resource_for` directive marks a message to be the resource of a collection in + # REST view. If it is not specified, tools attempt to infer the resource from + # the operations in a collection: (== resource_for v1.shelves.books ==) The + # directive `suppress_warning` does not directly affect documentation and is + # documented together with service config validation. class Documentation include Google::Apis::Core::Hashable @@ -803,19 +685,11 @@ module Google # @return [String] attr_accessor :documentation_root_url - # Declares a single overview page. For example: - # 
documentation:
-        # summary: ...
-        # overview: (== include overview.md ==)
-        #
- # This is a shortcut for the following declaration (using pages style): - # 
documentation:
-        # summary: ...
-        # pages:
-        # - name: Overview
-        # content: (== include overview.md ==)
-        #
- # Note: you cannot specify both `overview` field and `pages` field. + # Declares a single overview page. For example: documentation: summary: ... + # overview: (== include overview.md ==) This is a shortcut for the following + # declaration (using pages style): documentation: summary: ... pages: - name: + # Overview content: (== include overview.md ==) Note: you cannot specify both ` + # overview` field and `pages` field. # Corresponds to the JSON property `overview` # @return [String] attr_accessor :overview @@ -825,22 +699,20 @@ module Google # @return [Array] attr_accessor :pages - # A list of documentation rules that apply to individual API elements. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of documentation rules that apply to individual API elements. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules - # Specifies the service root url if the default one (the service name - # from the yaml file) is not suitable. This can be seen in any fully - # specified service urls as well as sections that show a base that other - # urls are relative to. + # Specifies the service root url if the default one (the service name from the + # yaml file) is not suitable. This can be seen in any fully specified service + # urls as well as sections that show a base that other urls are relative to. # Corresponds to the JSON property `serviceRootUrl` # @return [String] attr_accessor :service_root_url - # A short summary of what the service does. Can only be provided by - # plain text. + # A short summary of what the service does. Can only be provided by plain text. # Corresponds to the JSON property `summary` # @return [String] attr_accessor :summary @@ -864,8 +736,8 @@ module Google class DocumentationRule include Google::Apis::Core::Hashable - # Deprecation description of the selected element(s). It can be provided if - # an element is marked as `deprecated`. + # Deprecation description of the selected element(s). It can be provided if an + # element is marked as `deprecated`. # Corresponds to the JSON property `deprecationDescription` # @return [String] attr_accessor :deprecation_description @@ -897,13 +769,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 @@ -916,35 +786,28 @@ module Google end end - # `Endpoint` describes a network endpoint that serves a set of APIs. - # A service may expose any number of endpoints, and all endpoints share the - # same service configuration, such as quota configuration and monitoring - # configuration. - # Example service configuration: - # name: library-example.googleapis.com - # endpoints: - # # Below entry makes 'google.example.library.v1.Library' - # # API be served from endpoint address library-example.googleapis.com. - # # It also allows HTTP OPTIONS calls to be passed to the backend, for - # # it to decide whether the subsequent cross-origin request is - # # allowed to proceed. - # - name: library-example.googleapis.com - # allow_cors: true + # `Endpoint` describes a network endpoint that serves a set of APIs. A service + # may expose any number of endpoints, and all endpoints share the same service + # configuration, such as quota configuration and monitoring configuration. + # Example service configuration: name: library-example.googleapis.com endpoints: + # # Below entry makes 'google.example.library.v1.Library' # API be served from + # endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS + # calls to be passed to the backend, for # it to decide whether the subsequent + # cross-origin request is # allowed to proceed. - name: library-example. + # googleapis.com allow_cors: true class Endpoint include Google::Apis::Core::Hashable # DEPRECATED: This field is no longer supported. Instead of using aliases, - # please specify multiple google.api.Endpoint for each of the intended - # aliases. + # please specify multiple google.api.Endpoint for each of the intended aliases. # Additional names that this endpoint will be hosted on. # Corresponds to the JSON property `aliases` # @return [Array] attr_accessor :aliases - # Allowing - # [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka - # cross-domain traffic, would allow the backends served from this endpoint to - # receive and respond to HTTP OPTIONS requests. The response will be used by + # Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), + # aka cross-domain traffic, would allow the backends served from this endpoint + # to receive and respond to HTTP OPTIONS requests. The response will be used by # the browser to determine whether the subsequent cross-origin request is # allowed to proceed. # Corresponds to the JSON property `allowCors` @@ -958,10 +821,9 @@ module Google attr_accessor :name # The specification of an Internet routable address of API frontend that will - # handle requests to this [API - # Endpoint](https://cloud.google.com/apis/design/glossary). It should be - # either a valid IPv4 address or a fully-qualified domain name. For example, - # "8.8.8.8" or "myservice.appspot.com". + # handle requests to this [API Endpoint](https://cloud.google.com/apis/design/ + # glossary). It should be either a valid IPv4 address or a fully-qualified + # domain name. For example, "8.8.8.8" or "myservice.appspot.com". # Corresponds to the JSON property `target` # @return [String] attr_accessor :target @@ -998,8 +860,8 @@ module Google # @return [Array] attr_accessor :options - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. # Corresponds to the JSON property `sourceContext` # @return [Google::Apis::ServiceconsumermanagementV1beta1::SourceContext] attr_accessor :source_context @@ -1088,8 +950,8 @@ module Google # @return [Fixnum] attr_accessor :number - # The index of the field type in `Type.oneofs`, for message or enumeration - # types. The first type has index 1; zero means the type is not in the list. + # The index of the field type in `Type.oneofs`, for message or enumeration types. + # The first type has index 1; zero means the type is not in the list. # Corresponds to the JSON property `oneofIndex` # @return [Fixnum] attr_accessor :oneof_index @@ -1105,8 +967,8 @@ module Google attr_accessor :packed alias_method :packed?, :packed - # The field type URL, without the scheme, for message or enumeration - # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + # The field type URL, without the scheme, for message or enumeration types. + # Example: `"type.googleapis.com/google.protobuf.Timestamp"`. # Corresponds to the JSON property `typeUrl` # @return [String] attr_accessor :type_url @@ -1131,23 +993,22 @@ module Google end # Defines the HTTP configuration for an API service. It contains a list of - # HttpRule, each specifying the mapping of an RPC method - # to one or more HTTP REST API methods. + # HttpRule, each specifying the mapping of an RPC method to one or more HTTP + # REST API methods. class Http include Google::Apis::Core::Hashable # When set to true, URL path parameters will be fully URI-decoded except in # cases of single segment matches in reserved expansion, where "%2F" will be - # left encoded. - # The default behavior is to not decode RFC 6570 reserved characters in multi - # segment matches. + # left encoded. The default behavior is to not decode RFC 6570 reserved + # characters in multi segment matches. # Corresponds to the JSON property `fullyDecodeReservedExpansion` # @return [Boolean] attr_accessor :fully_decode_reserved_expansion alias_method :fully_decode_reserved_expansion?, :fully_decode_reserved_expansion - # A list of HTTP configuration rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of HTTP configuration rules that apply to individual API methods. ** + # NOTE:** All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -1163,251 +1024,156 @@ module Google end end - # # gRPC Transcoding - # gRPC Transcoding is a feature for mapping between a gRPC method and one or - # more HTTP REST endpoints. It allows developers to build a single API service - # that supports both gRPC APIs and REST APIs. Many systems, including [Google - # APIs](https://github.com/googleapis/googleapis), - # [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC - # Gateway](https://github.com/grpc-ecosystem/grpc-gateway), - # and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature - # and use it for large scale production services. - # `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies - # how different portions of the gRPC request message are mapped to the URL - # path, URL query parameters, and HTTP request body. It also controls how the - # gRPC response message is mapped to the HTTP response body. `HttpRule` is + # # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC + # method and one or more HTTP REST endpoints. It allows developers to build a + # single API service that supports both gRPC APIs and REST APIs. Many systems, + # including [Google APIs](https://github.com/googleapis/googleapis), [Cloud + # Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github. + # com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/ + # envoy) proxy support this feature and use it for large scale production + # services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping + # specifies how different portions of the gRPC request message are mapped to the + # URL path, URL query parameters, and HTTP request body. It also controls how + # the gRPC response message is mapped to the HTTP response body. `HttpRule` is # typically specified as an `google.api.http` annotation on the gRPC method. # Each mapping specifies a URL path template and an HTTP method. The path # template may refer to one or more fields in the gRPC request message, as long - # as each field is a non-repeated field with a primitive (non-message) type. - # The path template controls how fields of the request message are mapped to - # the URL path. - # Example: - # service Messaging ` - # rpc GetMessage(GetMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # get: "/v1/`name=messages/*`" - # `; - # ` - # ` - # message GetMessageRequest ` - # string name = 1; // Mapped to URL path. - # ` - # message Message ` - # string text = 1; // The resource content. - # ` - # This enables an HTTP REST to gRPC mapping as below: - # HTTP | gRPC - # -----|----- - # `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` - # Any fields in the request message which are not bound by the path template - # automatically become HTTP query parameters if there is no HTTP request body. - # For example: - # service Messaging ` - # rpc GetMessage(GetMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # get:"/v1/messages/`message_id`" - # `; - # ` - # ` - # message GetMessageRequest ` - # message SubMessage ` - # string subfield = 1; - # ` - # string message_id = 1; // Mapped to URL path. - # int64 revision = 2; // Mapped to URL query parameter `revision`. - # SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. - # ` - # This enables a HTTP JSON to RPC mapping as below: - # HTTP | gRPC - # -----|----- - # `GET /v1/messages/123456?revision=2&sub.subfield=foo` | - # `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: - # "foo"))` - # Note that fields which are mapped to URL query parameters must have a - # primitive type or a repeated primitive type or a non-repeated message type. - # In the case of a repeated type, the parameter can be repeated in the URL - # as `...?param=A¶m=B`. In the case of a message type, each field of the - # message is mapped to a separate parameter, such as - # `...?foo.a=A&foo.b=B&foo.c=C`. - # For HTTP methods that allow a request body, the `body` field - # specifies the mapping. Consider a REST update method on the - # message resource collection: - # service Messaging ` - # rpc UpdateMessage(UpdateMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # patch: "/v1/messages/`message_id`" - # body: "message" - # `; - # ` - # ` - # message UpdateMessageRequest ` - # string message_id = 1; // mapped to the URL - # Message message = 2; // mapped to the body - # ` - # The following HTTP JSON to RPC mapping is enabled, where the - # representation of the JSON in the request body is determined by - # protos JSON encoding: - # HTTP | gRPC - # -----|----- - # `PATCH /v1/messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: - # "123456" message ` text: "Hi!" `)` - # The special name `*` can be used in the body mapping to define that - # every field not bound by the path template should be mapped to the - # request body. This enables the following alternative definition of - # the update method: - # service Messaging ` - # rpc UpdateMessage(Message) returns (Message) ` - # option (google.api.http) = ` - # patch: "/v1/messages/`message_id`" - # body: "*" - # `; - # ` - # ` - # message Message ` - # string message_id = 1; - # string text = 2; - # ` - # The following HTTP JSON to RPC mapping is enabled: - # HTTP | gRPC - # -----|----- - # `PATCH /v1/messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: - # "123456" text: "Hi!")` - # Note that when using `*` in the body mapping, it is not possible to - # have HTTP parameters, as all fields not bound by the path end in - # the body. This makes this option more rarely used in practice when - # defining REST APIs. The common usage of `*` is in custom methods - # which don't use the URL at all for transferring data. - # It is possible to define multiple HTTP methods for one RPC by using - # the `additional_bindings` option. Example: - # service Messaging ` - # rpc GetMessage(GetMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # get: "/v1/messages/`message_id`" - # additional_bindings ` - # get: "/v1/users/`user_id`/messages/`message_id`" - # ` - # `; - # ` - # ` - # message GetMessageRequest ` - # string message_id = 1; - # string user_id = 2; - # ` - # This enables the following two alternative HTTP JSON to RPC mappings: - # HTTP | gRPC - # -----|----- - # `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` - # `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: - # "123456")` - # ## Rules for HTTP mapping - # 1. Leaf request fields (recursive expansion nested messages in the request - # message) are classified into three categories: - # - Fields referred by the path template. They are passed via the URL path. - # - Fields referred by the HttpRule.body. They are passed via the HTTP - # request body. - # - All other fields are passed via the URL query parameters, and the - # parameter name is the field path in the request message. A repeated - # field can be represented as multiple query parameters under the same - # name. - # 2. If HttpRule.body is "*", there is no URL query parameter, all fields - # are passed via URL path and HTTP request body. - # 3. If HttpRule.body is omitted, there is no HTTP request body, all - # fields are passed via URL path and URL query parameters. - # ### Path template syntax - # Template = "/" Segments [ Verb ] ; - # Segments = Segment ` "/" Segment ` ; - # Segment = "*" | "**" | LITERAL | Variable ; - # Variable = "`" FieldPath [ "=" Segments ] "`" ; - # FieldPath = IDENT ` "." IDENT ` ; - # Verb = ":" LITERAL ; - # The syntax `*` matches a single URL path segment. The syntax `**` matches - # zero or more URL path segments, which must be the last part of the URL path - # except the `Verb`. - # The syntax `Variable` matches part of the URL path as specified by its - # template. A variable template must not contain other variables. If a variable - # matches a single path segment, its template may be omitted, e.g. ``var`` - # is equivalent to ``var=*``. - # The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` - # contains any reserved character, such characters should be percent-encoded - # before the matching. - # If a variable contains exactly one path segment, such as `"`var`"` or - # `"`var=*`"`, when such a variable is expanded into a URL path on the client - # side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The - # server side does the reverse decoding. Such variables show up in the - # [Discovery - # Document](https://developers.google.com/discovery/v1/reference/apis) as - # ``var``. - # If a variable contains multiple path segments, such as `"`var=foo/*`"` - # or `"`var=**`"`, when such a variable is expanded into a URL path on the - # client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. - # The server side does the reverse decoding, except "%2F" and "%2f" are left - # unchanged. Such variables show up in the - # [Discovery - # Document](https://developers.google.com/discovery/v1/reference/apis) as - # ``+var``. - # ## Using gRPC API Service Configuration - # gRPC API Service Configuration (service config) is a configuration language - # for configuring a gRPC service to become a user-facing product. The - # service config is simply the YAML representation of the `google.api.Service` - # proto message. + # as each field is a non-repeated field with a primitive (non-message) type. The + # path template controls how fields of the request message are mapped to the URL + # path. Example: service Messaging ` rpc GetMessage(GetMessageRequest) returns ( + # Message) ` option (google.api.http) = ` get: "/v1/`name=messages/*`" `; ` ` + # message GetMessageRequest ` string name = 1; // Mapped to URL path. ` message + # Message ` string text = 1; // The resource content. ` This enables an HTTP + # REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/ + # 123456` | `GetMessage(name: "messages/123456")` Any fields in the request + # message which are not bound by the path template automatically become HTTP + # query parameters if there is no HTTP request body. For example: service + # Messaging ` rpc GetMessage(GetMessageRequest) returns (Message) ` option ( + # google.api.http) = ` get:"/v1/messages/`message_id`" `; ` ` message + # GetMessageRequest ` message SubMessage ` string subfield = 1; ` string + # message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL + # query parameter `revision`. SubMessage sub = 3; // Mapped to URL query + # parameter `sub.subfield`. ` This enables a HTTP JSON to RPC mapping as below: + # HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | + # `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo")) + # ` Note that fields which are mapped to URL query parameters must have a + # primitive type or a repeated primitive type or a non-repeated message type. In + # the case of a repeated type, the parameter can be repeated in the URL as `...? + # param=A¶m=B`. In the case of a message type, each field of the message is + # mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For + # HTTP methods that allow a request body, the `body` field specifies the mapping. + # Consider a REST update method on the message resource collection: service + # Messaging ` rpc UpdateMessage(UpdateMessageRequest) returns (Message) ` option + # (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "message" `; ` ` + # message UpdateMessageRequest ` string message_id = 1; // mapped to the URL + # Message message = 2; // mapped to the body ` The following HTTP JSON to RPC + # mapping is enabled, where the representation of the JSON in the request body + # is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/ + # messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456" + # message ` text: "Hi!" `)` The special name `*` can be used in the body mapping + # to define that every field not bound by the path template should be mapped to + # the request body. This enables the following alternative definition of the + # update method: service Messaging ` rpc UpdateMessage(Message) returns (Message) + # ` option (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "*" `; + # ` ` message Message ` string message_id = 1; string text = 2; ` The following + # HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/ + # messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456" text: + # "Hi!")` Note that when using `*` in the body mapping, it is not possible to + # have HTTP parameters, as all fields not bound by the path end in the body. + # This makes this option more rarely used in practice when defining REST APIs. + # The common usage of `*` is in custom methods which don't use the URL at all + # for transferring data. It is possible to define multiple HTTP methods for one + # RPC by using the `additional_bindings` option. Example: service Messaging ` + # rpc GetMessage(GetMessageRequest) returns (Message) ` option (google.api.http) + # = ` get: "/v1/messages/`message_id`" additional_bindings ` get: "/v1/users/` + # user_id`/messages/`message_id`" ` `; ` ` message GetMessageRequest ` string + # message_id = 1; string user_id = 2; ` This enables the following two + # alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/ + # messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/ + # messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules + # for HTTP mapping 1. Leaf request fields (recursive expansion nested messages + # in the request message) are classified into three categories: - Fields + # referred by the path template. They are passed via the URL path. - Fields + # referred by the HttpRule.body. They are passed via the HTTP request body. - + # All other fields are passed via the URL query parameters, and the parameter + # name is the field path in the request message. A repeated field can be + # represented as multiple query parameters under the same name. 2. If HttpRule. + # body is "*", there is no URL query parameter, all fields are passed via URL + # path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP + # request body, all fields are passed via URL path and URL query parameters. ### + # Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment ` "/ + # " Segment ` ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "`" + # FieldPath [ "=" Segments ] "`" ; FieldPath = IDENT ` "." IDENT ` ; Verb = ":" + # LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` + # matches zero or more URL path segments, which must be the last part of the URL + # path except the `Verb`. The syntax `Variable` matches part of the URL path as + # specified by its template. A variable template must not contain other + # variables. If a variable matches a single path segment, its template may be + # omitted, e.g. ``var`` is equivalent to ``var=*``. The syntax `LITERAL` matches + # literal text in the URL path. If the `LITERAL` contains any reserved character, + # such characters should be percent-encoded before the matching. If a variable + # contains exactly one path segment, such as `"`var`"` or `"`var=*`"`, when such + # a variable is expanded into a URL path on the client side, all characters + # except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse + # decoding. Such variables show up in the [Discovery Document](https:// + # developers.google.com/discovery/v1/reference/apis) as ``var``. If a variable + # contains multiple path segments, such as `"`var=foo/*`"` or `"`var=**`"`, when + # such a variable is expanded into a URL path on the client side, all characters + # except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the + # reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables + # show up in the [Discovery Document](https://developers.google.com/discovery/v1/ + # reference/apis) as ``+var``. ## Using gRPC API Service Configuration gRPC API + # Service Configuration (service config) is a configuration language for + # configuring a gRPC service to become a user-facing product. The service config + # is simply the YAML representation of the `google.api.Service` proto message. # As an alternative to annotating your proto file, you can configure gRPC - # transcoding in your service config YAML files. You do this by specifying a - # `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same - # effect as the proto annotation. This can be particularly useful if you - # have a proto that is reused in multiple services. Note that any transcoding - # specified in the service config will override any matching transcoding - # configuration in the proto. - # Example: - # http: - # rules: - # # Selects a gRPC method and applies HttpRule to it. - # - selector: example.v1.Messaging.GetMessage - # get: /v1/messages/`message_id`/`sub.subfield` - # ## Special notes - # When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the - # proto to JSON conversion must follow the [proto3 - # specification](https://developers.google.com/protocol-buffers/docs/proto3#json) - # . - # While the single segment variable follows the semantics of - # [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String - # Expansion, the multi segment variable **does not** follow RFC 6570 Section - # 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion - # does not expand special characters like `?` and `#`, which would lead - # to invalid URLs. As the result, gRPC Transcoding uses a custom encoding - # for multi segment variables. - # The path variables **must not** refer to any repeated or mapped field, - # because client libraries are not capable of handling such variable expansion. - # The path variables **must not** capture the leading "/" character. The reason - # is that the most common use case "`var`" does not capture the leading "/" - # character. For consistency, all path variables must share the same behavior. - # Repeated message fields must not be mapped to URL query parameters, because - # no client library can support such complicated mapping. - # If an API needs to use a JSON array for request or response body, it can map - # the request or response body to a repeated field. However, some gRPC - # Transcoding implementations may not support this feature. + # transcoding in your service config YAML files. You do this by specifying a ` + # HttpRule` that maps the gRPC method to a REST endpoint, achieving the same + # effect as the proto annotation. This can be particularly useful if you have a + # proto that is reused in multiple services. Note that any transcoding specified + # in the service config will override any matching transcoding configuration in + # the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule + # to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/` + # message_id`/`sub.subfield` ## Special notes When gRPC Transcoding is used to + # map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow + # the [proto3 specification](https://developers.google.com/protocol-buffers/docs/ + # proto3#json). While the single segment variable follows the semantics of [RFC + # 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String + # Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2. + # 3 Reserved Expansion. The reason is that the Reserved Expansion does not + # expand special characters like `?` and `#`, which would lead to invalid URLs. + # As the result, gRPC Transcoding uses a custom encoding for multi segment + # variables. The path variables **must not** refer to any repeated or mapped + # field, because client libraries are not capable of handling such variable + # expansion. The path variables **must not** capture the leading "/" character. + # The reason is that the most common use case "`var`" does not capture the + # leading "/" character. For consistency, all path variables must share the same + # behavior. Repeated message fields must not be mapped to URL query parameters, + # because no client library can support such complicated mapping. If an API + # needs to use a JSON array for request or response body, it can map the request + # or response body to a repeated field. However, some gRPC Transcoding + # implementations may not support this feature. class HttpRule include Google::Apis::Core::Hashable - # Additional HTTP bindings for the selector. Nested bindings must - # not contain an `additional_bindings` field themselves (that is, - # the nesting may only be one level deep). + # Additional HTTP bindings for the selector. Nested bindings must not contain an + # `additional_bindings` field themselves (that is, the nesting may only be one + # level deep). # Corresponds to the JSON property `additionalBindings` # @return [Array] attr_accessor :additional_bindings - # When this flag is set to true, HTTP requests will be allowed to invoke a - # half-duplex streaming method. + # When this flag is set to true, HTTP requests will be allowed to invoke a half- + # duplex streaming method. # Corresponds to the JSON property `allowHalfDuplex` # @return [Boolean] attr_accessor :allow_half_duplex alias_method :allow_half_duplex?, :allow_half_duplex - # The name of the request field whose value is mapped to the HTTP request - # body, or `*` for mapping all request fields not captured by the path - # pattern to the HTTP body, or omitted for not having any HTTP request body. - # NOTE: the referred field must be present at the top-level of the request - # message type. + # The name of the request field whose value is mapped to the HTTP request body, + # or `*` for mapping all request fields not captured by the path pattern to the + # HTTP body, or omitted for not having any HTTP request body. NOTE: the referred + # field must be present at the top-level of the request message type. # Corresponds to the JSON property `body` # @return [String] attr_accessor :body @@ -1422,8 +1188,7 @@ module Google # @return [String] attr_accessor :delete - # Maps to HTTP GET. Used for listing and getting information about - # resources. + # Maps to HTTP GET. Used for listing and getting information about resources. # Corresponds to the JSON property `get` # @return [String] attr_accessor :get @@ -1444,16 +1209,15 @@ module Google attr_accessor :put # Optional. The name of the response field whose value is mapped to the HTTP - # response body. When omitted, the entire response message will be used - # as the HTTP response body. - # NOTE: The referred field must be present at the top-level of the response - # message type. + # response body. When omitted, the entire response message will be used as the + # HTTP response body. NOTE: The referred field must be present at the top-level + # of the response message type. # Corresponds to the JSON property `responseBody` # @return [String] attr_accessor :response_body - # Selects a method to which this rule applies. - # Refer to selector for syntax details. + # Selects a method to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -1492,13 +1256,12 @@ module Google # @return [String] attr_accessor :query - # The value prefix. The value format is "value_prefix`token`" - # Only applies to "in" header type. Must be empty for "in" query type. - # If not empty, the header value has to match (case sensitive) this prefix. - # If not matched, JWT will not be extracted. If matched, JWT will be - # extracted after the prefix is removed. - # For example, for "Authorization: Bearer `JWT`", - # value_prefix="Bearer " with a space at the end. + # The value prefix. The value format is "value_prefix`token`" Only applies to " + # in" header type. Must be empty for "in" query type. If not empty, the header + # value has to match (case sensitive) this prefix. If not matched, JWT will not + # be extracted. If matched, JWT will be extracted after the prefix is removed. + # For example, for "Authorization: Bearer `JWT`", value_prefix="Bearer " with a + # space at the end. # Corresponds to the JSON property `valuePrefix` # @return [String] attr_accessor :value_prefix @@ -1546,39 +1309,35 @@ module Google end end - # A description of a log type. Example in YAML format: - # - name: library.googleapis.com/activity_history - # description: The history of borrowing and returning library items. - # display_name: Activity - # labels: - # - key: /customer_id + # A description of a log type. Example in YAML format: - name: library. + # googleapis.com/activity_history description: The history of borrowing and + # returning library items. display_name: Activity labels: - key: /customer_id # description: Identifier of a library customer class LogDescriptor include Google::Apis::Core::Hashable - # A human-readable description of this log. This information appears in - # the documentation and can contain details. + # A human-readable description of this log. This information appears in the + # documentation and can contain details. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # The human-readable name for this log. This information appears on - # the user interface and should be concise. + # The human-readable name for this log. This information appears on the user + # interface and should be concise. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # The set of labels that are available to describe a specific log entry. - # Runtime requests that contain labels not specified here are - # considered invalid. + # The set of labels that are available to describe a specific log entry. Runtime + # requests that contain labels not specified here are considered invalid. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels - # The name of the log. It must be less than 512 characters long and can - # include the following characters: upper- and lower-case alphanumeric - # characters [A-Za-z0-9], and punctuation characters including - # slash, underscore, hyphen, period [/_-.]. + # The name of the log. It must be less than 512 characters long and can include + # the following characters: upper- and lower-case alphanumeric characters [A-Za- + # z0-9], and punctuation characters including slash, underscore, hyphen, period [ + # /_-.]. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1596,48 +1355,30 @@ module Google end end - # Logging configuration of the service. - # The following example shows how to configure logs to be sent to the - # producer and consumer projects. In the example, the `activity_history` - # log is sent to both the producer and consumer projects, whereas the - # `purchase_history` log is only sent to the producer project. - # monitored_resources: - # - type: library.googleapis.com/branch - # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. - # logs: - # - name: activity_history - # labels: - # - key: /customer_id - # - name: purchase_history - # logging: - # producer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history - # - purchase_history - # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history + # Logging configuration of the service. The following example shows how to + # configure logs to be sent to the producer and consumer projects. In the + # example, the `activity_history` log is sent to both the producer and consumer + # projects, whereas the `purchase_history` log is only sent to the producer + # project. monitored_resources: - type: library.googleapis.com/branch labels: - + # key: /city description: The city where the library branch is located in. - key: + # /name description: The name of the branch. logs: - name: activity_history + # labels: - key: /customer_id - name: purchase_history logging: + # producer_destinations: - monitored_resource: library.googleapis.com/branch + # logs: - activity_history - purchase_history consumer_destinations: - + # monitored_resource: library.googleapis.com/branch logs: - activity_history class Logging include Google::Apis::Core::Hashable - # Logging configurations for sending logs to the consumer project. - # There can be multiple consumer destinations, each one must have a - # different monitored resource type. A log can be used in at most - # one consumer destination. + # Logging configurations for sending logs to the consumer project. There can be + # multiple consumer destinations, each one must have a different monitored + # resource type. A log can be used in at most one consumer destination. # Corresponds to the JSON property `consumerDestinations` # @return [Array] attr_accessor :consumer_destinations - # Logging configurations for sending logs to the producer project. - # There can be multiple producer destinations, each one must have a - # different monitored resource type. A log can be used in at most - # one producer destination. + # Logging configurations for sending logs to the producer project. There can be + # multiple producer destinations, each one must have a different monitored + # resource type. A log can be used in at most one producer destination. # Corresponds to the JSON property `producerDestinations` # @return [Array] attr_accessor :producer_destinations @@ -1653,21 +1394,20 @@ module Google end end - # Configuration of a specific logging destination (the producer project - # or the consumer project). + # Configuration of a specific logging destination (the producer project or the + # consumer project). class LoggingDestination include Google::Apis::Core::Hashable - # Names of the logs to be sent to this destination. Each name must - # be defined in the Service.logs section. If the log name is - # not a domain scoped name, it will be automatically prefixed with - # the service name followed by "/". + # Names of the logs to be sent to this destination. Each name must be defined in + # the Service.logs section. If the log name is not a domain scoped name, it will + # be automatically prefixed with the service name followed by "/". # Corresponds to the JSON property `logs` # @return [Array] attr_accessor :logs - # The monitored resource type. The type must be defined in the - # Service.monitored_resources section. + # The monitored resource type. The type must be defined in the Service. + # monitored_resources section. # Corresponds to the JSON property `monitoredResource` # @return [String] attr_accessor :monitored_resource @@ -1742,16 +1482,13 @@ module Google # Defines a metric type and its schema. Once a metric descriptor is created, # deleting or altering it stops data collection and makes the metric type's - # existing data unusable. - # The following are specific rules for service defined Monitoring metric - # descriptors: - # * `type`, `metric_kind`, `value_type` and `description` - # fields are all required. The `unit` field must be specified - # if the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. - # * Maximum of default 500 metric descriptors per service is allowed. - # * Maximum of default 10 labels per metric descriptor is allowed. - # The default maximum limit can be overridden. Please follow - # https://cloud.google.com/monitoring/quotas + # existing data unusable. The following are specific rules for service defined + # Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and ` + # description` fields are all required. The `unit` field must be specified if + # the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default + # 500 metric descriptors per service is allowed. * Maximum of default 10 labels + # per metric descriptor is allowed. The default maximum limit can be overridden. + # Please follow https://cloud.google.com/monitoring/quotas class MetricDescriptor include Google::Apis::Core::Hashable @@ -1760,26 +1497,21 @@ module Google # @return [String] attr_accessor :description - # A concise name for the metric, which can be displayed in user interfaces. - # Use sentence case without an ending period, for example "Request count". - # This field is optional but it is recommended to be set for any metrics - # associated with user-visible concepts, such as Quota. + # A concise name for the metric, which can be displayed in user interfaces. Use + # sentence case without an ending period, for example "Request count". This + # field is optional but it is recommended to be set for any metrics associated + # with user-visible concepts, such as Quota. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # The set of labels that can be used to describe a specific - # instance of this metric type. - # The label key name must follow: - # * Only upper and lower-case letters, digits and underscores (_) are - # allowed. - # * Label name must start with a letter or digit. - # * The maximum length of a label name is 100 characters. - # For example, the - # `appengine.googleapis.com/http/server/response_latencies` metric - # type has a label for the HTTP response code, `response_code`, so - # you can look at latencies for successful responses or just - # for responses that failed. + # The set of labels that can be used to describe a specific instance of this + # metric type. The label key name must follow: * Only upper and lower-case + # letters, digits and underscores (_) are allowed. * Label name must start with + # a letter or digit. * The maximum length of a label name is 100 characters. For + # example, the `appengine.googleapis.com/http/server/response_latencies` metric + # type has a label for the HTTP response code, `response_code`, so you can look + # at latencies for successful responses or just for responses that failed. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels @@ -1794,17 +1526,16 @@ module Google # @return [Google::Apis::ServiceconsumermanagementV1beta1::MetricDescriptorMetadata] attr_accessor :metadata - # Whether the metric records instantaneous values, changes to a value, etc. - # Some combinations of `metric_kind` and `value_type` might not be supported. + # Whether the metric records instantaneous values, changes to a value, etc. Some + # combinations of `metric_kind` and `value_type` might not be supported. # Corresponds to the JSON property `metricKind` # @return [String] attr_accessor :metric_kind - # Read-only. If present, then a time - # series, which is identified partially by - # a metric type and a MonitoredResourceDescriptor, that is associated - # with this metric type can only be associated with one of the monitored - # resource types listed here. + # Read-only. If present, then a time series, which is identified partially by a + # metric type and a MonitoredResourceDescriptor, that is associated with this + # metric type can only be associated with one of the monitored resource types + # listed here. # Corresponds to the JSON property `monitoredResourceTypes` # @return [Array] attr_accessor :monitored_resource_types @@ -1814,116 +1545,73 @@ module Google # @return [String] attr_accessor :name - # The metric type, including its DNS name prefix. The type is not - # URL-encoded. + # The metric type, including its DNS name prefix. The type is not URL-encoded. # All service defined metrics must be prefixed with the service name, in the - # format of ``service name`/`relative metric name``, such as - # `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric - # name must follow: + # format of ``service name`/`relative metric name``, such as `cloudsql. + # googleapis.com/database/cpu/utilization`. The relative metric name must follow: # * Only upper and lower-case letters, digits, '/' and underscores '_' are - # allowed. - # * The maximum number of characters allowed for the relative_metric_name is - # 100. - # All user-defined metric types have the DNS name - # `custom.googleapis.com`, `external.googleapis.com`, or - # `logging.googleapis.com/user/`. - # Metric types should use a natural hierarchical grouping. For example: - # "custom.googleapis.com/invoice/paid/amount" - # "external.googleapis.com/prometheus/up" - # "appengine.googleapis.com/http/server/response_latencies" + # allowed. * The maximum number of characters allowed for the + # relative_metric_name is 100. All user-defined metric types have the DNS name ` + # custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/ + # user/`. Metric types should use a natural hierarchical grouping. For example: " + # custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/ + # up" "appengine.googleapis.com/http/server/response_latencies" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # The units in which the metric value is reported. It is only applicable - # if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` - # defines the representation of the stored metric values. - # Different systems may scale the values to be more easily displayed (so a - # value of `0.02KBy` _might_ be displayed as `20By`, and a value of - # `3523KBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is - # `KBy`, then the value of the metric is always in thousands of bytes, no - # matter how it may be displayed.. - # If you want a custom metric to record the exact number of CPU-seconds used - # by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is - # `s`CPU`` (or equivalently `1s`CPU`` or just `s`). If the job uses 12,005 - # CPU-seconds, then the value is written as `12005`. - # Alternatively, if you want a custom metric to record data in a more - # granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is - # `ks`CPU``, and then write the value `12.005` (which is `12005/1000`), - # or use `Kis`CPU`` and write `11.723` (which is `12005/1024`). - # The supported units are a subset of [The Unified Code for Units of - # Measure](http://unitsofmeasure.org/ucum.html) standard: - # **Basic units (UNIT)** - # * `bit` bit - # * `By` byte - # * `s` second - # * `min` minute - # * `h` hour - # * `d` day - # * `1` dimensionless - # **Prefixes (PREFIX)** - # * `k` kilo (10^3) - # * `M` mega (10^6) - # * `G` giga (10^9) - # * `T` tera (10^12) - # * `P` peta (10^15) - # * `E` exa (10^18) - # * `Z` zetta (10^21) - # * `Y` yotta (10^24) - # * `m` milli (10^-3) - # * `u` micro (10^-6) - # * `n` nano (10^-9) - # * `p` pico (10^-12) - # * `f` femto (10^-15) - # * `a` atto (10^-18) - # * `z` zepto (10^-21) - # * `y` yocto (10^-24) - # * `Ki` kibi (2^10) - # * `Mi` mebi (2^20) - # * `Gi` gibi (2^30) - # * `Ti` tebi (2^40) - # * `Pi` pebi (2^50) - # **Grammar** - # The grammar also includes these connectors: - # * `/` division or ratio (as an infix operator). For examples, - # `kBy/`email`` or `MiBy/10ms` (although you should almost never - # have `/s` in a metric `unit`; rates should always be computed at - # query time from the underlying cumulative or delta value). - # * `.` multiplication or composition (as an infix operator). For - # examples, `GBy.d` or `k`watt`.h`. - # The grammar for a unit is as follows: - # Expression = Component ` "." Component ` ` "/" Component ` ; - # Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] - # | Annotation - # | "1" - # ; - # Annotation = "`" NAME "`" ; - # Notes: - # * `Annotation` is just a comment if it follows a `UNIT`. If the annotation - # is used alone, then the unit is equivalent to `1`. For examples, - # ``request`/s == 1/s`, `By`transmitted`/s == By/s`. - # * `NAME` is a sequence of non-blank printable ASCII characters not - # containing ``` or ```. - # * `1` represents a unitary [dimensionless - # unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such - # as in `1/s`. It is typically used when none of the basic units are - # appropriate. For example, "new users per day" can be represented as - # `1/d` or ``new-users`/d` (and a metric value `5` would mean "5 new - # users). Alternatively, "thousands of page views per day" would be - # represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric - # value of `5.3` would mean "5300 page views per day"). - # * `%` represents dimensionless value of 1/100, and annotates values giving - # a percentage (so the metric values are typically in the range of 0..100, - # and a metric value `3` means "3 percent"). - # * `10^2.%` indicates a metric contains a ratio, typically in the range - # 0..1, that will be multiplied by 100 and displayed as a percentage - # (so a metric value `0.03` means "3 percent"). + # The units in which the metric value is reported. It is only applicable if the ` + # value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the + # representation of the stored metric values. Different systems may scale the + # values to be more easily displayed (so a value of `0.02KBy` _might_ be + # displayed as `20By`, and a value of `3523KBy` _might_ be displayed as `3.5MBy`) + # . However, if the `unit` is `KBy`, then the value of the metric is always in + # thousands of bytes, no matter how it may be displayed.. If you want a custom + # metric to record the exact number of CPU-seconds used by a job, you can create + # an `INT64 CUMULATIVE` metric whose `unit` is `s`CPU`` (or equivalently `1s`CPU` + # ` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written + # as `12005`. Alternatively, if you want a custom metric to record data in a + # more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is + # `ks`CPU``, and then write the value `12.005` (which is `12005/1000`), or use ` + # Kis`CPU`` and write `11.723` (which is `12005/1024`). The supported units are + # a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ + # ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` + # second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes ( + # PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^ + # 12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^ + # 24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^- + # 12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto ( + # 10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi ( + # 2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these + # connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/ + # `email`` or `MiBy/10ms` (although you should almost never have `/s` in a + # metric `unit`; rates should always be computed at query time from the + # underlying cumulative or delta value). * `.` multiplication or composition (as + # an infix operator). For examples, `GBy.d` or `k`watt`.h`. The grammar for a + # unit is as follows: Expression = Component ` "." Component ` ` "/" Component ` + # ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; + # Annotation = "`" NAME "`" ; Notes: * `Annotation` is just a comment if it + # follows a `UNIT`. If the annotation is used alone, then the unit is equivalent + # to `1`. For examples, ``request`/s == 1/s`, `By`transmitted`/s == By/s`. * ` + # NAME` is a sequence of non-blank printable ASCII characters not containing ``` + # or ```. * `1` represents a unitary [dimensionless unit](https://en.wikipedia. + # org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used + # when none of the basic units are appropriate. For example, "new users per day" + # can be represented as `1/d` or ``new-users`/d` (and a metric value `5` would + # mean "5 new users). Alternatively, "thousands of page views per day" would be + # represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric value of ` + # 5.3` would mean "5300 page views per day"). * `%` represents dimensionless + # value of 1/100, and annotates values giving a percentage (so the metric values + # are typically in the range of 0..100, and a metric value `3` means "3 percent") + # . * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, + # that will be multiplied by 100 and displayed as a percentage (so a metric + # value `0.03` means "3 percent"). # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit - # Whether the measurement is an integer, a floating-point number, etc. - # Some combinations of `metric_kind` and `value_type` might not be supported. + # Whether the measurement is an integer, a floating-point number, etc. Some + # combinations of `metric_kind` and `value_type` might not be supported. # Corresponds to the JSON property `valueType` # @return [String] attr_accessor :value_type @@ -1952,9 +1640,9 @@ module Google class MetricDescriptorMetadata include Google::Apis::Core::Hashable - # The delay of data points caused by ingestion. Data points older than this - # age are guaranteed to be ingested and available to be read, excluding - # data loss due to errors. + # The delay of data points caused by ingestion. Data points older than this age + # are guaranteed to be ingested and available to be read, excluding data loss + # due to errors. # Corresponds to the JSON property `ingestDelay` # @return [String] attr_accessor :ingest_delay @@ -1966,8 +1654,8 @@ module Google # The sampling period of metric data points. For metrics which are written # periodically, consecutive data points are stored at this time interval, - # excluding data loss due to errors. Metrics with a higher granularity have - # a smaller sampling period. + # excluding data loss due to errors. Metrics with a higher granularity have a + # smaller sampling period. # Corresponds to the JSON property `samplePeriod` # @return [String] attr_accessor :sample_period @@ -1984,22 +1672,21 @@ module Google end end - # Bind API methods to metrics. Binding a method to a metric causes that - # metric's configured quota behaviors to apply to the method call. + # Bind API methods to metrics. Binding a method to a metric causes that metric's + # configured quota behaviors to apply to the method call. class MetricRule include Google::Apis::Core::Hashable # Metrics to update when the selected methods are called, and the associated - # cost applied to each metric. - # The key of the map is the metric name, and the values are the amount - # increased for the metric against which the quota limits are defined. - # The value must not be negative. + # cost applied to each metric. The key of the map is the metric name, and the + # values are the amount increased for the metric against which the quota limits + # are defined. The value must not be negative. # Corresponds to the JSON property `metricCosts` # @return [Hash] attr_accessor :metric_costs - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -2017,66 +1704,33 @@ module Google # Declares an API Interface to be included in this interface. The including # interface must redeclare all the methods from the included interface, but - # documentation and options are inherited as follows: - # - If after comment and whitespace stripping, the documentation - # string of the redeclared method is empty, it will be inherited - # from the original method. - # - Each annotation belonging to the service config (http, - # visibility) which is not set in the redeclared method will be - # inherited. - # - If an http annotation is inherited, the path pattern will be - # modified as follows. Any version prefix will be replaced by the - # version of the including interface plus the root path if - # specified. - # Example of a simple mixin: - # package google.acl.v1; - # service AccessControl ` - # // Get the underlying ACL object. - # rpc GetAcl(GetAclRequest) returns (Acl) ` - # option (google.api.http).get = "/v1/`resource=**`:getAcl"; - # ` - # ` - # package google.storage.v2; - # service Storage ` - # // rpc GetAcl(GetAclRequest) returns (Acl); - # // Get a data record. - # rpc GetData(GetDataRequest) returns (Data) ` - # option (google.api.http).get = "/v2/`resource=**`"; - # ` - # ` - # Example of a mixin configuration: - # apis: - # - name: google.storage.v2.Storage - # mixins: - # - name: google.acl.v1.AccessControl - # The mixin construct implies that all methods in `AccessControl` are - # also declared with same name and request/response types in - # `Storage`. A documentation generator or annotation processor will - # see the effective `Storage.GetAcl` method after inherting - # documentation and annotations as follows: - # service Storage ` - # // Get the underlying ACL object. - # rpc GetAcl(GetAclRequest) returns (Acl) ` - # option (google.api.http).get = "/v2/`resource=**`:getAcl"; - # ` - # ... - # ` - # Note how the version in the path pattern changed from `v1` to `v2`. - # If the `root` field in the mixin is specified, it should be a - # relative path under which inherited HTTP paths are placed. Example: - # apis: - # - name: google.storage.v2.Storage - # mixins: - # - name: google.acl.v1.AccessControl - # root: acls - # This implies the following inherited HTTP annotation: - # service Storage ` - # // Get the underlying ACL object. - # rpc GetAcl(GetAclRequest) returns (Acl) ` - # option (google.api.http).get = "/v2/acls/`resource=**`:getAcl"; - # ` - # ... - # ` + # documentation and options are inherited as follows: - If after comment and + # whitespace stripping, the documentation string of the redeclared method is + # empty, it will be inherited from the original method. - Each annotation + # belonging to the service config (http, visibility) which is not set in the + # redeclared method will be inherited. - If an http annotation is inherited, the + # path pattern will be modified as follows. Any version prefix will be replaced + # by the version of the including interface plus the root path if specified. + # Example of a simple mixin: package google.acl.v1; service AccessControl ` // + # Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) ` + # option (google.api.http).get = "/v1/`resource=**`:getAcl"; ` ` package google. + # storage.v2; service Storage ` // rpc GetAcl(GetAclRequest) returns (Acl); // + # Get a data record. rpc GetData(GetDataRequest) returns (Data) ` option (google. + # api.http).get = "/v2/`resource=**`"; ` ` Example of a mixin configuration: + # apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1. + # AccessControl The mixin construct implies that all methods in `AccessControl` + # are also declared with same name and request/response types in `Storage`. A + # documentation generator or annotation processor will see the effective ` + # Storage.GetAcl` method after inherting documentation and annotations as + # follows: service Storage ` // Get the underlying ACL object. rpc GetAcl( + # GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=** + # `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1` + # to `v2`. If the `root` field in the mixin is specified, it should be a + # relative path under which inherited HTTP paths are placed. Example: apis: - + # name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl + # root: acls This implies the following inherited HTTP annotation: service + # Storage ` // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns ( + # Acl) ` option (google.api.http).get = "/v2/acls/`resource=**`:getAcl"; ` ... ` class Mixin include Google::Apis::Core::Hashable @@ -2085,8 +1739,7 @@ module Google # @return [String] attr_accessor :name - # If non-empty specifies a path under which inherited HTTP paths - # are rooted. + # If non-empty specifies a path under which inherited HTTP paths are rooted. # Corresponds to the JSON property `root` # @return [String] attr_accessor :root @@ -2102,51 +1755,42 @@ module Google end end - # An object that describes the schema of a MonitoredResource object using a - # type name and a set of labels. For example, the monitored resource - # descriptor for Google Compute Engine VM instances has a type of - # `"gce_instance"` and specifies the use of the labels `"instance_id"` and - # `"zone"` to identify particular VM instances. - # Different services can support different monitored resource types. - # The following are specific rules to service defined monitored resources for - # Monitoring and Logging: - # * The `type`, `display_name`, `description`, `labels` and `launch_stage` - # fields are all required. - # * The first label of the monitored resource descriptor must be - # `resource_container`. There are legacy monitored resource descritptors - # start with `project_id`. - # * It must include a `location` label. - # * Maximum of default 5 service defined monitored resource descriptors - # is allowed per service. - # * Maximum of default 10 labels per monitored resource is allowed. - # The default maximum limit can be overridden. Please follow - # https://cloud.google.com/monitoring/quotas + # An object that describes the schema of a MonitoredResource object using a type + # name and a set of labels. For example, the monitored resource descriptor for + # Google Compute Engine VM instances has a type of `"gce_instance"` and + # specifies the use of the labels `"instance_id"` and `"zone"` to identify + # particular VM instances. Different services can support different monitored + # resource types. The following are specific rules to service defined monitored + # resources for Monitoring and Logging: * The `type`, `display_name`, ` + # description`, `labels` and `launch_stage` fields are all required. * The first + # label of the monitored resource descriptor must be `resource_container`. There + # are legacy monitored resource descritptors start with `project_id`. * It must + # include a `location` label. * Maximum of default 5 service defined monitored + # resource descriptors is allowed per service. * Maximum of default 10 labels + # per monitored resource is allowed. The default maximum limit can be overridden. + # Please follow https://cloud.google.com/monitoring/quotas class MonitoredResourceDescriptor include Google::Apis::Core::Hashable - # Optional. A detailed description of the monitored resource type that might - # be used in documentation. + # Optional. A detailed description of the monitored resource type that might be + # used in documentation. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Optional. A concise name for the monitored resource type that might be - # displayed in user interfaces. It should be a Title Cased Noun Phrase, - # without any article or other determiners. For example, - # `"Google Cloud SQL Database"`. + # displayed in user interfaces. It should be a Title Cased Noun Phrase, without + # any article or other determiners. For example, `"Google Cloud SQL Database"`. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Required. A set of labels used to describe instances of this monitored - # resource type. - # The label key name must follow: - # * Only upper and lower-case letters, digits and underscores (_) are - # allowed. - # * Label name must start with a letter or digit. - # * The maximum length of a label name is 100 characters. - # For example, an individual Google Cloud SQL database is - # identified by values for the labels `database_id` and `location`. + # resource type. The label key name must follow: * Only upper and lower-case + # letters, digits and underscores (_) are allowed. * Label name must start with + # a letter or digit. * The maximum length of a label name is 100 characters. For + # example, an individual Google Cloud SQL database is identified by values for + # the labels `database_id` and `location`. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels @@ -2156,27 +1800,25 @@ module Google # @return [String] attr_accessor :launch_stage - # Optional. The resource name of the monitored resource descriptor: - # `"projects/`project_id`/monitoredResourceDescriptors/`type`"` where - # `type` is the value of the `type` field in this object and - # `project_id` is a project ID that provides API-specific context for - # accessing the type. APIs that do not use project information can use the - # resource name format `"monitoredResourceDescriptors/`type`"`. + # Optional. The resource name of the monitored resource descriptor: `"projects/` + # project_id`/monitoredResourceDescriptors/`type`"` where `type` is the value of + # the `type` field in this object and `project_id` is a project ID that provides + # API-specific context for accessing the type. APIs that do not use project + # information can use the resource name format `"monitoredResourceDescriptors/` + # type`"`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The monitored resource type. For example, the type - # `cloudsql_database` represents databases in Google Cloud SQL. - # All service defined monitored resource types must be prefixed with the - # service name, in the format of ``service name`/`relative resource name``. - # The relative resource name must follow: - # * Only upper and lower-case letters and digits are allowed. - # * It must start with upper case character and is recommended to use Upper - # Camel Case style. - # * The maximum number of characters allowed for the relative_resource_name - # is 100. - # Note there are legacy service monitored resources not following this rule. + # Required. The monitored resource type. For example, the type ` + # cloudsql_database` represents databases in Google Cloud SQL. All service + # defined monitored resource types must be prefixed with the service name, in + # the format of ``service name`/`relative resource name``. The relative resource + # name must follow: * Only upper and lower-case letters and digits are allowed. * + # It must start with upper case character and is recommended to use Upper Camel + # Case style. * The maximum number of characters allowed for the + # relative_resource_name is 100. Note there are legacy service monitored + # resources not following this rule. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -2196,75 +1838,47 @@ module Google end end - # Monitoring configuration of the service. - # The example below shows how to configure monitored resources and metrics - # for monitoring. In the example, a monitored resource and two metrics are - # defined. The `library.googleapis.com/book/returned_count` metric is sent - # to both producer and consumer projects, whereas the - # `library.googleapis.com/book/num_overdue` metric is only sent to the - # consumer project. - # monitored_resources: - # - type: library.googleapis.com/Branch - # display_name: "Library Branch" - # description: "A branch of a library." - # launch_stage: GA - # labels: - # - key: resource_container - # description: "The Cloud container (ie. project id) for the Branch." - # - key: location - # description: "The location of the library branch." - # - key: branch_id - # description: "The id of the branch." - # metrics: - # - name: library.googleapis.com/book/returned_count - # display_name: "Books Returned" - # description: "The count of books that have been returned." - # launch_stage: GA - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # - name: library.googleapis.com/book/num_overdue - # display_name: "Books Overdue" - # description: "The current number of overdue books." - # launch_stage: GA - # metric_kind: GAUGE - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # monitoring: - # producer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # consumer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # - library.googleapis.com/book/num_overdue + # Monitoring configuration of the service. The example below shows how to + # configure monitored resources and metrics for monitoring. In the example, a + # monitored resource and two metrics are defined. The `library.googleapis.com/ + # book/returned_count` metric is sent to both producer and consumer projects, + # whereas the `library.googleapis.com/book/num_overdue` metric is only sent to + # the consumer project. monitored_resources: - type: library.googleapis.com/ + # Branch display_name: "Library Branch" description: "A branch of a library." + # launch_stage: GA labels: - key: resource_container description: "The Cloud + # container (ie. project id) for the Branch." - key: location description: "The + # location of the library branch." - key: branch_id description: "The id of the + # branch." metrics: - name: library.googleapis.com/book/returned_count + # display_name: "Books Returned" description: "The count of books that have been + # returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" + # labels: - key: customer_id description: "The id of the customer." - name: + # library.googleapis.com/book/num_overdue display_name: "Books Overdue" + # description: "The current number of overdue books." launch_stage: GA + # metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id + # description: "The id of the customer." monitoring: producer_destinations: - + # monitored_resource: library.googleapis.com/Branch metrics: - library. + # googleapis.com/book/returned_count consumer_destinations: - monitored_resource: + # library.googleapis.com/Branch metrics: - library.googleapis.com/book/ + # returned_count - library.googleapis.com/book/num_overdue class Monitoring include Google::Apis::Core::Hashable - # Monitoring configurations for sending metrics to the consumer project. - # There can be multiple consumer destinations. A monitored resource type may - # appear in multiple monitoring destinations if different aggregations are - # needed for different sets of metrics associated with that monitored - # resource type. A monitored resource and metric pair may only be used once - # in the Monitoring configuration. + # Monitoring configurations for sending metrics to the consumer project. There + # can be multiple consumer destinations. A monitored resource type may appear in + # multiple monitoring destinations if different aggregations are needed for + # different sets of metrics associated with that monitored resource type. A + # monitored resource and metric pair may only be used once in the Monitoring + # configuration. # Corresponds to the JSON property `consumerDestinations` # @return [Array] attr_accessor :consumer_destinations - # Monitoring configurations for sending metrics to the producer project. - # There can be multiple producer destinations. A monitored resource type may - # appear in multiple monitoring destinations if different aggregations are - # needed for different sets of metrics associated with that monitored - # resource type. A monitored resource and metric pair may only be used once - # in the Monitoring configuration. + # Monitoring configurations for sending metrics to the producer project. There + # can be multiple producer destinations. A monitored resource type may appear in + # multiple monitoring destinations if different aggregations are needed for + # different sets of metrics associated with that monitored resource type. A + # monitored resource and metric pair may only be used once in the Monitoring + # configuration. # Corresponds to the JSON property `producerDestinations` # @return [Array] attr_accessor :producer_destinations @@ -2280,19 +1894,19 @@ module Google end end - # Configuration of a specific monitoring destination (the producer project - # or the consumer project). + # Configuration of a specific monitoring destination (the producer project or + # the consumer project). class MonitoringDestination include Google::Apis::Core::Hashable - # Types of the metrics to report to this monitoring destination. - # Each type must be defined in Service.metrics section. + # Types of the metrics to report to this monitoring destination. Each type must + # be defined in Service.metrics section. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics - # The monitored resource type. The type must be defined in - # Service.monitored_resources section. + # The monitored resource type. The type must be defined in Service. + # monitored_resources section. # Corresponds to the JSON property `monitoredResource` # @return [String] attr_accessor :monitored_resource @@ -2309,27 +1923,25 @@ module Google end # OAuth scopes are a way to define data and permissions on data. For example, - # there are scopes defined for "Read-only access to Google Calendar" and - # "Access to Cloud Platform". Users can consent to a scope for an application, - # giving it permission to access that data on their behalf. - # OAuth scope specifications should be fairly coarse grained; a user will need - # to see and understand the text description of what your scope means. - # In most cases: use one or at most two OAuth scopes for an entire family of - # products. If your product has multiple APIs, you should probably be sharing - # the OAuth scope across all of those APIs. - # When you need finer grained OAuth consent screens: talk with your product - # management about how developers will use them in practice. - # Please note that even though each of the canonical scopes is enough for a - # request to be accepted and passed to the backend, a request can still fail - # due to the backend requiring additional scopes or permissions. + # there are scopes defined for "Read-only access to Google Calendar" and "Access + # to Cloud Platform". Users can consent to a scope for an application, giving it + # permission to access that data on their behalf. OAuth scope specifications + # should be fairly coarse grained; a user will need to see and understand the + # text description of what your scope means. In most cases: use one or at most + # two OAuth scopes for an entire family of products. If your product has + # multiple APIs, you should probably be sharing the OAuth scope across all of + # those APIs. When you need finer grained OAuth consent screens: talk with your + # product management about how developers will use them in practice. Please note + # that even though each of the canonical scopes is enough for a request to be + # accepted and passed to the backend, a request can still fail due to the + # backend requiring additional scopes or permissions. class OAuthRequirements include Google::Apis::Core::Hashable - # The list of publicly documented OAuth scopes that are allowed access. An - # OAuth token containing any of these scopes will be accepted. - # Example: - # canonical_scopes: https://www.googleapis.com/auth/calendar, - # https://www.googleapis.com/auth/calendar.read + # The list of publicly documented OAuth scopes that are allowed access. An OAuth + # token containing any of these scopes will be accepted. Example: + # canonical_scopes: https://www.googleapis.com/auth/calendar, https://www. + # googleapis.com/auth/calendar.read # Corresponds to the JSON property `canonicalScopes` # @return [String] attr_accessor :canonical_scopes @@ -2349,47 +1961,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::ServiceconsumermanagementV1beta1::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 @@ -2414,17 +2024,17 @@ module Google include Google::Apis::Core::Hashable # The option's name. For protobuf built-in options (options defined in - # descriptor.proto), this is the short name. For example, `"map_entry"`. - # For custom options, it should be the fully-qualified name. For example, - # `"google.api.http"`. + # descriptor.proto), this is the short name. For example, `"map_entry"`. For + # custom options, it should be the fully-qualified name. For example, `"google. + # api.http"`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The option's value packed in an Any message. If the value is a primitive, - # the corresponding wrapper type defined in google/protobuf/wrappers.proto - # should be used. If the value is an enum, it should be stored as an int32 - # value using the google.protobuf.Int32Value type. + # The option's value packed in an Any message. If the value is a primitive, the + # corresponding wrapper type defined in google/protobuf/wrappers.proto should be + # used. If the value is an enum, it should be stored as an int32 value using the + # google.protobuf.Int32Value type. # Corresponds to the JSON property `value` # @return [Hash] attr_accessor :value @@ -2445,32 +2055,25 @@ module Google class Page include Google::Apis::Core::Hashable - # The Markdown content of the page. You can use (== include `path` - # ==) to include content from a Markdown file. + # The Markdown content of the page. You can use (== include `path` ==) to + # include content from a Markdown file. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content - # The name of the page. It will be used as an identity of the page to - # generate URI of the page, text of the link to this page in navigation, - # etc. The full page name (start from the root page name to this page - # concatenated with `.`) can be used as reference to the page in your - # documentation. For example: - # 
pages:
-        # - name: Tutorial
-        # content: (== include tutorial.md ==)
-        # subpages:
-        # - name: Java
-        # content: (== include tutorial_java.md ==)
-        #
- # You can reference `Java` page using Markdown reference link syntax: - # `Java`. + # The name of the page. It will be used as an identity of the page to generate + # URI of the page, text of the link to this page in navigation, etc. The full + # page name (start from the root page name to this page concatenated with `.`) + # can be used as reference to the page in your documentation. For example: pages: + # - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java + # content: (== include tutorial_java.md ==) You can reference `Java` page using + # Markdown reference link syntax: `Java`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Subpages of this page. The order of subpages specified here will be - # honored in the generated docset. + # Subpages of this page. The order of subpages specified here will be honored in + # the generated docset. # Corresponds to the JSON property `subpages` # @return [Array] attr_accessor :subpages @@ -2487,46 +2090,25 @@ module Google end end - # Quota configuration helps to achieve fairness and budgeting in service - # usage. - # The metric based quota configuration works this way: - # - The service configuration defines a set of metrics. - # - For API calls, the quota.metric_rules maps methods to metrics with - # corresponding costs. - # - The quota.limits defines limits on the metrics, which will be used for - # quota checks at runtime. - # An example quota configuration in yaml format: - # quota: - # limits: - # - name: apiWriteQpsPerProject - # metric: library.googleapis.com/write_calls - # unit: "1/min/`project`" # rate limit for consumer projects - # values: - # STANDARD: 10000 - # # The metric rules bind all methods to the read_calls metric, - # # except for the UpdateBook and DeleteBook methods. These two methods - # # are mapped to the write_calls metric, with the UpdateBook method - # # consuming at twice rate as the DeleteBook method. - # metric_rules: - # - selector: "*" - # metric_costs: - # library.googleapis.com/read_calls: 1 - # - selector: google.example.library.v1.LibraryService.UpdateBook - # metric_costs: - # library.googleapis.com/write_calls: 2 - # - selector: google.example.library.v1.LibraryService.DeleteBook - # metric_costs: - # library.googleapis.com/write_calls: 1 - # Corresponding Metric definition: - # metrics: - # - name: library.googleapis.com/read_calls - # display_name: Read requests - # metric_kind: DELTA - # value_type: INT64 - # - name: library.googleapis.com/write_calls - # display_name: Write requests - # metric_kind: DELTA - # value_type: INT64 + # Quota configuration helps to achieve fairness and budgeting in service usage. + # The metric based quota configuration works this way: - The service + # configuration defines a set of metrics. - For API calls, the quota. + # metric_rules maps methods to metrics with corresponding costs. - The quota. + # limits defines limits on the metrics, which will be used for quota checks at + # runtime. An example quota configuration in yaml format: quota: limits: - name: + # apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/` + # project`" # rate limit for consumer projects values: STANDARD: 10000 # The + # metric rules bind all methods to the read_calls metric, # except for the + # UpdateBook and DeleteBook methods. These two methods # are mapped to the + # write_calls metric, with the UpdateBook method # consuming at twice rate as + # the DeleteBook method. metric_rules: - selector: "*" metric_costs: library. + # googleapis.com/read_calls: 1 - selector: google.example.library.v1. + # LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - + # selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: + # library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: + # - name: library.googleapis.com/read_calls display_name: Read requests + # metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/ + # write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 class Quota include Google::Apis::Core::Hashable @@ -2535,8 +2117,8 @@ module Google # @return [Array] attr_accessor :limits - # List of `MetricRule` definitions, each one mapping a selected method to one - # or more metrics. + # List of `MetricRule` definitions, each one mapping a selected method to one or + # more metrics. # Corresponds to the JSON property `metricRules` # @return [Array] attr_accessor :metric_rules @@ -2553,95 +2135,89 @@ module Google end # `QuotaLimit` defines a specific limit that applies over a specified duration - # for a limit type. There can be at most one limit for a duration and limit - # type combination defined within a `QuotaGroup`. + # for a limit type. There can be at most one limit for a duration and limit type + # combination defined within a `QuotaGroup`. class QuotaLimit include Google::Apis::Core::Hashable - # Default number of tokens that can be consumed during the specified - # duration. This is the number of tokens assigned when a client - # application developer activates the service for his/her project. - # Specifying a value of 0 will block all requests. This can be used if you - # are provisioning quota to selected consumers and blocking others. - # Similarly, a value of -1 will indicate an unlimited quota. No other - # negative values are allowed. - # Used by group-based quotas only. + # Default number of tokens that can be consumed during the specified duration. + # This is the number of tokens assigned when a client application developer + # activates the service for his/her project. Specifying a value of 0 will block + # all requests. This can be used if you are provisioning quota to selected + # consumers and blocking others. Similarly, a value of -1 will indicate an + # unlimited quota. No other negative values are allowed. Used by group-based + # quotas only. # Corresponds to the JSON property `defaultLimit` # @return [Fixnum] attr_accessor :default_limit - # Optional. User-visible, extended description for this quota limit. - # Should be used only when more context is needed to understand this limit - # than provided by the limit's display name (see: `display_name`). + # Optional. User-visible, extended description for this quota limit. Should be + # used only when more context is needed to understand this limit than provided + # by the limit's display name (see: `display_name`). # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # User-visible display name for this limit. - # Optional. If not set, the UI will provide a default display name based on - # the quota configuration. This field can be used to override the default - # display name generated from the configuration. + # User-visible display name for this limit. Optional. If not set, the UI will + # provide a default display name based on the quota configuration. This field + # can be used to override the default display name generated from the + # configuration. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Duration of this limit in textual notation. Must be "100s" or "1d". - # Used by group-based quotas only. + # Duration of this limit in textual notation. Must be "100s" or "1d". Used by + # group-based quotas only. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration - # Free tier value displayed in the Developers Console for this limit. - # The free tier is the number of tokens that will be subtracted from the - # billed amount when billing is enabled. - # This field can only be set on a limit with duration "1d", in a billable - # group; it is invalid on any other limit. If this field is not set, it - # defaults to 0, indicating that there is no free tier for this service. - # Used by group-based quotas only. + # Free tier value displayed in the Developers Console for this limit. The free + # tier is the number of tokens that will be subtracted from the billed amount + # when billing is enabled. This field can only be set on a limit with duration " + # 1d", in a billable group; it is invalid on any other limit. If this field is + # not set, it defaults to 0, indicating that there is no free tier for this + # service. Used by group-based quotas only. # Corresponds to the JSON property `freeTier` # @return [Fixnum] attr_accessor :free_tier - # Maximum number of tokens that can be consumed during the specified - # duration. Client application developers can override the default limit up - # to this maximum. If specified, this value cannot be set to a value less - # than the default limit. If not specified, it is set to the default limit. - # To allow clients to apply overrides with no upper bound, set this to -1, - # indicating unlimited maximum quota. - # Used by group-based quotas only. + # Maximum number of tokens that can be consumed during the specified duration. + # Client application developers can override the default limit up to this + # maximum. If specified, this value cannot be set to a value less than the + # default limit. If not specified, it is set to the default limit. To allow + # clients to apply overrides with no upper bound, set this to -1, indicating + # unlimited maximum quota. Used by group-based quotas only. # Corresponds to the JSON property `maxLimit` # @return [Fixnum] attr_accessor :max_limit - # The name of the metric this quota limit applies to. The quota limits with - # the same metric will be checked together during runtime. The metric must be + # The name of the metric this quota limit applies to. The quota limits with the + # same metric will be checked together during runtime. The metric must be # defined within the service config. # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric - # Name of the quota limit. - # The name must be provided, and it must be unique within the service. The - # name can only include alphanumeric characters as well as '-'. - # The maximum length of the limit name is 64 characters. + # Name of the quota limit. The name must be provided, and it must be unique + # within the service. The name can only include alphanumeric characters as well + # as '-'. The maximum length of the limit name is 64 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Specify the unit of the quota limit. It uses the same syntax as - # Metric.unit. The supported unit kinds are determined by the quota - # backend system. - # Here are some examples: - # * "1/min/`project`" for quota per minute per project. - # Note: the order of unit components is insignificant. - # The "1" at the beginning is required to follow the metric unit syntax. + # Specify the unit of the quota limit. It uses the same syntax as Metric.unit. + # The supported unit kinds are determined by the quota backend system. Here are + # some examples: * "1/min/`project`" for quota per minute per project. Note: the + # order of unit components is insignificant. The "1" at the beginning is + # required to follow the metric unit syntax. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit # Tiered limit values. You must specify this as a key:value pair, with an - # integer value that is the maximum number of requests allowed for the - # specified unit. Currently only STANDARD is supported. + # integer value that is the maximum number of requests allowed for the specified + # unit. Currently only STANDARD is supported. # Corresponds to the JSON property `values` # @return [Hash] attr_accessor :values @@ -2666,50 +2242,32 @@ module Google end # `Service` is the root object of Google service configuration schema. It - # describes basic information about a service, such as the name and the - # title, and delegates other aspects to sub-sections. Each sub-section is - # either a proto message or a repeated proto message that configures a - # specific aspect, such as auth. See each proto message definition for details. - # Example: - # type: google.api.Service - # config_version: 3 - # name: calendar.googleapis.com - # title: Google Calendar API - # apis: - # - name: google.calendar.v3.Calendar - # authentication: - # providers: - # - id: google_calendar_auth - # jwks_uri: https://www.googleapis.com/oauth2/v1/certs - # issuer: https://securetoken.google.com - # rules: - # - selector: "*" - # requirements: - # provider_id: google_calendar_auth + # describes basic information about a service, such as the name and the title, + # and delegates other aspects to sub-sections. Each sub-section is either a + # proto message or a repeated proto message that configures a specific aspect, + # such as auth. See each proto message definition for details. Example: type: + # google.api.Service config_version: 3 name: calendar.googleapis.com title: + # Google Calendar API apis: - name: google.calendar.v3.Calendar authentication: + # providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/ + # oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" + # requirements: provider_id: google_calendar_auth class Service include Google::Apis::Core::Hashable - # A list of API interfaces exported by this service. Only the `name` field - # of the google.protobuf.Api needs to be provided by the configuration - # author, as the remaining fields will be derived from the IDL during the - # normalization process. It is an error to specify an API interface here - # which cannot be resolved against the associated IDL files. + # A list of API interfaces exported by this service. Only the `name` field of + # the google.protobuf.Api needs to be provided by the configuration author, as + # the remaining fields will be derived from the IDL during the normalization + # process. It is an error to specify an API interface here which cannot be + # resolved against the associated IDL files. # Corresponds to the JSON property `apis` # @return [Array] attr_accessor :apis - # `Authentication` defines the authentication configuration for an API. - # Example for an API targeted for external use: - # name: calendar.googleapis.com - # authentication: - # providers: - # - id: google_calendar_auth - # jwks_uri: https://www.googleapis.com/oauth2/v1/certs - # issuer: https://securetoken.google.com - # rules: - # - selector: "*" - # requirements: - # provider_id: google_calendar_auth + # `Authentication` defines the authentication configuration for an API. Example + # for an API targeted for external use: name: calendar.googleapis.com + # authentication: providers: - id: google_calendar_auth jwks_uri: https://www. + # googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - + # selector: "*" requirements: provider_id: google_calendar_auth # Corresponds to the JSON property `authentication` # @return [Google::Apis::ServiceconsumermanagementV1beta1::Authentication] attr_accessor :authentication @@ -2719,211 +2277,136 @@ module Google # @return [Google::Apis::ServiceconsumermanagementV1beta1::Backend] attr_accessor :backend - # Billing related configuration of the service. - # The following example shows how to configure monitored resources and metrics - # for billing, `consumer_destinations` is the only supported destination and - # the monitored resources need at least one label key - # `cloud.googleapis.com/location` to indicate the location of the billing - # usage, using different monitored resources between monitoring and billing is - # recommended so they can be evolved independently: - # monitored_resources: - # - type: library.googleapis.com/billing_branch - # labels: - # - key: cloud.googleapis.com/location - # description: | - # Predefined label to support billing location restriction. - # - key: city - # description: | - # Custom label to define the city where the library branch is located - # in. - # - key: name - # description: Custom label to define the name of the library branch. - # metrics: - # - name: library.googleapis.com/book/borrowed_count - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # billing: - # consumer_destinations: - # - monitored_resource: library.googleapis.com/billing_branch - # metrics: - # - library.googleapis.com/book/borrowed_count + # Billing related configuration of the service. The following example shows how + # to configure monitored resources and metrics for billing, ` + # consumer_destinations` is the only supported destination and the monitored + # resources need at least one label key `cloud.googleapis.com/location` to + # indicate the location of the billing usage, using different monitored + # resources between monitoring and billing is recommended so they can be evolved + # independently: monitored_resources: - type: library.googleapis.com/ + # billing_branch labels: - key: cloud.googleapis.com/location description: | + # Predefined label to support billing location restriction. - key: city + # description: | Custom label to define the city where the library branch is + # located in. - key: name description: Custom label to define the name of the + # library branch. metrics: - name: library.googleapis.com/book/borrowed_count + # metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: + # - monitored_resource: library.googleapis.com/billing_branch metrics: - library. + # googleapis.com/book/borrowed_count # Corresponds to the JSON property `billing` # @return [Google::Apis::ServiceconsumermanagementV1beta1::Billing] attr_accessor :billing - # The semantic version of the service configuration. The config version - # affects the interpretation of the service configuration. For example, - # certain features are enabled by default for certain config versions. - # The latest config version is `3`. + # The semantic version of the service configuration. The config version affects + # the interpretation of the service configuration. For example, certain features + # are enabled by default for certain config versions. The latest config version + # is `3`. # Corresponds to the JSON property `configVersion` # @return [Fixnum] attr_accessor :config_version - # `Context` defines which contexts an API requests. - # Example: - # context: - # rules: - # - selector: "*" - # requested: - # - google.rpc.context.ProjectContext - # - google.rpc.context.OriginContext - # The above specifies that all methods in the API request - # `google.rpc.context.ProjectContext` and - # `google.rpc.context.OriginContext`. - # Available context types are defined in package - # `google.rpc.context`. - # This also provides mechanism to whitelist any protobuf message extension that - # can be sent in grpc metadata using “x-goog-ext--bin” and - # “x-goog-ext--jspb” format. For example, list any service - # specific protobuf types that can appear in grpc metadata as follows in your - # yaml file: - # Example: - # context: - # rules: - # - selector: "google.example.library.v1.LibraryService.CreateBook" - # allowed_request_extensions: - # - google.foo.v1.NewExtension - # allowed_response_extensions: - # - google.foo.v1.NewExtension - # You can also specify extension ID instead of fully qualified extension name - # here. + # `Context` defines which contexts an API requests. Example: context: rules: - + # selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc. + # context.OriginContext The above specifies that all methods in the API request ` + # google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. + # Available context types are defined in package `google.rpc.context`. This also + # provides mechanism to whitelist any protobuf message extension that can be + # sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. + # For example, list any service specific protobuf types that can appear in grpc + # metadata as follows in your yaml file: Example: context: rules: - selector: " + # google.example.library.v1.LibraryService.CreateBook" + # allowed_request_extensions: - google.foo.v1.NewExtension + # allowed_response_extensions: - google.foo.v1.NewExtension You can also specify + # extension ID instead of fully qualified extension name here. # Corresponds to the JSON property `context` # @return [Google::Apis::ServiceconsumermanagementV1beta1::Context] attr_accessor :context - # Selects and configures the service controller used by the service. The - # service controller handles features like abuse, quota, billing, logging, - # monitoring, etc. + # Selects and configures the service controller used by the service. The service + # controller handles features like abuse, quota, billing, logging, monitoring, + # etc. # Corresponds to the JSON property `control` # @return [Google::Apis::ServiceconsumermanagementV1beta1::Control] attr_accessor :control - # Customize service error responses. For example, list any service - # specific protobuf types that can appear in error detail lists of - # error responses. - # Example: - # custom_error: - # types: - # - google.foo.v1.CustomError - # - google.foo.v1.AnotherError + # Customize service error responses. For example, list any service specific + # protobuf types that can appear in error detail lists of error responses. + # Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1. + # AnotherError # Corresponds to the JSON property `customError` # @return [Google::Apis::ServiceconsumermanagementV1beta1::CustomError] attr_accessor :custom_error - # `Documentation` provides the information for describing a service. - # Example: - # 
documentation:
-        # summary: >
-        # The Google Calendar API gives access
-        # to most calendar features.
-        # pages:
-        # - name: Overview
-        # content: (== include google/foo/overview.md ==)
-        # - name: Tutorial
-        # content: (== include google/foo/tutorial.md ==)
-        # subpages;
-        # - name: Java
-        # content: (== include google/foo/tutorial_java.md ==)
-        # rules:
-        # - selector: google.calendar.Calendar.Get
-        # description: >
-        # ...
-        # - selector: google.calendar.Calendar.Put
-        # description: >
-        # ...
-        #
- # Documentation is provided in markdown syntax. In addition to - # standard markdown features, definition lists, tables and fenced - # code blocks are supported. Section headers can be provided and are - # interpreted relative to the section nesting of the context where - # a documentation fragment is embedded. - # Documentation from the IDL is merged with documentation defined - # via the config at normalization time, where documentation provided - # by config rules overrides IDL provided. - # A number of constructs specific to the API platform are supported - # in documentation text. - # In order to reference a proto element, the following - # notation can be used: - # 
[fully.qualified.proto.name][]
- # To override the display text used for the link, this can be used: - # 
[display text][fully.qualified.proto.name]
- # Text can be excluded from doc using the following notation: - # 
(-- internal comment --)
- # A few directives are available in documentation. Note that - # directives must appear on a single line to be properly - # identified. The `include` directive includes a markdown file from - # an external source: - # 
(== include path/to/file ==)
- # The `resource_for` directive marks a message to be the resource of - # a collection in REST view. If it is not specified, tools attempt - # to infer the resource from the operations in a collection: - # 
(== resource_for v1.shelves.books ==)
- # The directive `suppress_warning` does not directly affect documentation - # and is documented together with service config validation. + # `Documentation` provides the information for describing a service. Example: + # documentation: summary: > The Google Calendar API gives access to most + # calendar features. pages: - name: Overview content: (== include google/foo/ + # overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md == + # ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==) + # rules: - selector: google.calendar.Calendar.Get description: > ... - selector: + # google.calendar.Calendar.Put description: > ... Documentation is provided in + # markdown syntax. In addition to standard markdown features, definition lists, + # tables and fenced code blocks are supported. Section headers can be provided + # and are interpreted relative to the section nesting of the context where a + # documentation fragment is embedded. Documentation from the IDL is merged with + # documentation defined via the config at normalization time, where + # documentation provided by config rules overrides IDL provided. A number of + # constructs specific to the API platform are supported in documentation text. + # In order to reference a proto element, the following notation can be used: [ + # fully.qualified.proto.name][] To override the display text used for the link, + # this can be used: [display text][fully.qualified.proto.name] Text can be + # excluded from doc using the following notation: (-- internal comment --) A few + # directives are available in documentation. Note that directives must appear on + # a single line to be properly identified. The `include` directive includes a + # markdown file from an external source: (== include path/to/file ==) The ` + # resource_for` directive marks a message to be the resource of a collection in + # REST view. If it is not specified, tools attempt to infer the resource from + # the operations in a collection: (== resource_for v1.shelves.books ==) The + # directive `suppress_warning` does not directly affect documentation and is + # documented together with service config validation. # Corresponds to the JSON property `documentation` # @return [Google::Apis::ServiceconsumermanagementV1beta1::Documentation] attr_accessor :documentation - # Configuration for network endpoints. If this is empty, then an endpoint - # with the same name as the service is automatically generated to service all - # defined APIs. + # Configuration for network endpoints. If this is empty, then an endpoint with + # the same name as the service is automatically generated to service all defined + # APIs. # Corresponds to the JSON property `endpoints` # @return [Array] attr_accessor :endpoints - # A list of all enum types included in this API service. Enums - # referenced directly or indirectly by the `apis` are automatically - # included. Enums which are not referenced but shall be included - # should be listed here by name. Example: - # enums: - # - name: google.someapi.v1.SomeEnum + # A list of all enum types included in this API service. Enums referenced + # directly or indirectly by the `apis` are automatically included. Enums which + # are not referenced but shall be included should be listed here by name. + # Example: enums: - name: google.someapi.v1.SomeEnum # Corresponds to the JSON property `enums` # @return [Array] attr_accessor :enums # Defines the HTTP configuration for an API service. It contains a list of - # HttpRule, each specifying the mapping of an RPC method - # to one or more HTTP REST API methods. + # HttpRule, each specifying the mapping of an RPC method to one or more HTTP + # REST API methods. # Corresponds to the JSON property `http` # @return [Google::Apis::ServiceconsumermanagementV1beta1::Http] attr_accessor :http - # A unique ID for a specific instance of this message, typically assigned - # by the client for tracking purpose. Must be no longer than 63 characters - # and only lower case letters, digits, '.', '_' and '-' are allowed. If - # empty, the server may choose to generate one instead. + # A unique ID for a specific instance of this message, typically assigned by the + # client for tracking purpose. Must be no longer than 63 characters and only + # lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server + # may choose to generate one instead. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Logging configuration of the service. - # The following example shows how to configure logs to be sent to the - # producer and consumer projects. In the example, the `activity_history` - # log is sent to both the producer and consumer projects, whereas the - # `purchase_history` log is only sent to the producer project. - # monitored_resources: - # - type: library.googleapis.com/branch - # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. - # logs: - # - name: activity_history - # labels: - # - key: /customer_id - # - name: purchase_history - # logging: - # producer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history - # - purchase_history - # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history + # Logging configuration of the service. The following example shows how to + # configure logs to be sent to the producer and consumer projects. In the + # example, the `activity_history` log is sent to both the producer and consumer + # projects, whereas the `purchase_history` log is only sent to the producer + # project. monitored_resources: - type: library.googleapis.com/branch labels: - + # key: /city description: The city where the library branch is located in. - key: + # /name description: The name of the branch. logs: - name: activity_history + # labels: - key: /customer_id - name: purchase_history logging: + # producer_destinations: - monitored_resource: library.googleapis.com/branch + # logs: - activity_history - purchase_history consumer_destinations: - + # monitored_resource: library.googleapis.com/branch logs: - activity_history # Corresponds to the JSON property `logging` # @return [Google::Apis::ServiceconsumermanagementV1beta1::Logging] attr_accessor :logging @@ -2938,70 +2421,41 @@ module Google # @return [Array] attr_accessor :metrics - # Defines the monitored resources used by this service. This is required - # by the Service.monitoring and Service.logging configurations. + # Defines the monitored resources used by this service. This is required by the + # Service.monitoring and Service.logging configurations. # Corresponds to the JSON property `monitoredResources` # @return [Array] attr_accessor :monitored_resources - # Monitoring configuration of the service. - # The example below shows how to configure monitored resources and metrics - # for monitoring. In the example, a monitored resource and two metrics are - # defined. The `library.googleapis.com/book/returned_count` metric is sent - # to both producer and consumer projects, whereas the - # `library.googleapis.com/book/num_overdue` metric is only sent to the - # consumer project. - # monitored_resources: - # - type: library.googleapis.com/Branch - # display_name: "Library Branch" - # description: "A branch of a library." - # launch_stage: GA - # labels: - # - key: resource_container - # description: "The Cloud container (ie. project id) for the Branch." - # - key: location - # description: "The location of the library branch." - # - key: branch_id - # description: "The id of the branch." - # metrics: - # - name: library.googleapis.com/book/returned_count - # display_name: "Books Returned" - # description: "The count of books that have been returned." - # launch_stage: GA - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # - name: library.googleapis.com/book/num_overdue - # display_name: "Books Overdue" - # description: "The current number of overdue books." - # launch_stage: GA - # metric_kind: GAUGE - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # monitoring: - # producer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # consumer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # - library.googleapis.com/book/num_overdue + # Monitoring configuration of the service. The example below shows how to + # configure monitored resources and metrics for monitoring. In the example, a + # monitored resource and two metrics are defined. The `library.googleapis.com/ + # book/returned_count` metric is sent to both producer and consumer projects, + # whereas the `library.googleapis.com/book/num_overdue` metric is only sent to + # the consumer project. monitored_resources: - type: library.googleapis.com/ + # Branch display_name: "Library Branch" description: "A branch of a library." + # launch_stage: GA labels: - key: resource_container description: "The Cloud + # container (ie. project id) for the Branch." - key: location description: "The + # location of the library branch." - key: branch_id description: "The id of the + # branch." metrics: - name: library.googleapis.com/book/returned_count + # display_name: "Books Returned" description: "The count of books that have been + # returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" + # labels: - key: customer_id description: "The id of the customer." - name: + # library.googleapis.com/book/num_overdue display_name: "Books Overdue" + # description: "The current number of overdue books." launch_stage: GA + # metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id + # description: "The id of the customer." monitoring: producer_destinations: - + # monitored_resource: library.googleapis.com/Branch metrics: - library. + # googleapis.com/book/returned_count consumer_destinations: - monitored_resource: + # library.googleapis.com/Branch metrics: - library.googleapis.com/book/ + # returned_count - library.googleapis.com/book/num_overdue # Corresponds to the JSON property `monitoring` # @return [Google::Apis::ServiceconsumermanagementV1beta1::Monitoring] attr_accessor :monitoring - # The service name, which is a DNS-like logical identifier for the - # service, such as `calendar.googleapis.com`. The service name - # typically goes through DNS verification to make sure the owner - # of the service also owns the DNS name. + # The service name, which is a DNS-like logical identifier for the service, such + # as `calendar.googleapis.com`. The service name typically goes through DNS + # verification to make sure the owner of the service also owns the DNS name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3011,46 +2465,25 @@ module Google # @return [String] attr_accessor :producer_project_id - # Quota configuration helps to achieve fairness and budgeting in service - # usage. - # The metric based quota configuration works this way: - # - The service configuration defines a set of metrics. - # - For API calls, the quota.metric_rules maps methods to metrics with - # corresponding costs. - # - The quota.limits defines limits on the metrics, which will be used for - # quota checks at runtime. - # An example quota configuration in yaml format: - # quota: - # limits: - # - name: apiWriteQpsPerProject - # metric: library.googleapis.com/write_calls - # unit: "1/min/`project`" # rate limit for consumer projects - # values: - # STANDARD: 10000 - # # The metric rules bind all methods to the read_calls metric, - # # except for the UpdateBook and DeleteBook methods. These two methods - # # are mapped to the write_calls metric, with the UpdateBook method - # # consuming at twice rate as the DeleteBook method. - # metric_rules: - # - selector: "*" - # metric_costs: - # library.googleapis.com/read_calls: 1 - # - selector: google.example.library.v1.LibraryService.UpdateBook - # metric_costs: - # library.googleapis.com/write_calls: 2 - # - selector: google.example.library.v1.LibraryService.DeleteBook - # metric_costs: - # library.googleapis.com/write_calls: 1 - # Corresponding Metric definition: - # metrics: - # - name: library.googleapis.com/read_calls - # display_name: Read requests - # metric_kind: DELTA - # value_type: INT64 - # - name: library.googleapis.com/write_calls - # display_name: Write requests - # metric_kind: DELTA - # value_type: INT64 + # Quota configuration helps to achieve fairness and budgeting in service usage. + # The metric based quota configuration works this way: - The service + # configuration defines a set of metrics. - For API calls, the quota. + # metric_rules maps methods to metrics with corresponding costs. - The quota. + # limits defines limits on the metrics, which will be used for quota checks at + # runtime. An example quota configuration in yaml format: quota: limits: - name: + # apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/` + # project`" # rate limit for consumer projects values: STANDARD: 10000 # The + # metric rules bind all methods to the read_calls metric, # except for the + # UpdateBook and DeleteBook methods. These two methods # are mapped to the + # write_calls metric, with the UpdateBook method # consuming at twice rate as + # the DeleteBook method. metric_rules: - selector: "*" metric_costs: library. + # googleapis.com/read_calls: 1 - selector: google.example.library.v1. + # LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - + # selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: + # library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: + # - name: library.googleapis.com/read_calls display_name: Read requests + # metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/ + # write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 # Corresponds to the JSON property `quota` # @return [Google::Apis::ServiceconsumermanagementV1beta1::Quota] attr_accessor :quota @@ -3060,20 +2493,18 @@ module Google # @return [Google::Apis::ServiceconsumermanagementV1beta1::SourceInfo] attr_accessor :source_info - # ### System parameter configuration - # A system parameter is a special kind of parameter defined by the API - # system, not by an individual API. It is typically mapped to an HTTP header - # and/or a URL query parameter. This configuration specifies which methods - # change the names of the system parameters. + # ### System parameter configuration A system parameter is a special kind of + # parameter defined by the API system, not by an individual API. It is typically + # mapped to an HTTP header and/or a URL query parameter. This configuration + # specifies which methods change the names of the system parameters. # Corresponds to the JSON property `systemParameters` # @return [Google::Apis::ServiceconsumermanagementV1beta1::SystemParameters] attr_accessor :system_parameters - # A list of all proto message types included in this API service. - # It serves similar purpose as [google.api.Service.types], except that - # these types are not needed by user-defined APIs. Therefore, they will not - # show up in the generated discovery doc. This field should only be used - # to define system APIs in ESF. + # A list of all proto message types included in this API service. It serves + # similar purpose as [google.api.Service.types], except that these types are not + # needed by user-defined APIs. Therefore, they will not show up in the generated + # discovery doc. This field should only be used to define system APIs in ESF. # Corresponds to the JSON property `systemTypes` # @return [Array] attr_accessor :system_types @@ -3083,12 +2514,10 @@ module Google # @return [String] attr_accessor :title - # A list of all proto message types included in this API service. - # Types referenced directly or indirectly by the `apis` are - # automatically included. Messages which are not referenced but - # shall be included, such as types used by the `google.protobuf.Any` type, - # should be listed here by name. Example: - # types: + # A list of all proto message types included in this API service. Types + # referenced directly or indirectly by the `apis` are automatically included. + # Messages which are not referenced but shall be included, such as types used by + # the `google.protobuf.Any` type, should be listed here by name. Example: types: # - name: google.protobuf.Int32 # Corresponds to the JSON property `types` # @return [Array] @@ -3135,32 +2564,28 @@ module Google end end - # The per-product per-project service identity for a service. - # Use this field to configure per-product per-project service identity. - # Example of a service identity configuration. - # usage: - # service_identity: - # - service_account_parent: "projects/123456789" - # display_name: "Cloud XXX Service Agent" - # description: "Used as the identity of Cloud XXX to access resources" + # The per-product per-project service identity for a service. Use this field to + # configure per-product per-project service identity. Example of a service + # identity configuration. usage: service_identity: - service_account_parent: " + # projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used + # as the identity of Cloud XXX to access resources" class ServiceIdentity include Google::Apis::Core::Hashable - # Optional. A user-specified opaque description of the service account. - # Must be less than or equal to 256 UTF-8 bytes. + # Optional. A user-specified opaque description of the service account. Must be + # less than or equal to 256 UTF-8 bytes. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Optional. A user-specified name for the service account. - # Must be less than or equal to 100 UTF-8 bytes. + # Optional. A user-specified name for the service account. Must be less than or + # equal to 100 UTF-8 bytes. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # A service account project that hosts the service accounts. - # An example name would be: - # `projects/123456789` + # A service account project that hosts the service accounts. An example name + # would be: `projects/123456789` # Corresponds to the JSON property `serviceAccountParent` # @return [String] attr_accessor :service_account_parent @@ -3177,13 +2602,13 @@ module Google end end - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. class SourceContext include Google::Apis::Core::Hashable # The path-qualified name of the .proto file that contained the associated - # protobuf element. For example: `"google/protobuf/source_context.proto"`. + # protobuf element. For example: `"google/protobuf/source_context.proto"`. # Corresponds to the JSON property `fileName` # @return [String] attr_accessor :file_name @@ -3217,12 +2642,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 @@ -3231,15 +2656,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 @@ -3262,8 +2687,7 @@ module Google class SystemParameter include Google::Apis::Core::Hashable - # Define the HTTP header name to use for the parameter. It is case - # insensitive. + # Define the HTTP header name to use for the parameter. It is case insensitive. # Corresponds to the JSON property `httpHeader` # @return [String] attr_accessor :http_header @@ -3291,23 +2715,20 @@ module Google end end - # Define a system parameter rule mapping system parameter definitions to - # methods. + # Define a system parameter rule mapping system parameter definitions to methods. class SystemParameterRule include Google::Apis::Core::Hashable - # Define parameters. Multiple names may be defined for a parameter. - # For a given method call, only one of them should be used. If multiple - # names are used the behavior is implementation-dependent. - # If none of the specified names are present the behavior is - # parameter-dependent. + # Define parameters. Multiple names may be defined for a parameter. For a given + # method call, only one of them should be used. If multiple names are used the + # behavior is implementation-dependent. If none of the specified names are + # present the behavior is parameter-dependent. # Corresponds to the JSON property `parameters` # @return [Array] attr_accessor :parameters # Selects the methods to which this rule applies. Use '*' to indicate all - # methods in all APIs. - # Refer to selector for syntax details. + # methods in all APIs. Refer to selector for syntax details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -3323,36 +2744,23 @@ module Google end end - # ### System parameter configuration - # A system parameter is a special kind of parameter defined by the API - # system, not by an individual API. It is typically mapped to an HTTP header - # and/or a URL query parameter. This configuration specifies which methods - # change the names of the system parameters. + # ### System parameter configuration A system parameter is a special kind of + # parameter defined by the API system, not by an individual API. It is typically + # mapped to an HTTP header and/or a URL query parameter. This configuration + # specifies which methods change the names of the system parameters. class SystemParameters include Google::Apis::Core::Hashable - # Define system parameters. - # The parameters defined here will override the default parameters - # implemented by the system. If this field is missing from the service - # config, default system parameters will be used. Default system parameters - # and names is implementation-dependent. - # Example: define api key for all methods - # system_parameters - # rules: - # - selector: "*" - # parameters: - # - name: api_key - # url_query_parameter: api_key - # Example: define 2 api key names for a specific method. - # system_parameters - # rules: - # - selector: "/ListShelves" - # parameters: - # - name: api_key - # http_header: Api-Key1 - # - name: api_key - # http_header: Api-Key2 - # **NOTE:** All service configuration rules follow "last one wins" order. + # Define system parameters. The parameters defined here will override the + # default parameters implemented by the system. If this field is missing from + # the service config, default system parameters will be used. Default system + # parameters and names is implementation-dependent. Example: define api key for + # all methods system_parameters rules: - selector: "*" parameters: - name: + # api_key url_query_parameter: api_key Example: define 2 api key names for a + # specific method. system_parameters rules: - selector: "/ListShelves" + # parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: + # Api-Key2 **NOTE:** All service configuration rules follow "last one wins" + # order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -3391,8 +2799,8 @@ module Google # @return [Array] attr_accessor :options - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. # Corresponds to the JSON property `sourceContext` # @return [Google::Apis::ServiceconsumermanagementV1beta1::SourceContext] attr_accessor :source_context @@ -3422,37 +2830,33 @@ module Google include Google::Apis::Core::Hashable # The full resource name of a channel used for sending notifications to the - # service producer. - # Google Service Management currently only supports - # [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification - # channel. To use Google Cloud Pub/Sub as the channel, this must be the name - # of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format - # documented in https://cloud.google.com/pubsub/docs/overview. + # service producer. Google Service Management currently only supports [Google + # Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To + # use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/ + # Sub topic that uses the Cloud Pub/Sub topic name format documented in https:// + # cloud.google.com/pubsub/docs/overview. # Corresponds to the JSON property `producerNotificationChannel` # @return [String] attr_accessor :producer_notification_channel # Requirements that must be satisfied before a consumer project can use the - # service. Each requirement is of the form /; - # for example 'serviceusage.googleapis.com/billing-enabled'. + # service. Each requirement is of the form /; for example 'serviceusage. + # googleapis.com/billing-enabled'. # Corresponds to the JSON property `requirements` # @return [Array] attr_accessor :requirements - # A list of usage rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of usage rules that apply to individual API methods. **NOTE:** All + # service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules - # The per-product per-project service identity for a service. - # Use this field to configure per-product per-project service identity. - # Example of a service identity configuration. - # usage: - # service_identity: - # - service_account_parent: "projects/123456789" - # display_name: "Cloud XXX Service Agent" - # description: "Used as the identity of Cloud XXX to access resources" + # The per-product per-project service identity for a service. Use this field to + # configure per-product per-project service identity. Example of a service + # identity configuration. usage: service_identity: - service_account_parent: " + # projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used + # as the identity of Cloud XXX to access resources" # Corresponds to the JSON property `serviceIdentity` # @return [Google::Apis::ServiceconsumermanagementV1beta1::ServiceIdentity] attr_accessor :service_identity @@ -3470,45 +2874,36 @@ module Google end end - # Usage configuration rules for the service. - # NOTE: Under development. - # Use this rule to configure unregistered calls for the service. Unregistered - # calls are calls that do not contain consumer project identity. - # (Example: calls that do not contain an API key). - # By default, API methods do not allow unregistered calls, and each method call - # must be identified by a consumer project identity. Use this rule to - # allow/disallow unregistered calls. - # Example of an API that wants to allow unregistered calls for entire service. - # usage: - # rules: - # - selector: "*" - # allow_unregistered_calls: true - # Example of a method that wants to allow unregistered calls. - # usage: - # rules: - # - selector: "google.example.library.v1.LibraryService.CreateBook" - # allow_unregistered_calls: true + # Usage configuration rules for the service. NOTE: Under development. Use this + # rule to configure unregistered calls for the service. Unregistered calls are + # calls that do not contain consumer project identity. (Example: calls that do + # not contain an API key). By default, API methods do not allow unregistered + # calls, and each method call must be identified by a consumer project identity. + # Use this rule to allow/disallow unregistered calls. Example of an API that + # wants to allow unregistered calls for entire service. usage: rules: - selector: + # "*" allow_unregistered_calls: true Example of a method that wants to allow + # unregistered calls. usage: rules: - selector: "google.example.library.v1. + # LibraryService.CreateBook" allow_unregistered_calls: true class UsageRule include Google::Apis::Core::Hashable - # If true, the selected method allows unregistered calls, e.g. calls - # that don't identify any user or application. + # If true, the selected method allows unregistered calls, e.g. calls that don't + # identify any user or application. # Corresponds to the JSON property `allowUnregisteredCalls` # @return [Boolean] attr_accessor :allow_unregistered_calls alias_method :allow_unregistered_calls?, :allow_unregistered_calls # Selects the methods to which this rule applies. Use '*' to indicate all - # methods in all APIs. - # Refer to selector for syntax details. + # methods in all APIs. Refer to selector for syntax details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector - # If true, the selected method should skip service control and the control - # plane features, such as quota and billing, will not be available. - # This flag is used by Google Cloud Endpoints to bypass checks for internal - # methods, such as service health check methods. + # If true, the selected method should skip service control and the control plane + # features, such as quota and billing, will not be available. This flag is used + # by Google Cloud Endpoints to bypass checks for internal methods, such as + # service health check methods. # Corresponds to the JSON property `skipServiceControl` # @return [Boolean] attr_accessor :skip_service_control @@ -3555,35 +2950,31 @@ module Google attr_accessor :is_precise alias_method :is_precise?, :is_precise - # The name of the parent metric of this limit. - # An example name would be: - # `compute.googleapis.com/cpus` + # The name of the parent metric of this limit. An example name would be: ` + # compute.googleapis.com/cpus` # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric - # The resource name of the quota limit. - # An example name would be: - # `services/compute.googleapis.com/projects/123/quotas/metrics/compute. - # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` - # The resource name is intended to be opaque and should not be parsed for - # its component strings, since its representation could change in the future. + # The resource name of the quota limit. An example name would be: `services/ + # compute.googleapis.com/projects/123/quotas/metrics/compute.googleapis.com% + # 2Fcpus/limits/%2Fproject%2Fregion` The resource name is intended to be opaque + # and should not be parsed for its component strings, since its representation + # could change in the future. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Summary of the enforced quota buckets, organized by quota dimension, - # ordered from least specific to most specific (for example, the global - # default bucket, with no quota dimensions, will always appear first). + # Summary of the enforced quota buckets, organized by quota dimension, ordered + # from least specific to most specific (for example, the global default bucket, + # with no quota dimensions, will always appear first). # Corresponds to the JSON property `quotaBuckets` # @return [Array] attr_accessor :quota_buckets - # The limit unit. - # An example unit would be: - # `1/`project`/`region`` - # Note that ``project`` and ``region`` are not placeholders in this example; - # the literal characters ``` and ``` occur in the string. + # The limit unit. An example unit would be: `1/`project`/`region`` Note that `` + # project`` and ``region`` are not placeholders in this example; the literal + # characters ``` and ``` occur in the string. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit @@ -3611,26 +3002,21 @@ module Google # @return [Array] attr_accessor :consumer_quota_limits - # The display name of the metric. - # An example name would be: - # "CPUs" + # The display name of the metric. An example name would be: "CPUs" # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # The name of the metric. - # An example name would be: - # `compute.googleapis.com/cpus` + # The name of the metric. An example name would be: `compute.googleapis.com/cpus` # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric - # The resource name of the quota settings on this metric for this consumer. - # An example name would be: - # `services/serviceconsumermanagement.googleapis.com/projects/123/quota/metrics/ - # compute.googleapis.com%2Fcpus - # The resource name is intended to be opaque and should not be parsed for - # its component strings, since its representation could change in the future. + # The resource name of the quota settings on this metric for this consumer. An + # example name would be: `services/serviceconsumermanagement.googleapis.com/ + # projects/123/quota/metrics/compute.googleapis.com%2Fcpus The resource name is + # intended to be opaque and should not be parsed for its component strings, + # since its representation could change in the future. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3654,9 +3040,9 @@ module Google end end - # Response message for the `DisableConsumer` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `DisableConsumer` method. This response message is + # assigned to the `response` field of the returned Operation when that operation + # is done. class V1Beta1DisableConsumerResponse include Google::Apis::Core::Hashable @@ -3669,9 +3055,9 @@ module Google end end - # Response message for the `EnableConsumer` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `EnableConsumer` method. This response message is + # assigned to the `response` field of the returned Operation when that operation + # is done. class V1Beta1EnableConsumerResponse include Google::Apis::Core::Hashable @@ -3684,9 +3070,9 @@ module Google end end - # Response message for the `GenerateServiceIdentity` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `GenerateServiceIdentity` method. This response + # message is assigned to the `response` field of the returned Operation when + # that operation is done. class V1Beta1GenerateServiceIdentityResponse include Google::Apis::Core::Hashable @@ -3709,11 +3095,11 @@ module Google class V1Beta1ImportProducerOverridesRequest include Google::Apis::Core::Hashable - # Whether to force the creation of the quota overrides. - # If creating an override would cause the effective quota for the consumer to - # decrease by more than 10 percent, the call is rejected, as a safety measure - # to avoid accidentally decreasing quota too quickly. Setting the force - # parameter to true ignores this restriction. + # Whether to force the creation of the quota overrides. If creating an override + # would cause the effective quota for the consumer to decrease by more than 10 + # percent, the call is rejected, as a safety measure to avoid accidentally + # decreasing quota too quickly. Setting the force parameter to true ignores this + # restriction. # Corresponds to the JSON property `force` # @return [Boolean] attr_accessor :force @@ -3782,8 +3168,7 @@ module Google # @return [Array] attr_accessor :metrics - # Token identifying which result to start with; returned by a previous list - # call. + # Token identifying which result to start with; returned by a previous list call. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -3803,8 +3188,7 @@ module Google class V1Beta1ListProducerOverridesResponse include Google::Apis::Core::Hashable - # Token identifying which result to start with; returned by a previous list - # call. + # Token identifying which result to start with; returned by a previous list call. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -3829,9 +3213,9 @@ module Google class V1Beta1OverrideInlineSource include Google::Apis::Core::Hashable - # The overrides to create. - # Each override must have a value for 'metric' and 'unit', to specify - # which metric and which limit the override should be applied to. + # The overrides to create. Each override must have a value for 'metric' and ' + # unit', to specify which metric and which limit the override should be applied + # to. # Corresponds to the JSON property `overrides` # @return [Array] attr_accessor :overrides @@ -3850,61 +3234,54 @@ module Google class V1Beta1ProducerQuotaPolicy include Google::Apis::Core::Hashable - # The cloud resource container at which the quota policy is created. The - # format is `container_type`/`container_number` + # The cloud resource container at which the quota policy is created. The format + # is `container_type`/`container_number` # Corresponds to the JSON property `container` # @return [String] attr_accessor :container - # If this map is nonempty, then this policy applies only to specific values - # for dimensions defined in the limit unit. - # For example, an policy on a limit with the unit 1/`project`/`region` - # could contain an entry with the key "region" and the value "us-east-1"; - # the policy is only applied to quota consumed in that region. - # This map has the following restrictions: - # * Keys that are not defined in the limit's unit are not valid keys. - # Any string appearing in `brackets` in the unit (besides `project` or - # `user`) is a defined key. - # * "project" is not a valid key; the project is already specified in - # the parent resource name. - # * "user" is not a valid key; the API does not support quota polcies - # that apply only to a specific user. - # * If "region" appears as a key, its value must be a valid Cloud region. - # * If "zone" appears as a key, its value must be a valid Cloud zone. - # * If any valid key other than "region" or "zone" appears in the map, then - # all valid keys other than "region" or "zone" must also appear in the + # If this map is nonempty, then this policy applies only to specific values for + # dimensions defined in the limit unit. For example, an policy on a limit with + # the unit 1/`project`/`region` could contain an entry with the key "region" and + # the value "us-east-1"; the policy is only applied to quota consumed in that + # region. This map has the following restrictions: * Keys that are not defined + # in the limit's unit are not valid keys. Any string appearing in `brackets` in + # the unit (besides `project` or `user`) is a defined key. * "project" is not a + # valid key; the project is already specified in the parent resource name. * " + # user" is not a valid key; the API does not support quota polcies that apply + # only to a specific user. * If "region" appears as a key, its value must be a + # valid Cloud region. * If "zone" appears as a key, its value must be a valid + # Cloud zone. * If any valid key other than "region" or "zone" appears in the + # map, then all valid keys other than "region" or "zone" must also appear in the # map. # Corresponds to the JSON property `dimensions` # @return [Hash] attr_accessor :dimensions - # The name of the metric to which this policy applies. - # An example name would be: + # The name of the metric to which this policy applies. An example name would be: # `compute.googleapis.com/cpus` # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric - # The resource name of the producer policy. - # An example name would be: - # `services/compute.googleapis.com/organizations/123/consumerQuotaMetrics/ - # compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/ + # The resource name of the producer policy. An example name would be: `services/ + # compute.googleapis.com/organizations/123/consumerQuotaMetrics/compute. + # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/ # 4a3f2c1d` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The quota policy value. - # Can be any nonnegative integer, or -1 (unlimited quota). + # The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota) + # . # Corresponds to the JSON property `policyValue` # @return [Fixnum] attr_accessor :policy_value - # The limit unit of the limit to which this policy applies. - # An example unit would be: - # `1/`project`/`region`` - # Note that ``project`` and ``region`` are not placeholders in this example; - # the literal characters ``` and ``` occur in the string. + # The limit unit of the limit to which this policy applies. An example unit + # would be: `1/`project`/`region`` Note that ``project`` and ``region`` are not + # placeholders in this example; the literal characters ``` and ``` occur in the + # string. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit @@ -3944,20 +3321,19 @@ module Google # @return [Fixnum] attr_accessor :default_limit - # The dimensions of this quota bucket. - # If this map is empty, this is the global bucket, which is the default quota - # value applied to all requests that do not have a more specific override. - # If this map is nonempty, the default limit, effective limit, and quota - # overrides apply only to requests that have the dimensions given in the map. - # For example, if the map has key "region" and value "us-east-1", then the - # specified effective limit is only effective in that region, and the - # specified overrides apply only in that region. + # The dimensions of this quota bucket. If this map is empty, this is the global + # bucket, which is the default quota value applied to all requests that do not + # have a more specific override. If this map is nonempty, the default limit, + # effective limit, and quota overrides apply only to requests that have the + # dimensions given in the map. For example, if the map has key "region" and + # value "us-east-1", then the specified effective limit is only effective in + # that region, and the specified overrides apply only in that region. # Corresponds to the JSON property `dimensions` # @return [Hash] attr_accessor :dimensions - # The effective limit of this quota bucket. Equal to default_limit if there - # are no overrides. + # The effective limit of this quota bucket. Equal to default_limit if there are + # no overrides. # Corresponds to the JSON property `effectiveLimit` # @return [Fixnum] attr_accessor :effective_limit @@ -3986,61 +3362,53 @@ module Google class V1Beta1QuotaOverride include Google::Apis::Core::Hashable - # The resource name of the ancestor that requested the override. For example: - # "organizations/12345" or "folders/67890". - # Used by admin overrides only. + # The resource name of the ancestor that requested the override. For example: " + # organizations/12345" or "folders/67890". Used by admin overrides only. # Corresponds to the JSON property `adminOverrideAncestor` # @return [String] attr_accessor :admin_override_ancestor # If this map is nonempty, then this override applies only to specific values - # for dimensions defined in the limit unit. - # For example, an override on a limit with the unit 1/`project`/`region` - # could contain an entry with the key "region" and the value "us-east-1"; - # the override is only applied to quota consumed in that region. - # This map has the following restrictions: - # * Keys that are not defined in the limit's unit are not valid keys. - # Any string appearing in `brackets` in the unit (besides `project` or - # `user`) is a defined key. - # * "project" is not a valid key; the project is already specified in - # the parent resource name. - # * "user" is not a valid key; the API does not support quota overrides - # that apply only to a specific user. - # * If "region" appears as a key, its value must be a valid Cloud region. - # * If "zone" appears as a key, its value must be a valid Cloud zone. - # * If any valid key other than "region" or "zone" appears in the map, then - # all valid keys other than "region" or "zone" must also appear in the - # map. + # for dimensions defined in the limit unit. For example, an override on a limit + # with the unit 1/`project`/`region` could contain an entry with the key "region" + # and the value "us-east-1"; the override is only applied to quota consumed in + # that region. This map has the following restrictions: * Keys that are not + # defined in the limit's unit are not valid keys. Any string appearing in ` + # brackets` in the unit (besides `project` or `user`) is a defined key. * " + # project" is not a valid key; the project is already specified in the parent + # resource name. * "user" is not a valid key; the API does not support quota + # overrides that apply only to a specific user. * If "region" appears as a key, + # its value must be a valid Cloud region. * If "zone" appears as a key, its + # value must be a valid Cloud zone. * If any valid key other than "region" or " + # zone" appears in the map, then all valid keys other than "region" or "zone" + # must also appear in the map. # Corresponds to the JSON property `dimensions` # @return [Hash] attr_accessor :dimensions - # The name of the metric to which this override applies. - # An example name would be: - # `compute.googleapis.com/cpus` + # The name of the metric to which this override applies. An example name would + # be: `compute.googleapis.com/cpus` # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric - # The resource name of the producer override. - # An example name would be: - # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. + # The resource name of the producer override. An example name would be: ` + # services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The overriding quota limit value. - # Can be any nonnegative integer, or -1 (unlimited quota). + # The overriding quota limit value. Can be any nonnegative integer, or -1 ( + # unlimited quota). # Corresponds to the JSON property `overrideValue` # @return [Fixnum] attr_accessor :override_value - # The limit unit of the limit to which this override applies. - # An example unit would be: - # `1/`project`/`region`` - # Note that ``project`` and ``region`` are not placeholders in this example; - # the literal characters ``` and ``` occur in the string. + # The limit unit of the limit to which this override applies. An example unit + # would be: `1/`project`/`region`` Note that ``project`` and ``region`` are not + # placeholders in this example; the literal characters ``` and ``` occur in the + # string. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit @@ -4060,9 +3428,9 @@ module Google end end - # Response message for the `RefreshConsumer` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `RefreshConsumer` method. This response message is + # assigned to the `response` field of the returned Operation when that operation + # is done. class V1Beta1RefreshConsumerResponse include Google::Apis::Core::Hashable @@ -4084,17 +3452,16 @@ module Google # @return [String] attr_accessor :email - # P4 service identity resource name. - # An example name would be: - # `services/serviceconsumermanagement.googleapis.com/projects/123/ - # serviceIdentities/default` + # P4 service identity resource name. An example name would be: `services/ + # serviceconsumermanagement.googleapis.com/projects/123/serviceIdentities/ + # default` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The P4 service identity configuration tag. This must be defined in - # activation_grants. If not specified when creating the account, the tag is - # set to "default". + # activation_grants. If not specified when creating the account, the tag is set + # to "default". # Corresponds to the JSON property `tag` # @return [String] attr_accessor :tag @@ -4117,9 +3484,9 @@ module Google end end - # Response message for the `AddVisibilityLabels` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `AddVisibilityLabels` method. This response message + # is assigned to the `response` field of the returned Operation when that + # operation is done. class V1beta1AddVisibilityLabelsResponse include Google::Apis::Core::Hashable @@ -4147,10 +3514,8 @@ module Google # @return [String] attr_accessor :email - # Default identity resource name. - # An example name would be: - # `services/serviceconsumermanagement.googleapis.com/projects/123/ - # defaultIdentity` + # Default identity resource name. An example name would be: `services/ + # serviceconsumermanagement.googleapis.com/projects/123/defaultIdentity` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4172,9 +3537,9 @@ module Google end end - # Response message for the `DisableConsumer` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `DisableConsumer` method. This response message is + # assigned to the `response` field of the returned Operation when that operation + # is done. class V1beta1DisableConsumerResponse include Google::Apis::Core::Hashable @@ -4187,9 +3552,9 @@ module Google end end - # Response message for the `EnableConsumer` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `EnableConsumer` method. This response message is + # assigned to the `response` field of the returned Operation when that operation + # is done. class V1beta1EnableConsumerResponse include Google::Apis::Core::Hashable @@ -4202,9 +3567,9 @@ module Google end end - # Response message for the `GenerateDefaultIdentity` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `GenerateDefaultIdentity` method. This response + # message is assigned to the `response` field of the returned Operation when + # that operation is done. class V1beta1GenerateDefaultIdentityResponse include Google::Apis::Core::Hashable @@ -4219,8 +3584,8 @@ module Google # @return [Google::Apis::ServiceconsumermanagementV1beta1::V1beta1DefaultIdentity] attr_accessor :identity - # Role attached to consumer project. Empty if not attached in this - # request. (Under development, currently always return empty.) + # Role attached to consumer project. Empty if not attached in this request. ( + # Under development, currently always return empty.) # Corresponds to the JSON property `role` # @return [String] attr_accessor :role @@ -4237,9 +3602,9 @@ module Google end end - # Response message for the `GenerateServiceAccount` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `GenerateServiceAccount` method. This response + # message is assigned to the `response` field of the returned Operation when + # that operation is done. class V1beta1GenerateServiceAccountResponse include Google::Apis::Core::Hashable @@ -4258,9 +3623,9 @@ module Google end end - # Response message for the `RefreshConsumer` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `RefreshConsumer` method. This response message is + # assigned to the `response` field of the returned Operation when that operation + # is done. class V1beta1RefreshConsumerResponse include Google::Apis::Core::Hashable @@ -4273,9 +3638,9 @@ module Google end end - # Response message for the `RemoveVisibilityLabels` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `RemoveVisibilityLabels` method. This response + # message is assigned to the `response` field of the returned Operation when + # that operation is done. class V1beta1RemoveVisibilityLabelsResponse include Google::Apis::Core::Hashable @@ -4308,16 +3673,14 @@ module Google # @return [String] attr_accessor :iam_account_name - # P4 SA resource name. - # An example name would be: - # `services/serviceconsumermanagement.googleapis.com/projects/123/ - # serviceAccounts/default` + # P4 SA resource name. An example name would be: `services/ + # serviceconsumermanagement.googleapis.com/projects/123/serviceAccounts/default` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The P4 SA configuration tag. This must be defined in activation_grants. - # If not specified when creating the account, the tag is set to "default". + # The P4 SA configuration tag. This must be defined in activation_grants. If not + # specified when creating the account, the tag is set to "default". # Corresponds to the JSON property `tag` # @return [String] attr_accessor :tag diff --git a/generated/google/apis/serviceconsumermanagement_v1beta1/service.rb b/generated/google/apis/serviceconsumermanagement_v1beta1/service.rb index 630b8f5a6..1302f1d85 100644 --- a/generated/google/apis/serviceconsumermanagement_v1beta1/service.rb +++ b/generated/google/apis/serviceconsumermanagement_v1beta1/service.rb @@ -47,9 +47,8 @@ module Google @batch_path = 'batch' 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 @@ -81,11 +80,9 @@ module Google # Retrieves a summary of quota information for a specific quota metric. # @param [String] name - # The resource name of the quota metric, returned by a - # ListConsumerQuotaMetrics call. - # An example name would be: - # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. - # googleapis.com%2Fcpus` + # The resource name of the quota metric, returned by a ListConsumerQuotaMetrics + # call. An example name would be: `services/compute.googleapis.com/projects/123/ + # consumerQuotaMetrics/compute.googleapis.com%2Fcpus` # @param [String] view # Specifies the level of detail for quota information in the response. # @param [String] fields @@ -116,13 +113,12 @@ module Google execute_or_queue_command(command, &block) end - # Create or update multiple producer overrides atomically, all on the - # same consumer, but on many different metrics or limits. - # The name field in the quota override message should not be set. + # Create or update multiple producer overrides atomically, all on the same + # consumer, but on many different metrics or limits. The name field in the quota + # override message should not be set. # @param [String] parent - # The resource name of the consumer. - # An example name would be: - # `services/compute.googleapis.com/projects/123` + # The resource name of the consumer. An example name would be: `services/compute. + # googleapis.com/projects/123` # @param [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ImportProducerOverridesRequest] v1_beta1_import_producer_overrides_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -154,20 +150,17 @@ module Google end # Retrieves a summary of all quota information about this consumer that is - # visible to the service producer, for each quota metric defined by the - # service. Each metric includes information about all of its defined limits. - # Each limit includes the limit configuration (quota unit, preciseness, - # default value), the current effective limit value, and all of the overrides - # applied to the limit. + # visible to the service producer, for each quota metric defined by the service. + # Each metric includes information about all of its defined limits. Each limit + # includes the limit configuration (quota unit, preciseness, default value), the + # current effective limit value, and all of the overrides applied to the limit. # @param [String] parent - # Parent of the quotas resource. - # An example parent would be: - # `services/serviceconsumermanagement.googleapis.com/projects/123` + # Parent of the quotas resource. An example parent would be: `services/ + # serviceconsumermanagement.googleapis.com/projects/123` # @param [Fixnum] page_size # Requested size of the next page of data. # @param [String] page_token - # Token identifying which result to start with; returned by a previous list - # call. + # Token identifying which result to start with; returned by a previous list call. # @param [String] view # Specifies the level of detail for quota information in the response. # @param [String] fields @@ -202,11 +195,10 @@ module Google # Retrieves a summary of quota information for a specific quota limit. # @param [String] name - # The resource name of the quota limit, returned by a - # ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. - # An example name would be: - # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. - # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` + # The resource name of the quota limit, returned by a ListConsumerQuotaMetrics + # or GetConsumerQuotaMetric call. An example name would be: `services/compute. + # googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/ + # limits/%2Fproject%2Fregion` # @param [String] view # Specifies the level of detail for quota information in the response. # @param [String] fields @@ -237,27 +229,25 @@ module Google execute_or_queue_command(command, &block) end - # Creates a producer override. - # A producer override is applied by the owner or administrator of a service - # to increase or decrease the amount of quota a consumer of the service is - # allowed to use. - # To create multiple overrides at once, use ImportProducerOverrides instead. - # If an override with the specified dimensions already exists, this call will - # fail. To overwrite an existing override if one is already present ("upsert" - # semantics), use ImportProducerOverrides instead. + # Creates a producer override. A producer override is applied by the owner or + # administrator of a service to increase or decrease the amount of quota a + # consumer of the service is allowed to use. To create multiple overrides at + # once, use ImportProducerOverrides instead. If an override with the specified + # dimensions already exists, this call will fail. To overwrite an existing + # override if one is already present ("upsert" semantics), use + # ImportProducerOverrides instead. # @param [String] parent # The resource name of the parent quota limit, returned by a - # ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. - # An example name would be: - # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. + # ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example name would + # be: `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` # @param [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride] v1_beta1_quota_override_object # @param [Boolean] force - # Whether to force the creation of the quota override. - # If creating an override would cause the effective quota for the consumer to - # decrease by more than 10 percent, the call is rejected, as a safety measure - # to avoid accidentally decreasing quota too quickly. Setting the force - # parameter to true ignores this restriction. + # Whether to force the creation of the quota override. If creating an override + # would cause the effective quota for the consumer to decrease by more than 10 + # percent, the call is rejected, as a safety measure to avoid accidentally + # decreasing quota too quickly. Setting the force parameter to true ignores this + # restriction. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -290,16 +280,15 @@ module Google # Deletes a producer override. # @param [String] name - # The resource name of the override to delete. - # An example name would be: - # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. + # The resource name of the override to delete. An example name would be: ` + # services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` # @param [Boolean] force - # Whether to force the deletion of the quota override. - # If deleting an override would cause the effective quota for the consumer to - # decrease by more than 10 percent, the call is rejected, as a safety measure - # to avoid accidentally decreasing quota too quickly. Setting the force - # parameter to true ignores this restriction. + # Whether to force the deletion of the quota override. If deleting an override + # would cause the effective quota for the consumer to decrease by more than 10 + # percent, the call is rejected, as a safety measure to avoid accidentally + # decreasing quota too quickly. Setting the force parameter to true ignores this + # restriction. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -331,15 +320,13 @@ module Google # Lists all producer overrides on this limit. # @param [String] parent # The resource name of the parent quota limit, returned by a - # ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. - # An example name would be: - # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. + # ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example name would + # be: `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` # @param [Fixnum] page_size # Requested size of the next page of data. # @param [String] page_token - # Token identifying which result to start with; returned by a previous list - # call. + # Token identifying which result to start with; returned by a previous list call. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -371,17 +358,16 @@ module Google # Updates a producer override. # @param [String] name - # The resource name of the override to update. - # An example name would be: - # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. + # The resource name of the override to update. An example name would be: ` + # services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` # @param [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride] v1_beta1_quota_override_object # @param [Boolean] force - # Whether to force the update of the quota override. - # If updating an override would cause the effective quota for the consumer to - # decrease by more than 10 percent, the call is rejected, as a safety measure - # to avoid accidentally decreasing quota too quickly. Setting the force - # parameter to true ignores this restriction. + # Whether to force the update of the quota override. If updating an override + # would cause the effective quota for the consumer to decrease by more than 10 + # percent, the call is rejected, as a safety measure to avoid accidentally + # decreasing quota too quickly. Setting the force parameter to true ignores this + # restriction. # @param [String] update_mask # Update only the specified fields. If unset, all modifiable fields will be # updated. diff --git a/generated/google/apis/servicenetworking_v1.rb b/generated/google/apis/servicenetworking_v1.rb index 02460551c..b14e47df7 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 = '20200721' + REVISION = '20200801' # 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 bb3cc76b8..c72d583fb 100644 --- a/generated/google/apis/servicenetworking_v1/classes.rb +++ b/generated/google/apis/servicenetworking_v1/classes.rb @@ -42,9 +42,8 @@ module Google include Google::Apis::Core::Hashable # Required. The network that the consumer is using to connect with services. - # Must be in the form of projects/`project`/global/networks/`network` - # `project` is the project number, as in '12345' - # `network` is the network name. + # Must be in the form of projects/`project`/global/networks/`network` `project` + # is the project number, as in '12345' `network` is the network name. # Corresponds to the JSON property `consumerNetwork` # @return [String] attr_accessor :consumer_network @@ -55,8 +54,7 @@ module Google attr_accessor :dns_record_set # Required. The name of the private DNS zone in the shared producer host project - # to - # which the record set will be added. + # to which the record set will be added. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -93,9 +91,8 @@ module Google include Google::Apis::Core::Hashable # Required. The network that the consumer is using to connect with services. - # Must be in the form of projects/`project`/global/networks/`network` - # `project` is the project number, as in '12345' - # `network` is the network name. + # Must be in the form of projects/`project`/global/networks/`network` `project` + # is the project number, as in '12345' `network` is the network name. # Corresponds to the JSON property `consumerNetwork` # @return [String] attr_accessor :consumer_network @@ -106,9 +103,8 @@ module Google attr_accessor :dns_suffix # Required. The name for both the private zone in the shared producer host - # project and - # the peering zone in the consumer project. Must be unique within both - # projects. The name must be 1-63 characters long, must begin with a letter, + # project and the peering zone in the consumer project. Must be unique within + # both projects. The name must be 1-63 characters long, must begin with a letter, # end with a letter or digit, and only contain lowercase letters, digits or # dashes. # Corresponds to the JSON property `name` @@ -167,16 +163,14 @@ module Google end end - # Request for AddRoles to allow Service Producers to add roles in the shared - # VPC host project for them to use. + # Request for AddRoles to allow Service Producers to add roles in the shared VPC + # host project for them to use. class AddRolesRequest include Google::Apis::Core::Hashable # Required. The network that the consumer is using to connect with services. - # Must be in - # the form of projects/`project`/global/networks/`network` - # `project` is a project number, as in '12345' - # `network` is a network name. + # Must be in the form of projects/`project`/global/networks/`network` `project` + # is a project number, as in '12345' `network` is a network name. # Corresponds to the JSON property `consumerNetwork` # @return [String] attr_accessor :consumer_network @@ -221,21 +215,20 @@ module Google class AddSubnetworkRequest include Google::Apis::Core::Hashable - # Required. A resource that represents the service consumer, such as - # `projects/123456`. The project number can be different from the - # value in the consumer network parameter. For example, the network might be - # part of a Shared VPC network. In those cases, Service Networking validates - # that this resource belongs to that Shared VPC. + # Required. A resource that represents the service consumer, such as `projects/ + # 123456`. The project number can be different from the value in the consumer + # network parameter. For example, the network might be part of a Shared VPC + # network. In those cases, Service Networking validates that this resource + # belongs to that Shared VPC. # Corresponds to the JSON property `consumer` # @return [String] attr_accessor :consumer - # Required. The name of the service consumer's VPC network. The network - # must have an existing private connection that was provisioned through the - # connections.create method. The name must be in the following format: - # `projects/`project`/global/networks/`network``, where `project` - # is a project number, such as `12345`. `network` is the name of a - # VPC network in the project. + # Required. The name of the service consumer's VPC network. The network must + # have an existing private connection that was provisioned through the + # connections.create method. The name must be in the following format: `projects/ + # `project`/global/networks/`network``, where `project` is a project number, + # such as `12345`. `network` is the name of a VPC network in the project. # Corresponds to the JSON property `consumerNetwork` # @return [String] attr_accessor :consumer_network @@ -245,46 +238,46 @@ module Google # @return [String] attr_accessor :description - # Required. The prefix length of the subnet's IP address range. Use CIDR - # range notation, such as `30` to provision a subnet with an - # `x.x.x.x/30` CIDR range. The IP address range is drawn from a - # pool of available ranges in the service consumer's allocated range. + # Required. The prefix length of the subnet's IP address range. Use CIDR range + # notation, such as `30` to provision a subnet with an `x.x.x.x/30` CIDR range. + # The IP address range is drawn from a pool of available ranges in the service + # consumer's allocated range. # Corresponds to the JSON property `ipPrefixLength` # @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. + # 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`. + # Required. The name of a [region](/compute/docs/regions-zones) for the subnet, + # such `europe-west1`. # Corresponds to the JSON property `region` # @return [String] attr_accessor :region - # Optional. The starting address of a range. The address must be a valid - # IPv4 address in the x.x.x.x format. This value combined with the IP prefix - # range is the CIDR range for the subnet. The range must be within the - # allocated range that is assigned to the private connection. If the CIDR - # range isn't available, the call fails. + # Optional. The starting address of a range. The address must be a valid IPv4 + # address in the x.x.x.x format. This value combined with the IP prefix range is + # the CIDR range for the subnet. The range must be within the allocated range + # that is assigned to the private connection. If the CIDR range isn't available, + # the call fails. # Corresponds to the JSON property `requestedAddress` # @return [String] attr_accessor :requested_address # Required. A name for the new subnet. For information about the naming - # requirements, see [subnetwork](/compute/docs/reference/rest/v1/subnetworks) - # in the Compute API documentation. + # requirements, see [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in + # the Compute API documentation. # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork - # A list of members that are granted the `compute.networkUser` - # role on the subnet. + # A list of members that are granted the `compute.networkUser` role on the + # subnet. # Corresponds to the JSON property `subnetworkUsers` # @return [Array] attr_accessor :subnetwork_users @@ -307,14 +300,13 @@ module Google end end - # Api is a light-weight descriptor for an API Interface. - # Interfaces are also described as "protocol buffer services" in some contexts, - # such as by the "service" keyword in a .proto file, but they are different - # from API Services, which represent a concrete implementation of an interface - # as opposed to simply a description of methods and bindings. They are also - # sometimes simply referred to as "APIs" in other contexts, such as the name of - # this message itself. See https://cloud.google.com/apis/design/glossary for - # detailed terminology. + # Api is a light-weight descriptor for an API Interface. Interfaces are also + # described as "protocol buffer services" in some contexts, such as by the " + # service" keyword in a .proto file, but they are different from API Services, + # which represent a concrete implementation of an interface as opposed to simply + # a description of methods and bindings. They are also sometimes simply referred + # to as "APIs" in other contexts, such as the name of this message itself. See + # https://cloud.google.com/apis/design/glossary for detailed terminology. class Api include Google::Apis::Core::Hashable @@ -328,8 +320,8 @@ module Google # @return [Array] attr_accessor :mixins - # The fully qualified name of this interface, including package name - # followed by the interface's simple name. + # The fully qualified name of this interface, including package name followed by + # the interface's simple name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -339,8 +331,8 @@ module Google # @return [Array] attr_accessor :options - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. # Corresponds to the JSON property `sourceContext` # @return [Google::Apis::ServicenetworkingV1::SourceContext] attr_accessor :source_context @@ -350,23 +342,19 @@ module Google # @return [String] attr_accessor :syntax - # A version string for this interface. If specified, must have the form - # `major-version.minor-version`, as in `1.10`. If the minor version is - # omitted, it defaults to zero. If the entire version field is empty, the - # major version is derived from the package name, as outlined below. If the - # field is not empty, the version in the package name will be verified to be - # consistent with what is provided here. - # The versioning schema uses [semantic - # versioning](http://semver.org) where the major version number - # indicates a breaking change and the minor version an additive, - # non-breaking change. Both version numbers are signals to users - # what to expect from different versions, and should be carefully - # chosen based on the product plan. - # The major version is also reflected in the package name of the - # interface, which must end in `v`, as in - # `google.feature.v1`. For major versions 0 and 1, the suffix can - # be omitted. Zero major versions must only be used for - # experimental, non-GA interfaces. + # A version string for this interface. If specified, must have the form `major- + # version.minor-version`, as in `1.10`. If the minor version is omitted, it + # defaults to zero. If the entire version field is empty, the major version is + # derived from the package name, as outlined below. If the field is not empty, + # the version in the package name will be verified to be consistent with what is + # provided here. The versioning schema uses [semantic versioning](http://semver. + # org) where the major version number indicates a breaking change and the minor + # version an additive, non-breaking change. Both version numbers are signals to + # users what to expect from different versions, and should be carefully chosen + # based on the product plan. The major version is also reflected in the package + # name of the interface, which must end in `v`, as in `google.feature.v1`. For + # major versions 0 and 1, the suffix can be omitted. Zero major versions must + # only be used for experimental, non-GA interfaces. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -387,85 +375,63 @@ module Google end end - # Configuration for an authentication provider, including support for - # [JSON Web Token - # (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + # Configuration for an authentication provider, including support for [JSON Web + # Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). class AuthProvider include Google::Apis::Core::Hashable - # The list of JWT - # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32# - # section-4.1.3). - # that are allowed to access. A JWT containing any of these audiences will - # be accepted. When this setting is absent, JWTs with audiences: - # - "https://[service.name]/[google.protobuf.Api.name]" - # - "https://[service.name]/" - # will be accepted. - # For example, if no audiences are in the setting, LibraryService API will - # accept JWTs with the following audiences: - # - + # The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json- + # web-token-32#section-4.1.3). that are allowed to access. A JWT containing any + # of these audiences will be accepted. When this setting is absent, JWTs with + # audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[ + # service.name]/" will be accepted. For example, if no audiences are in the + # setting, LibraryService API will accept JWTs with the following audiences: - # https://library-example.googleapis.com/google.example.library.v1. - # LibraryService - # - https://library-example.googleapis.com/ - # Example: - # audiences: bookstore_android.apps.googleusercontent.com, - # bookstore_web.apps.googleusercontent.com + # LibraryService - https://library-example.googleapis.com/ Example: audiences: + # bookstore_android.apps.googleusercontent.com, bookstore_web.apps. + # googleusercontent.com # Corresponds to the JSON property `audiences` # @return [String] attr_accessor :audiences - # Redirect URL if JWT token is required but not present or is expired. - # Implement authorizationUrl of securityDefinitions in OpenAPI spec. + # Redirect URL if JWT token is required but not present or is expired. Implement + # authorizationUrl of securityDefinitions in OpenAPI spec. # Corresponds to the JSON property `authorizationUrl` # @return [String] attr_accessor :authorization_url - # The unique identifier of the auth provider. It will be referred to by - # `AuthRequirement.provider_id`. - # Example: "bookstore_auth". + # The unique identifier of the auth provider. It will be referred to by ` + # AuthRequirement.provider_id`. Example: "bookstore_auth". # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Identifies the principal that issued the JWT. See - # https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - # Usually a URL or an email address. - # Example: https://securetoken.google.com - # Example: 1234567-compute@developer.gserviceaccount.com + # Identifies the principal that issued the JWT. See https://tools.ietf.org/html/ + # draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email + # address. Example: https://securetoken.google.com Example: 1234567-compute@ + # developer.gserviceaccount.com # Corresponds to the JSON property `issuer` # @return [String] attr_accessor :issuer - # URL of the provider's public key set to validate signature of the JWT. See - # [OpenID - # Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html# - # ProviderMetadata). - # Optional if the key set document: - # - can be retrieved from - # [OpenID - # Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of - # the issuer. - # - can be inferred from the email domain of the issuer (e.g. a Google - # service account). - # Example: https://www.googleapis.com/oauth2/v1/certs + # URL of the provider's public key set to validate signature of the JWT. See [ + # OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html# + # ProviderMetadata). Optional if the key set document: - can be retrieved from [ + # OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html + # of the issuer. - can be inferred from the email domain of the issuer (e.g. a + # Google service account). Example: https://www.googleapis.com/oauth2/v1/certs # Corresponds to the JSON property `jwksUri` # @return [String] attr_accessor :jwks_uri - # Defines the locations to extract the JWT. - # JWT locations can be either from HTTP headers or URL query parameters. - # The rule is that the first match wins. The checking order is: checking - # all headers first, then URL query parameters. - # If not specified, default to use following 3 locations: - # 1) Authorization: Bearer - # 2) x-goog-iap-jwt-assertion - # 3) access_token query parameter - # Default locations can be specified as followings: - # jwt_locations: - # - header: Authorization - # value_prefix: "Bearer " - # - header: x-goog-iap-jwt-assertion - # - query: access_token + # Defines the locations to extract the JWT. JWT locations can be either from + # HTTP headers or URL query parameters. The rule is that the first match wins. + # The checking order is: checking all headers first, then URL query parameters. + # If not specified, default to use following 3 locations: 1) Authorization: + # Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default + # locations can be specified as followings: jwt_locations: - header: + # Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - + # query: access_token # Corresponds to the JSON property `jwtLocations` # @return [Array] attr_accessor :jwt_locations @@ -485,34 +451,26 @@ module Google end end - # User-defined authentication requirements, including support for - # [JSON Web Token - # (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + # User-defined authentication requirements, including support for [JSON Web + # Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). class AuthRequirement include Google::Apis::Core::Hashable - # NOTE: This will be deprecated soon, once AuthProvider.audiences is - # implemented and accepted in all the runtime components. - # The list of JWT - # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32# - # section-4.1.3). - # that are allowed to access. A JWT containing any of these audiences will - # be accepted. When this setting is absent, only JWTs with audience - # "https://Service_name/API_name" - # will be accepted. For example, if no audiences are in the setting, - # LibraryService API will only accept JWTs with the following audience - # "https://library-example.googleapis.com/google.example.library.v1. - # LibraryService". - # Example: - # audiences: bookstore_android.apps.googleusercontent.com, - # bookstore_web.apps.googleusercontent.com + # NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented + # and accepted in all the runtime components. The list of JWT [audiences](https:/ + # /tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that + # are allowed to access. A JWT containing any of these audiences will be + # accepted. When this setting is absent, only JWTs with audience "https:// + # Service_name/API_name" will be accepted. For example, if no audiences are in + # the setting, LibraryService API will only accept JWTs with the following + # audience "https://library-example.googleapis.com/google.example.library.v1. + # LibraryService". Example: audiences: bookstore_android.apps.googleusercontent. + # com, bookstore_web.apps.googleusercontent.com # Corresponds to the JSON property `audiences` # @return [String] attr_accessor :audiences - # id from authentication provider. - # Example: - # provider_id: bookstore_auth + # id from authentication provider. Example: provider_id: bookstore_auth # Corresponds to the JSON property `providerId` # @return [String] attr_accessor :provider_id @@ -528,18 +486,11 @@ module Google end end - # `Authentication` defines the authentication configuration for an API. - # Example for an API targeted for external use: - # name: calendar.googleapis.com - # authentication: - # providers: - # - id: google_calendar_auth - # jwks_uri: https://www.googleapis.com/oauth2/v1/certs - # issuer: https://securetoken.google.com - # rules: - # - selector: "*" - # requirements: - # provider_id: google_calendar_auth + # `Authentication` defines the authentication configuration for an API. Example + # for an API targeted for external use: name: calendar.googleapis.com + # authentication: providers: - id: google_calendar_auth jwks_uri: https://www. + # googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - + # selector: "*" requirements: provider_id: google_calendar_auth class Authentication include Google::Apis::Core::Hashable @@ -548,8 +499,8 @@ module Google # @return [Array] attr_accessor :providers - # A list of authentication rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of authentication rules that apply to individual API methods. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -565,13 +516,11 @@ module Google end end - # Authentication rules for the service. - # By default, if a method has any authentication requirements, every request - # must include a valid credential matching one of the requirements. - # It's an error to include more than one kind of credential in a single - # request. - # If a method doesn't have any auth requirements, request credentials will be - # ignored. + # Authentication rules for the service. By default, if a method has any + # authentication requirements, every request must include a valid credential + # matching one of the requirements. It's an error to include more than one kind + # of credential in a single request. If a method doesn't have any auth + # requirements, request credentials will be ignored. class AuthenticationRule include Google::Apis::Core::Hashable @@ -582,19 +531,18 @@ module Google alias_method :allow_without_credential?, :allow_without_credential # OAuth scopes are a way to define data and permissions on data. For example, - # there are scopes defined for "Read-only access to Google Calendar" and - # "Access to Cloud Platform". Users can consent to a scope for an application, - # giving it permission to access that data on their behalf. - # OAuth scope specifications should be fairly coarse grained; a user will need - # to see and understand the text description of what your scope means. - # In most cases: use one or at most two OAuth scopes for an entire family of - # products. If your product has multiple APIs, you should probably be sharing - # the OAuth scope across all of those APIs. - # When you need finer grained OAuth consent screens: talk with your product - # management about how developers will use them in practice. - # Please note that even though each of the canonical scopes is enough for a - # request to be accepted and passed to the backend, a request can still fail - # due to the backend requiring additional scopes or permissions. + # there are scopes defined for "Read-only access to Google Calendar" and "Access + # to Cloud Platform". Users can consent to a scope for an application, giving it + # permission to access that data on their behalf. OAuth scope specifications + # should be fairly coarse grained; a user will need to see and understand the + # text description of what your scope means. In most cases: use one or at most + # two OAuth scopes for an entire family of products. If your product has + # multiple APIs, you should probably be sharing the OAuth scope across all of + # those APIs. When you need finer grained OAuth consent screens: talk with your + # product management about how developers will use them in practice. Please note + # that even though each of the canonical scopes is enough for a request to be + # accepted and passed to the backend, a request can still fail due to the + # backend requiring additional scopes or permissions. # Corresponds to the JSON property `oauth` # @return [Google::Apis::ServicenetworkingV1::OAuthRequirements] attr_accessor :oauth @@ -604,8 +552,8 @@ module Google # @return [Array] attr_accessor :requirements - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -627,8 +575,8 @@ module Google class Backend include Google::Apis::Core::Hashable - # A list of API backend rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of API backend rules that apply to individual API methods. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -647,21 +595,13 @@ module Google class BackendRule include Google::Apis::Core::Hashable - # The address of the API backend. - # The scheme is used to determine the backend protocol and security. - # The following schemes are accepted: - # SCHEME PROTOCOL SECURITY - # http:// HTTP None - # https:// HTTP TLS - # grpc:// gRPC None - # grpcs:// gRPC TLS - # It is recommended to explicitly include a scheme. Leaving out the scheme - # may cause constrasting behaviors across platforms. - # If the port is unspecified, the default is: - # - 80 for schemes without TLS - # - 443 for schemes with TLS - # For HTTP backends, use protocol - # to specify the protocol version. + # The address of the API backend. The scheme is used to determine the backend + # protocol and security. The following schemes are accepted: SCHEME PROTOCOL + # SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC + # TLS It is recommended to explicitly include a scheme. Leaving out the scheme + # may cause constrasting behaviors across platforms. If the port is unspecified, + # the default is: - 80 for schemes without TLS - 443 for schemes with TLS For + # HTTP backends, use protocol to specify the protocol version. # Corresponds to the JSON property `address` # @return [String] attr_accessor :address @@ -672,18 +612,18 @@ module Google # @return [Float] attr_accessor :deadline - # When disable_auth is true, a JWT ID token won't be generated and the - # original "Authorization" HTTP header will be preserved. If the header is - # used to carry the original token and is expected by the backend, this - # field must be set to true to preserve the header. + # When disable_auth is true, a JWT ID token won't be generated and the original " + # Authorization" HTTP header will be preserved. If the header is used to carry + # the original token and is expected by the backend, this field must be set to + # true to preserve the header. # Corresponds to the JSON property `disableAuth` # @return [Boolean] attr_accessor :disable_auth alias_method :disable_auth?, :disable_auth - # The JWT audience is used when generating a JWT ID token for the backend. - # This ID token will be added in the HTTP "authorization" header, and sent - # to the backend. + # The JWT audience is used when generating a JWT ID token for the backend. This + # ID token will be added in the HTTP "authorization" header, and sent to the + # backend. # Corresponds to the JSON property `jwtAudience` # @return [String] attr_accessor :jwt_audience @@ -694,8 +634,8 @@ module Google # @return [Float] attr_accessor :min_deadline - # The number of seconds to wait for the completion of a long running - # operation. The default is no deadline. + # The number of seconds to wait for the completion of a long running operation. + # The default is no deadline. # Corresponds to the JSON property `operationDeadline` # @return [Float] attr_accessor :operation_deadline @@ -705,29 +645,21 @@ module Google # @return [String] attr_accessor :path_translation - # The protocol used for sending a request to the backend. - # The supported values are "http/1.1" and "h2". - # The default value is inferred from the scheme in the - # address field: - # SCHEME PROTOCOL - # http:// http/1.1 - # https:// http/1.1 - # grpc:// h2 - # grpcs:// h2 - # For secure HTTP backends (https://) that support HTTP/2, set this field - # to "h2" for improved performance. - # Configuring this field to non-default values is only supported for secure - # HTTP backends. This field will be ignored for all other backends. - # See - # https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype- - # values.xhtml#alpn-protocol-ids - # for more details on the supported values. + # The protocol used for sending a request to the backend. The supported values + # are "http/1.1" and "h2". The default value is inferred from the scheme in the + # address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 + # grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this + # field to "h2" for improved performance. Configuring this field to non-default + # values is only supported for secure HTTP backends. This field will be ignored + # for all other backends. See https://www.iana.org/assignments/tls-extensiontype- + # values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on + # the supported values. # Corresponds to the JSON property `protocol` # @return [String] attr_accessor :protocol - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -750,42 +682,28 @@ module Google end end - # Billing related configuration of the service. - # The following example shows how to configure monitored resources and metrics - # for billing, `consumer_destinations` is the only supported destination and - # the monitored resources need at least one label key - # `cloud.googleapis.com/location` to indicate the location of the billing - # usage, using different monitored resources between monitoring and billing is - # recommended so they can be evolved independently: - # monitored_resources: - # - type: library.googleapis.com/billing_branch - # labels: - # - key: cloud.googleapis.com/location - # description: | - # Predefined label to support billing location restriction. - # - key: city - # description: | - # Custom label to define the city where the library branch is located - # in. - # - key: name - # description: Custom label to define the name of the library branch. - # metrics: - # - name: library.googleapis.com/book/borrowed_count - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # billing: - # consumer_destinations: - # - monitored_resource: library.googleapis.com/billing_branch - # metrics: - # - library.googleapis.com/book/borrowed_count + # Billing related configuration of the service. The following example shows how + # to configure monitored resources and metrics for billing, ` + # consumer_destinations` is the only supported destination and the monitored + # resources need at least one label key `cloud.googleapis.com/location` to + # indicate the location of the billing usage, using different monitored + # resources between monitoring and billing is recommended so they can be evolved + # independently: monitored_resources: - type: library.googleapis.com/ + # billing_branch labels: - key: cloud.googleapis.com/location description: | + # Predefined label to support billing location restriction. - key: city + # description: | Custom label to define the city where the library branch is + # located in. - key: name description: Custom label to define the name of the + # library branch. metrics: - name: library.googleapis.com/book/borrowed_count + # metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: + # - monitored_resource: library.googleapis.com/billing_branch metrics: - library. + # googleapis.com/book/borrowed_count class Billing include Google::Apis::Core::Hashable - # Billing configurations for sending metrics to the consumer project. - # There can be multiple consumer destinations per service, each one must have - # a different monitored resource type. A metric can be used in at most - # one consumer destination. + # Billing configurations for sending metrics to the consumer project. There can + # be multiple consumer destinations per service, each one must have a different + # monitored resource type. A metric can be used in at most one consumer + # destination. # Corresponds to the JSON property `consumerDestinations` # @return [Array] attr_accessor :consumer_destinations @@ -800,19 +718,19 @@ module Google end end - # Configuration of a specific billing destination (Currently only support - # bill against consumer project). + # Configuration of a specific billing destination (Currently only support bill + # against consumer project). class BillingDestination include Google::Apis::Core::Hashable - # Names of the metrics to report to this billing destination. - # Each name must be defined in Service.metrics section. + # Names of the metrics to report to this billing destination. Each name must be + # defined in Service.metrics section. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics - # The monitored resource type. The type must be defined in - # Service.monitored_resources section. + # The monitored resource type. The type must be defined in Service. + # monitored_resources section. # Corresponds to the JSON property `monitoredResource` # @return [String] attr_accessor :monitored_resource @@ -848,37 +766,33 @@ module Google include Google::Apis::Core::Hashable # The name of service consumer's VPC network that's connected with service - # producer network, in the following format: - # `projects/`project`/global/networks/`network``. - # ``project`` is a project number, such as in `12345` that includes - # the VPC service consumer's VPC network. ``network`` is the name of the - # service consumer's VPC network. + # producer network, in the following format: `projects/`project`/global/networks/ + # `network``. ``project`` is a project number, such as in `12345` that includes + # the VPC service consumer's VPC network. ``network`` is the name of the service + # consumer's VPC network. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network # Output only. The name of the VPC Network Peering connection that was created - # by the - # service producer. + # by the service producer. # Corresponds to the JSON property `peering` # @return [String] attr_accessor :peering - # The name of one or more allocated IP address ranges for this service - # producer of type `PEERING`. - # Note that invoking CreateConnection method with a different range when - # connection is already established will not modify already provisioned - # service producer subnetworks. - # If CreateConnection method is invoked repeatedly to reconnect when peering - # connection had been disconnected on the consumer side, leaving this field - # empty will restore previously allocated IP ranges. + # The name of one or more allocated IP address ranges for this service producer + # of type `PEERING`. Note that invoking CreateConnection method with a different + # range when connection is already established will not modify already + # provisioned service producer subnetworks. If CreateConnection method is + # invoked repeatedly to reconnect when peering connection had been disconnected + # on the consumer side, leaving this field empty will restore previously + # allocated IP ranges. # Corresponds to the JSON property `reservedPeeringRanges` # @return [Array] attr_accessor :reserved_peering_ranges # Output only. The name of the peering service that's associated with this - # connection, in - # the following format: `services/`service name``. + # connection, in the following format: `services/`service name``. # Corresponds to the JSON property `service` # @return [String] attr_accessor :service @@ -901,9 +815,8 @@ module Google include Google::Apis::Core::Hashable # Required. Project number of the consumer that is launching the service - # instance. It - # can own the network that is peered with Google or, be a service project in - # an XPN where the host project has the network. + # instance. It can own the network that is peered with Google or, be a service + # project in an XPN where the host project has the network. # Corresponds to the JSON property `projectNum` # @return [Fixnum] attr_accessor :project_num @@ -918,39 +831,24 @@ module Google end end - # `Context` defines which contexts an API requests. - # Example: - # context: - # rules: - # - selector: "*" - # requested: - # - google.rpc.context.ProjectContext - # - google.rpc.context.OriginContext - # The above specifies that all methods in the API request - # `google.rpc.context.ProjectContext` and - # `google.rpc.context.OriginContext`. - # Available context types are defined in package - # `google.rpc.context`. - # This also provides mechanism to whitelist any protobuf message extension that - # can be sent in grpc metadata using “x-goog-ext--bin” and - # “x-goog-ext--jspb” format. For example, list any service - # specific protobuf types that can appear in grpc metadata as follows in your - # yaml file: - # Example: - # context: - # rules: - # - selector: "google.example.library.v1.LibraryService.CreateBook" - # allowed_request_extensions: - # - google.foo.v1.NewExtension - # allowed_response_extensions: - # - google.foo.v1.NewExtension - # You can also specify extension ID instead of fully qualified extension name - # here. + # `Context` defines which contexts an API requests. Example: context: rules: - + # selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc. + # context.OriginContext The above specifies that all methods in the API request ` + # google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. + # Available context types are defined in package `google.rpc.context`. This also + # provides mechanism to whitelist any protobuf message extension that can be + # sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. + # For example, list any service specific protobuf types that can appear in grpc + # metadata as follows in your yaml file: Example: context: rules: - selector: " + # google.example.library.v1.LibraryService.CreateBook" + # allowed_request_extensions: - google.foo.v1.NewExtension + # allowed_response_extensions: - google.foo.v1.NewExtension You can also specify + # extension ID instead of fully qualified extension name here. class Context include Google::Apis::Core::Hashable - # A list of RPC context rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of RPC context rules that apply to individual API methods. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -970,14 +868,14 @@ module Google class ContextRule include Google::Apis::Core::Hashable - # A list of full type names or extension IDs of extensions allowed in grpc - # side channel from client to backend. + # A list of full type names or extension IDs of extensions allowed in grpc side + # channel from client to backend. # Corresponds to the JSON property `allowedRequestExtensions` # @return [Array] attr_accessor :allowed_request_extensions - # A list of full type names or extension IDs of extensions allowed in grpc - # side channel from backend to client. + # A list of full type names or extension IDs of extensions allowed in grpc side + # channel from backend to client. # Corresponds to the JSON property `allowedResponseExtensions` # @return [Array] attr_accessor :allowed_response_extensions @@ -992,8 +890,8 @@ module Google # @return [Array] attr_accessor :requested - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -1012,14 +910,14 @@ module Google end end - # Selects and configures the service controller used by the service. The - # service controller handles features like abuse, quota, billing, logging, - # monitoring, etc. + # Selects and configures the service controller used by the service. The service + # controller handles features like abuse, quota, billing, logging, monitoring, + # etc. class Control include Google::Apis::Core::Hashable - # The service control environment to use. If empty, no control plane - # feature (like quota and billing) will be enabled. + # The service control environment to use. If empty, no control plane feature ( + # like quota and billing) will be enabled. # Corresponds to the JSON property `environment` # @return [String] attr_accessor :environment @@ -1034,19 +932,15 @@ module Google end end - # Customize service error responses. For example, list any service - # specific protobuf types that can appear in error detail lists of - # error responses. - # Example: - # custom_error: - # types: - # - google.foo.v1.CustomError - # - google.foo.v1.AnotherError + # Customize service error responses. For example, list any service specific + # protobuf types that can appear in error detail lists of error responses. + # Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1. + # AnotherError class CustomError include Google::Apis::Core::Hashable - # The list of custom error rules that apply to individual API messages. - # **NOTE:** All service configuration rules follow "last one wins" order. + # The list of custom error rules that apply to individual API messages. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -1071,15 +965,15 @@ module Google class CustomErrorRule include Google::Apis::Core::Hashable - # Mark this message as possible payload in error response. Otherwise, - # objects of this type will be filtered when they appear in error payload. + # Mark this message as possible payload in error response. Otherwise, objects of + # this type will be filtered when they appear in error payload. # Corresponds to the JSON property `isErrorType` # @return [Boolean] attr_accessor :is_error_type alias_method :is_error_type?, :is_error_type - # Selects messages to which this rule applies. - # Refer to selector for syntax details. + # Selects messages to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -1125,9 +1019,8 @@ module Google include Google::Apis::Core::Hashable # Required. The network that the consumer is using to connect with services. - # Must be in the form of projects/`project`/global/networks/`network` - # `project` is a project number, as in '12345' - # `network` is network name. + # Must be in the form of projects/`project`/global/networks/`network` `project` + # is a project number, as in '12345' `network` is network name. # Corresponds to the JSON property `consumerNetwork` # @return [String] attr_accessor :consumer_network @@ -1190,9 +1083,9 @@ module Google # @return [String] attr_accessor :dns_suffix - # User assigned name for this resource. Must be unique within the project. - # The name must be 1-63 characters long, must begin with a letter, end with - # a letter or digit, and only contain lowercase letters, digits or dashes. + # User assigned name for this resource. Must be unique within the project. The + # name must be 1-63 characters long, must begin with a letter, end with a letter + # or digit, and only contain lowercase letters, digits or dashes. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1208,56 +1101,32 @@ module Google end end - # `Documentation` provides the information for describing a service. - # Example: - # 
documentation:
-      # summary: >
-      # The Google Calendar API gives access
-      # to most calendar features.
-      # pages:
-      # - name: Overview
-      # content: (== include google/foo/overview.md ==)
-      # - name: Tutorial
-      # content: (== include google/foo/tutorial.md ==)
-      # subpages;
-      # - name: Java
-      # content: (== include google/foo/tutorial_java.md ==)
-      # rules:
-      # - selector: google.calendar.Calendar.Get
-      # description: >
-      # ...
-      # - selector: google.calendar.Calendar.Put
-      # description: >
-      # ...
-      #
- # Documentation is provided in markdown syntax. In addition to - # standard markdown features, definition lists, tables and fenced - # code blocks are supported. Section headers can be provided and are - # interpreted relative to the section nesting of the context where - # a documentation fragment is embedded. - # Documentation from the IDL is merged with documentation defined - # via the config at normalization time, where documentation provided - # by config rules overrides IDL provided. - # A number of constructs specific to the API platform are supported - # in documentation text. - # In order to reference a proto element, the following - # notation can be used: - # 
[fully.qualified.proto.name][]
- # To override the display text used for the link, this can be used: - # 
[display text][fully.qualified.proto.name]
- # Text can be excluded from doc using the following notation: - # 
(-- internal comment --)
- # A few directives are available in documentation. Note that - # directives must appear on a single line to be properly - # identified. The `include` directive includes a markdown file from - # an external source: - # 
(== include path/to/file ==)
- # The `resource_for` directive marks a message to be the resource of - # a collection in REST view. If it is not specified, tools attempt - # to infer the resource from the operations in a collection: - # 
(== resource_for v1.shelves.books ==)
- # The directive `suppress_warning` does not directly affect documentation - # and is documented together with service config validation. + # `Documentation` provides the information for describing a service. Example: + # documentation: summary: > The Google Calendar API gives access to most + # calendar features. pages: - name: Overview content: (== include google/foo/ + # overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md == + # ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==) + # rules: - selector: google.calendar.Calendar.Get description: > ... - selector: + # google.calendar.Calendar.Put description: > ... Documentation is provided in + # markdown syntax. In addition to standard markdown features, definition lists, + # tables and fenced code blocks are supported. Section headers can be provided + # and are interpreted relative to the section nesting of the context where a + # documentation fragment is embedded. Documentation from the IDL is merged with + # documentation defined via the config at normalization time, where + # documentation provided by config rules overrides IDL provided. A number of + # constructs specific to the API platform are supported in documentation text. + # In order to reference a proto element, the following notation can be used: [ + # fully.qualified.proto.name][] To override the display text used for the link, + # this can be used: [display text][fully.qualified.proto.name] Text can be + # excluded from doc using the following notation: (-- internal comment --) A few + # directives are available in documentation. Note that directives must appear on + # a single line to be properly identified. The `include` directive includes a + # markdown file from an external source: (== include path/to/file ==) The ` + # resource_for` directive marks a message to be the resource of a collection in + # REST view. If it is not specified, tools attempt to infer the resource from + # the operations in a collection: (== resource_for v1.shelves.books ==) The + # directive `suppress_warning` does not directly affect documentation and is + # documented together with service config validation. class Documentation include Google::Apis::Core::Hashable @@ -1266,19 +1135,11 @@ module Google # @return [String] attr_accessor :documentation_root_url - # Declares a single overview page. For example: - # 
documentation:
-        # summary: ...
-        # overview: (== include overview.md ==)
-        #
- # This is a shortcut for the following declaration (using pages style): - # 
documentation:
-        # summary: ...
-        # pages:
-        # - name: Overview
-        # content: (== include overview.md ==)
-        #
- # Note: you cannot specify both `overview` field and `pages` field. + # Declares a single overview page. For example: documentation: summary: ... + # overview: (== include overview.md ==) This is a shortcut for the following + # declaration (using pages style): documentation: summary: ... pages: - name: + # Overview content: (== include overview.md ==) Note: you cannot specify both ` + # overview` field and `pages` field. # Corresponds to the JSON property `overview` # @return [String] attr_accessor :overview @@ -1288,22 +1149,20 @@ module Google # @return [Array] attr_accessor :pages - # A list of documentation rules that apply to individual API elements. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of documentation rules that apply to individual API elements. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules - # Specifies the service root url if the default one (the service name - # from the yaml file) is not suitable. This can be seen in any fully - # specified service urls as well as sections that show a base that other - # urls are relative to. + # Specifies the service root url if the default one (the service name from the + # yaml file) is not suitable. This can be seen in any fully specified service + # urls as well as sections that show a base that other urls are relative to. # Corresponds to the JSON property `serviceRootUrl` # @return [String] attr_accessor :service_root_url - # A short summary of what the service does. Can only be provided by - # plain text. + # A short summary of what the service does. Can only be provided by plain text. # Corresponds to the JSON property `summary` # @return [String] attr_accessor :summary @@ -1327,8 +1186,8 @@ module Google class DocumentationRule include Google::Apis::Core::Hashable - # Deprecation description of the selected element(s). It can be provided if - # an element is marked as `deprecated`. + # Deprecation description of the selected element(s). It can be provided if an + # element is marked as `deprecated`. # Corresponds to the JSON property `deprecationDescription` # @return [String] attr_accessor :deprecation_description @@ -1360,13 +1219,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 @@ -1384,9 +1241,8 @@ module Google include Google::Apis::Core::Hashable # Required. The network that the consumer is using to connect with services. - # Must be in the form of projects/`project`/global/networks/`network` - # `project` is a project number, as in '12345' - # `network` is network name. + # Must be in the form of projects/`project`/global/networks/`network` `project` + # is a project number, as in '12345' `network` is network name. # Corresponds to the JSON property `consumerNetwork` # @return [String] attr_accessor :consumer_network @@ -1401,35 +1257,28 @@ module Google end end - # `Endpoint` describes a network endpoint that serves a set of APIs. - # A service may expose any number of endpoints, and all endpoints share the - # same service configuration, such as quota configuration and monitoring - # configuration. - # Example service configuration: - # name: library-example.googleapis.com - # endpoints: - # # Below entry makes 'google.example.library.v1.Library' - # # API be served from endpoint address library-example.googleapis.com. - # # It also allows HTTP OPTIONS calls to be passed to the backend, for - # # it to decide whether the subsequent cross-origin request is - # # allowed to proceed. - # - name: library-example.googleapis.com - # allow_cors: true + # `Endpoint` describes a network endpoint that serves a set of APIs. A service + # may expose any number of endpoints, and all endpoints share the same service + # configuration, such as quota configuration and monitoring configuration. + # Example service configuration: name: library-example.googleapis.com endpoints: + # # Below entry makes 'google.example.library.v1.Library' # API be served from + # endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS + # calls to be passed to the backend, for # it to decide whether the subsequent + # cross-origin request is # allowed to proceed. - name: library-example. + # googleapis.com allow_cors: true class Endpoint include Google::Apis::Core::Hashable # DEPRECATED: This field is no longer supported. Instead of using aliases, - # please specify multiple google.api.Endpoint for each of the intended - # aliases. + # please specify multiple google.api.Endpoint for each of the intended aliases. # Additional names that this endpoint will be hosted on. # Corresponds to the JSON property `aliases` # @return [Array] attr_accessor :aliases - # Allowing - # [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka - # cross-domain traffic, would allow the backends served from this endpoint to - # receive and respond to HTTP OPTIONS requests. The response will be used by + # Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), + # aka cross-domain traffic, would allow the backends served from this endpoint + # to receive and respond to HTTP OPTIONS requests. The response will be used by # the browser to determine whether the subsequent cross-origin request is # allowed to proceed. # Corresponds to the JSON property `allowCors` @@ -1443,10 +1292,9 @@ module Google attr_accessor :name # The specification of an Internet routable address of API frontend that will - # handle requests to this [API - # Endpoint](https://cloud.google.com/apis/design/glossary). It should be - # either a valid IPv4 address or a fully-qualified domain name. For example, - # "8.8.8.8" or "myservice.appspot.com". + # handle requests to this [API Endpoint](https://cloud.google.com/apis/design/ + # glossary). It should be either a valid IPv4 address or a fully-qualified + # domain name. For example, "8.8.8.8" or "myservice.appspot.com". # Corresponds to the JSON property `target` # @return [String] attr_accessor :target @@ -1483,8 +1331,8 @@ module Google # @return [Array] attr_accessor :options - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. # Corresponds to the JSON property `sourceContext` # @return [Google::Apis::ServicenetworkingV1::SourceContext] attr_accessor :source_context @@ -1573,8 +1421,8 @@ module Google # @return [Fixnum] attr_accessor :number - # The index of the field type in `Type.oneofs`, for message or enumeration - # types. The first type has index 1; zero means the type is not in the list. + # The index of the field type in `Type.oneofs`, for message or enumeration types. + # The first type has index 1; zero means the type is not in the list. # Corresponds to the JSON property `oneofIndex` # @return [Fixnum] attr_accessor :oneof_index @@ -1590,8 +1438,8 @@ module Google attr_accessor :packed alias_method :packed?, :packed - # The field type URL, without the scheme, for message or enumeration - # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + # The field type URL, without the scheme, for message or enumeration types. + # Example: `"type.googleapis.com/google.protobuf.Timestamp"`. # Corresponds to the JSON property `typeUrl` # @return [String] attr_accessor :type_url @@ -1625,21 +1473,19 @@ module Google # @return [String] attr_accessor :ip_cidr_range - # Subnetwork name. - # See https://cloud.google.com/compute/docs/vpc/ + # Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # In the Shared VPC host project, the VPC network that's peered with the - # consumer network. For example: - # `projects/1234321/global/networks/host-network` + # consumer network. For example: `projects/1234321/global/networks/host-network` # Corresponds to the JSON property `network` # @return [String] attr_accessor :network - # This is a discovered subnet that is not within the current consumer - # allocated ranges. + # This is a discovered subnet that is not within the current consumer allocated + # ranges. # Corresponds to the JSON property `outsideAllocation` # @return [Boolean] attr_accessor :outside_allocation @@ -1659,23 +1505,22 @@ module Google end # Defines the HTTP configuration for an API service. It contains a list of - # HttpRule, each specifying the mapping of an RPC method - # to one or more HTTP REST API methods. + # HttpRule, each specifying the mapping of an RPC method to one or more HTTP + # REST API methods. class Http include Google::Apis::Core::Hashable # When set to true, URL path parameters will be fully URI-decoded except in # cases of single segment matches in reserved expansion, where "%2F" will be - # left encoded. - # The default behavior is to not decode RFC 6570 reserved characters in multi - # segment matches. + # left encoded. The default behavior is to not decode RFC 6570 reserved + # characters in multi segment matches. # Corresponds to the JSON property `fullyDecodeReservedExpansion` # @return [Boolean] attr_accessor :fully_decode_reserved_expansion alias_method :fully_decode_reserved_expansion?, :fully_decode_reserved_expansion - # A list of HTTP configuration rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of HTTP configuration rules that apply to individual API methods. ** + # NOTE:** All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -1691,251 +1536,156 @@ module Google end end - # # gRPC Transcoding - # gRPC Transcoding is a feature for mapping between a gRPC method and one or - # more HTTP REST endpoints. It allows developers to build a single API service - # that supports both gRPC APIs and REST APIs. Many systems, including [Google - # APIs](https://github.com/googleapis/googleapis), - # [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC - # Gateway](https://github.com/grpc-ecosystem/grpc-gateway), - # and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature - # and use it for large scale production services. - # `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies - # how different portions of the gRPC request message are mapped to the URL - # path, URL query parameters, and HTTP request body. It also controls how the - # gRPC response message is mapped to the HTTP response body. `HttpRule` is + # # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC + # method and one or more HTTP REST endpoints. It allows developers to build a + # single API service that supports both gRPC APIs and REST APIs. Many systems, + # including [Google APIs](https://github.com/googleapis/googleapis), [Cloud + # Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github. + # com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/ + # envoy) proxy support this feature and use it for large scale production + # services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping + # specifies how different portions of the gRPC request message are mapped to the + # URL path, URL query parameters, and HTTP request body. It also controls how + # the gRPC response message is mapped to the HTTP response body. `HttpRule` is # typically specified as an `google.api.http` annotation on the gRPC method. # Each mapping specifies a URL path template and an HTTP method. The path # template may refer to one or more fields in the gRPC request message, as long - # as each field is a non-repeated field with a primitive (non-message) type. - # The path template controls how fields of the request message are mapped to - # the URL path. - # Example: - # service Messaging ` - # rpc GetMessage(GetMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # get: "/v1/`name=messages/*`" - # `; - # ` - # ` - # message GetMessageRequest ` - # string name = 1; // Mapped to URL path. - # ` - # message Message ` - # string text = 1; // The resource content. - # ` - # This enables an HTTP REST to gRPC mapping as below: - # HTTP | gRPC - # -----|----- - # `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` - # Any fields in the request message which are not bound by the path template - # automatically become HTTP query parameters if there is no HTTP request body. - # For example: - # service Messaging ` - # rpc GetMessage(GetMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # get:"/v1/messages/`message_id`" - # `; - # ` - # ` - # message GetMessageRequest ` - # message SubMessage ` - # string subfield = 1; - # ` - # string message_id = 1; // Mapped to URL path. - # int64 revision = 2; // Mapped to URL query parameter `revision`. - # SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. - # ` - # This enables a HTTP JSON to RPC mapping as below: - # HTTP | gRPC - # -----|----- - # `GET /v1/messages/123456?revision=2&sub.subfield=foo` | - # `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: - # "foo"))` - # Note that fields which are mapped to URL query parameters must have a - # primitive type or a repeated primitive type or a non-repeated message type. - # In the case of a repeated type, the parameter can be repeated in the URL - # as `...?param=A¶m=B`. In the case of a message type, each field of the - # message is mapped to a separate parameter, such as - # `...?foo.a=A&foo.b=B&foo.c=C`. - # For HTTP methods that allow a request body, the `body` field - # specifies the mapping. Consider a REST update method on the - # message resource collection: - # service Messaging ` - # rpc UpdateMessage(UpdateMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # patch: "/v1/messages/`message_id`" - # body: "message" - # `; - # ` - # ` - # message UpdateMessageRequest ` - # string message_id = 1; // mapped to the URL - # Message message = 2; // mapped to the body - # ` - # The following HTTP JSON to RPC mapping is enabled, where the - # representation of the JSON in the request body is determined by - # protos JSON encoding: - # HTTP | gRPC - # -----|----- - # `PATCH /v1/messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: - # "123456" message ` text: "Hi!" `)` - # The special name `*` can be used in the body mapping to define that - # every field not bound by the path template should be mapped to the - # request body. This enables the following alternative definition of - # the update method: - # service Messaging ` - # rpc UpdateMessage(Message) returns (Message) ` - # option (google.api.http) = ` - # patch: "/v1/messages/`message_id`" - # body: "*" - # `; - # ` - # ` - # message Message ` - # string message_id = 1; - # string text = 2; - # ` - # The following HTTP JSON to RPC mapping is enabled: - # HTTP | gRPC - # -----|----- - # `PATCH /v1/messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: - # "123456" text: "Hi!")` - # Note that when using `*` in the body mapping, it is not possible to - # have HTTP parameters, as all fields not bound by the path end in - # the body. This makes this option more rarely used in practice when - # defining REST APIs. The common usage of `*` is in custom methods - # which don't use the URL at all for transferring data. - # It is possible to define multiple HTTP methods for one RPC by using - # the `additional_bindings` option. Example: - # service Messaging ` - # rpc GetMessage(GetMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # get: "/v1/messages/`message_id`" - # additional_bindings ` - # get: "/v1/users/`user_id`/messages/`message_id`" - # ` - # `; - # ` - # ` - # message GetMessageRequest ` - # string message_id = 1; - # string user_id = 2; - # ` - # This enables the following two alternative HTTP JSON to RPC mappings: - # HTTP | gRPC - # -----|----- - # `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` - # `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: - # "123456")` - # ## Rules for HTTP mapping - # 1. Leaf request fields (recursive expansion nested messages in the request - # message) are classified into three categories: - # - Fields referred by the path template. They are passed via the URL path. - # - Fields referred by the HttpRule.body. They are passed via the HTTP - # request body. - # - All other fields are passed via the URL query parameters, and the - # parameter name is the field path in the request message. A repeated - # field can be represented as multiple query parameters under the same - # name. - # 2. If HttpRule.body is "*", there is no URL query parameter, all fields - # are passed via URL path and HTTP request body. - # 3. If HttpRule.body is omitted, there is no HTTP request body, all - # fields are passed via URL path and URL query parameters. - # ### Path template syntax - # Template = "/" Segments [ Verb ] ; - # Segments = Segment ` "/" Segment ` ; - # Segment = "*" | "**" | LITERAL | Variable ; - # Variable = "`" FieldPath [ "=" Segments ] "`" ; - # FieldPath = IDENT ` "." IDENT ` ; - # Verb = ":" LITERAL ; - # The syntax `*` matches a single URL path segment. The syntax `**` matches - # zero or more URL path segments, which must be the last part of the URL path - # except the `Verb`. - # The syntax `Variable` matches part of the URL path as specified by its - # template. A variable template must not contain other variables. If a variable - # matches a single path segment, its template may be omitted, e.g. ``var`` - # is equivalent to ``var=*``. - # The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` - # contains any reserved character, such characters should be percent-encoded - # before the matching. - # If a variable contains exactly one path segment, such as `"`var`"` or - # `"`var=*`"`, when such a variable is expanded into a URL path on the client - # side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The - # server side does the reverse decoding. Such variables show up in the - # [Discovery - # Document](https://developers.google.com/discovery/v1/reference/apis) as - # ``var``. - # If a variable contains multiple path segments, such as `"`var=foo/*`"` - # or `"`var=**`"`, when such a variable is expanded into a URL path on the - # client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. - # The server side does the reverse decoding, except "%2F" and "%2f" are left - # unchanged. Such variables show up in the - # [Discovery - # Document](https://developers.google.com/discovery/v1/reference/apis) as - # ``+var``. - # ## Using gRPC API Service Configuration - # gRPC API Service Configuration (service config) is a configuration language - # for configuring a gRPC service to become a user-facing product. The - # service config is simply the YAML representation of the `google.api.Service` - # proto message. + # as each field is a non-repeated field with a primitive (non-message) type. The + # path template controls how fields of the request message are mapped to the URL + # path. Example: service Messaging ` rpc GetMessage(GetMessageRequest) returns ( + # Message) ` option (google.api.http) = ` get: "/v1/`name=messages/*`" `; ` ` + # message GetMessageRequest ` string name = 1; // Mapped to URL path. ` message + # Message ` string text = 1; // The resource content. ` This enables an HTTP + # REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/ + # 123456` | `GetMessage(name: "messages/123456")` Any fields in the request + # message which are not bound by the path template automatically become HTTP + # query parameters if there is no HTTP request body. For example: service + # Messaging ` rpc GetMessage(GetMessageRequest) returns (Message) ` option ( + # google.api.http) = ` get:"/v1/messages/`message_id`" `; ` ` message + # GetMessageRequest ` message SubMessage ` string subfield = 1; ` string + # message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL + # query parameter `revision`. SubMessage sub = 3; // Mapped to URL query + # parameter `sub.subfield`. ` This enables a HTTP JSON to RPC mapping as below: + # HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | + # `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo")) + # ` Note that fields which are mapped to URL query parameters must have a + # primitive type or a repeated primitive type or a non-repeated message type. In + # the case of a repeated type, the parameter can be repeated in the URL as `...? + # param=A¶m=B`. In the case of a message type, each field of the message is + # mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For + # HTTP methods that allow a request body, the `body` field specifies the mapping. + # Consider a REST update method on the message resource collection: service + # Messaging ` rpc UpdateMessage(UpdateMessageRequest) returns (Message) ` option + # (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "message" `; ` ` + # message UpdateMessageRequest ` string message_id = 1; // mapped to the URL + # Message message = 2; // mapped to the body ` The following HTTP JSON to RPC + # mapping is enabled, where the representation of the JSON in the request body + # is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/ + # messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456" + # message ` text: "Hi!" `)` The special name `*` can be used in the body mapping + # to define that every field not bound by the path template should be mapped to + # the request body. This enables the following alternative definition of the + # update method: service Messaging ` rpc UpdateMessage(Message) returns (Message) + # ` option (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "*" `; + # ` ` message Message ` string message_id = 1; string text = 2; ` The following + # HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/ + # messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456" text: + # "Hi!")` Note that when using `*` in the body mapping, it is not possible to + # have HTTP parameters, as all fields not bound by the path end in the body. + # This makes this option more rarely used in practice when defining REST APIs. + # The common usage of `*` is in custom methods which don't use the URL at all + # for transferring data. It is possible to define multiple HTTP methods for one + # RPC by using the `additional_bindings` option. Example: service Messaging ` + # rpc GetMessage(GetMessageRequest) returns (Message) ` option (google.api.http) + # = ` get: "/v1/messages/`message_id`" additional_bindings ` get: "/v1/users/` + # user_id`/messages/`message_id`" ` `; ` ` message GetMessageRequest ` string + # message_id = 1; string user_id = 2; ` This enables the following two + # alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/ + # messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/ + # messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules + # for HTTP mapping 1. Leaf request fields (recursive expansion nested messages + # in the request message) are classified into three categories: - Fields + # referred by the path template. They are passed via the URL path. - Fields + # referred by the HttpRule.body. They are passed via the HTTP request body. - + # All other fields are passed via the URL query parameters, and the parameter + # name is the field path in the request message. A repeated field can be + # represented as multiple query parameters under the same name. 2. If HttpRule. + # body is "*", there is no URL query parameter, all fields are passed via URL + # path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP + # request body, all fields are passed via URL path and URL query parameters. ### + # Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment ` "/ + # " Segment ` ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "`" + # FieldPath [ "=" Segments ] "`" ; FieldPath = IDENT ` "." IDENT ` ; Verb = ":" + # LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` + # matches zero or more URL path segments, which must be the last part of the URL + # path except the `Verb`. The syntax `Variable` matches part of the URL path as + # specified by its template. A variable template must not contain other + # variables. If a variable matches a single path segment, its template may be + # omitted, e.g. ``var`` is equivalent to ``var=*``. The syntax `LITERAL` matches + # literal text in the URL path. If the `LITERAL` contains any reserved character, + # such characters should be percent-encoded before the matching. If a variable + # contains exactly one path segment, such as `"`var`"` or `"`var=*`"`, when such + # a variable is expanded into a URL path on the client side, all characters + # except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse + # decoding. Such variables show up in the [Discovery Document](https:// + # developers.google.com/discovery/v1/reference/apis) as ``var``. If a variable + # contains multiple path segments, such as `"`var=foo/*`"` or `"`var=**`"`, when + # such a variable is expanded into a URL path on the client side, all characters + # except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the + # reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables + # show up in the [Discovery Document](https://developers.google.com/discovery/v1/ + # reference/apis) as ``+var``. ## Using gRPC API Service Configuration gRPC API + # Service Configuration (service config) is a configuration language for + # configuring a gRPC service to become a user-facing product. The service config + # is simply the YAML representation of the `google.api.Service` proto message. # As an alternative to annotating your proto file, you can configure gRPC - # transcoding in your service config YAML files. You do this by specifying a - # `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same - # effect as the proto annotation. This can be particularly useful if you - # have a proto that is reused in multiple services. Note that any transcoding - # specified in the service config will override any matching transcoding - # configuration in the proto. - # Example: - # http: - # rules: - # # Selects a gRPC method and applies HttpRule to it. - # - selector: example.v1.Messaging.GetMessage - # get: /v1/messages/`message_id`/`sub.subfield` - # ## Special notes - # When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the - # proto to JSON conversion must follow the [proto3 - # specification](https://developers.google.com/protocol-buffers/docs/proto3#json) - # . - # While the single segment variable follows the semantics of - # [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String - # Expansion, the multi segment variable **does not** follow RFC 6570 Section - # 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion - # does not expand special characters like `?` and `#`, which would lead - # to invalid URLs. As the result, gRPC Transcoding uses a custom encoding - # for multi segment variables. - # The path variables **must not** refer to any repeated or mapped field, - # because client libraries are not capable of handling such variable expansion. - # The path variables **must not** capture the leading "/" character. The reason - # is that the most common use case "`var`" does not capture the leading "/" - # character. For consistency, all path variables must share the same behavior. - # Repeated message fields must not be mapped to URL query parameters, because - # no client library can support such complicated mapping. - # If an API needs to use a JSON array for request or response body, it can map - # the request or response body to a repeated field. However, some gRPC - # Transcoding implementations may not support this feature. + # transcoding in your service config YAML files. You do this by specifying a ` + # HttpRule` that maps the gRPC method to a REST endpoint, achieving the same + # effect as the proto annotation. This can be particularly useful if you have a + # proto that is reused in multiple services. Note that any transcoding specified + # in the service config will override any matching transcoding configuration in + # the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule + # to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/` + # message_id`/`sub.subfield` ## Special notes When gRPC Transcoding is used to + # map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow + # the [proto3 specification](https://developers.google.com/protocol-buffers/docs/ + # proto3#json). While the single segment variable follows the semantics of [RFC + # 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String + # Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2. + # 3 Reserved Expansion. The reason is that the Reserved Expansion does not + # expand special characters like `?` and `#`, which would lead to invalid URLs. + # As the result, gRPC Transcoding uses a custom encoding for multi segment + # variables. The path variables **must not** refer to any repeated or mapped + # field, because client libraries are not capable of handling such variable + # expansion. The path variables **must not** capture the leading "/" character. + # The reason is that the most common use case "`var`" does not capture the + # leading "/" character. For consistency, all path variables must share the same + # behavior. Repeated message fields must not be mapped to URL query parameters, + # because no client library can support such complicated mapping. If an API + # needs to use a JSON array for request or response body, it can map the request + # or response body to a repeated field. However, some gRPC Transcoding + # implementations may not support this feature. class HttpRule include Google::Apis::Core::Hashable - # Additional HTTP bindings for the selector. Nested bindings must - # not contain an `additional_bindings` field themselves (that is, - # the nesting may only be one level deep). + # Additional HTTP bindings for the selector. Nested bindings must not contain an + # `additional_bindings` field themselves (that is, the nesting may only be one + # level deep). # Corresponds to the JSON property `additionalBindings` # @return [Array] attr_accessor :additional_bindings - # When this flag is set to true, HTTP requests will be allowed to invoke a - # half-duplex streaming method. + # When this flag is set to true, HTTP requests will be allowed to invoke a half- + # duplex streaming method. # Corresponds to the JSON property `allowHalfDuplex` # @return [Boolean] attr_accessor :allow_half_duplex alias_method :allow_half_duplex?, :allow_half_duplex - # The name of the request field whose value is mapped to the HTTP request - # body, or `*` for mapping all request fields not captured by the path - # pattern to the HTTP body, or omitted for not having any HTTP request body. - # NOTE: the referred field must be present at the top-level of the request - # message type. + # The name of the request field whose value is mapped to the HTTP request body, + # or `*` for mapping all request fields not captured by the path pattern to the + # HTTP body, or omitted for not having any HTTP request body. NOTE: the referred + # field must be present at the top-level of the request message type. # Corresponds to the JSON property `body` # @return [String] attr_accessor :body @@ -1950,8 +1700,7 @@ module Google # @return [String] attr_accessor :delete - # Maps to HTTP GET. Used for listing and getting information about - # resources. + # Maps to HTTP GET. Used for listing and getting information about resources. # Corresponds to the JSON property `get` # @return [String] attr_accessor :get @@ -1972,16 +1721,15 @@ module Google attr_accessor :put # Optional. The name of the response field whose value is mapped to the HTTP - # response body. When omitted, the entire response message will be used - # as the HTTP response body. - # NOTE: The referred field must be present at the top-level of the response - # message type. + # response body. When omitted, the entire response message will be used as the + # HTTP response body. NOTE: The referred field must be present at the top-level + # of the response message type. # Corresponds to the JSON property `responseBody` # @return [String] attr_accessor :response_body - # Selects a method to which this rule applies. - # Refer to selector for syntax details. + # Selects a method to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -2020,13 +1768,12 @@ module Google # @return [String] attr_accessor :query - # The value prefix. The value format is "value_prefix`token`" - # Only applies to "in" header type. Must be empty for "in" query type. - # If not empty, the header value has to match (case sensitive) this prefix. - # If not matched, JWT will not be extracted. If matched, JWT will be - # extracted after the prefix is removed. - # For example, for "Authorization: Bearer `JWT`", - # value_prefix="Bearer " with a space at the end. + # The value prefix. The value format is "value_prefix`token`" Only applies to " + # in" header type. Must be empty for "in" query type. If not empty, the header + # value has to match (case sensitive) this prefix. If not matched, JWT will not + # be extracted. If matched, JWT will be extracted after the prefix is removed. + # For example, for "Authorization: Bearer `JWT`", value_prefix="Bearer " with a + # space at the end. # Corresponds to the JSON property `valuePrefix` # @return [String] attr_accessor :value_prefix @@ -2074,8 +1821,8 @@ module Google end end - # ListConnectionsResponse is the response to list peering states for the - # given service and consumer project. + # ListConnectionsResponse is the response to list peering states for the given + # service and consumer project. class ListConnectionsResponse include Google::Apis::Core::Hashable @@ -2119,39 +1866,35 @@ module Google end end - # A description of a log type. Example in YAML format: - # - name: library.googleapis.com/activity_history - # description: The history of borrowing and returning library items. - # display_name: Activity - # labels: - # - key: /customer_id + # A description of a log type. Example in YAML format: - name: library. + # googleapis.com/activity_history description: The history of borrowing and + # returning library items. display_name: Activity labels: - key: /customer_id # description: Identifier of a library customer class LogDescriptor include Google::Apis::Core::Hashable - # A human-readable description of this log. This information appears in - # the documentation and can contain details. + # A human-readable description of this log. This information appears in the + # documentation and can contain details. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # The human-readable name for this log. This information appears on - # the user interface and should be concise. + # The human-readable name for this log. This information appears on the user + # interface and should be concise. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # The set of labels that are available to describe a specific log entry. - # Runtime requests that contain labels not specified here are - # considered invalid. + # The set of labels that are available to describe a specific log entry. Runtime + # requests that contain labels not specified here are considered invalid. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels - # The name of the log. It must be less than 512 characters long and can - # include the following characters: upper- and lower-case alphanumeric - # characters [A-Za-z0-9], and punctuation characters including - # slash, underscore, hyphen, period [/_-.]. + # The name of the log. It must be less than 512 characters long and can include + # the following characters: upper- and lower-case alphanumeric characters [A-Za- + # z0-9], and punctuation characters including slash, underscore, hyphen, period [ + # /_-.]. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2169,48 +1912,30 @@ module Google end end - # Logging configuration of the service. - # The following example shows how to configure logs to be sent to the - # producer and consumer projects. In the example, the `activity_history` - # log is sent to both the producer and consumer projects, whereas the - # `purchase_history` log is only sent to the producer project. - # monitored_resources: - # - type: library.googleapis.com/branch - # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. - # logs: - # - name: activity_history - # labels: - # - key: /customer_id - # - name: purchase_history - # logging: - # producer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history - # - purchase_history - # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history + # Logging configuration of the service. The following example shows how to + # configure logs to be sent to the producer and consumer projects. In the + # example, the `activity_history` log is sent to both the producer and consumer + # projects, whereas the `purchase_history` log is only sent to the producer + # project. monitored_resources: - type: library.googleapis.com/branch labels: - + # key: /city description: The city where the library branch is located in. - key: + # /name description: The name of the branch. logs: - name: activity_history + # labels: - key: /customer_id - name: purchase_history logging: + # producer_destinations: - monitored_resource: library.googleapis.com/branch + # logs: - activity_history - purchase_history consumer_destinations: - + # monitored_resource: library.googleapis.com/branch logs: - activity_history class Logging include Google::Apis::Core::Hashable - # Logging configurations for sending logs to the consumer project. - # There can be multiple consumer destinations, each one must have a - # different monitored resource type. A log can be used in at most - # one consumer destination. + # Logging configurations for sending logs to the consumer project. There can be + # multiple consumer destinations, each one must have a different monitored + # resource type. A log can be used in at most one consumer destination. # Corresponds to the JSON property `consumerDestinations` # @return [Array] attr_accessor :consumer_destinations - # Logging configurations for sending logs to the producer project. - # There can be multiple producer destinations, each one must have a - # different monitored resource type. A log can be used in at most - # one producer destination. + # Logging configurations for sending logs to the producer project. There can be + # multiple producer destinations, each one must have a different monitored + # resource type. A log can be used in at most one producer destination. # Corresponds to the JSON property `producerDestinations` # @return [Array] attr_accessor :producer_destinations @@ -2226,21 +1951,20 @@ module Google end end - # Configuration of a specific logging destination (the producer project - # or the consumer project). + # Configuration of a specific logging destination (the producer project or the + # consumer project). class LoggingDestination include Google::Apis::Core::Hashable - # Names of the logs to be sent to this destination. Each name must - # be defined in the Service.logs section. If the log name is - # not a domain scoped name, it will be automatically prefixed with - # the service name followed by "/". + # Names of the logs to be sent to this destination. Each name must be defined in + # the Service.logs section. If the log name is not a domain scoped name, it will + # be automatically prefixed with the service name followed by "/". # Corresponds to the JSON property `logs` # @return [Array] attr_accessor :logs - # The monitored resource type. The type must be defined in the - # Service.monitored_resources section. + # The monitored resource type. The type must be defined in the Service. + # monitored_resources section. # Corresponds to the JSON property `monitoredResource` # @return [String] attr_accessor :monitored_resource @@ -2315,16 +2039,13 @@ module Google # Defines a metric type and its schema. Once a metric descriptor is created, # deleting or altering it stops data collection and makes the metric type's - # existing data unusable. - # The following are specific rules for service defined Monitoring metric - # descriptors: - # * `type`, `metric_kind`, `value_type` and `description` - # fields are all required. The `unit` field must be specified - # if the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. - # * Maximum of default 500 metric descriptors per service is allowed. - # * Maximum of default 10 labels per metric descriptor is allowed. - # The default maximum limit can be overridden. Please follow - # https://cloud.google.com/monitoring/quotas + # existing data unusable. The following are specific rules for service defined + # Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and ` + # description` fields are all required. The `unit` field must be specified if + # the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default + # 500 metric descriptors per service is allowed. * Maximum of default 10 labels + # per metric descriptor is allowed. The default maximum limit can be overridden. + # Please follow https://cloud.google.com/monitoring/quotas class MetricDescriptor include Google::Apis::Core::Hashable @@ -2333,26 +2054,21 @@ module Google # @return [String] attr_accessor :description - # A concise name for the metric, which can be displayed in user interfaces. - # Use sentence case without an ending period, for example "Request count". - # This field is optional but it is recommended to be set for any metrics - # associated with user-visible concepts, such as Quota. + # A concise name for the metric, which can be displayed in user interfaces. Use + # sentence case without an ending period, for example "Request count". This + # field is optional but it is recommended to be set for any metrics associated + # with user-visible concepts, such as Quota. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # The set of labels that can be used to describe a specific - # instance of this metric type. - # The label key name must follow: - # * Only upper and lower-case letters, digits and underscores (_) are - # allowed. - # * Label name must start with a letter or digit. - # * The maximum length of a label name is 100 characters. - # For example, the - # `appengine.googleapis.com/http/server/response_latencies` metric - # type has a label for the HTTP response code, `response_code`, so - # you can look at latencies for successful responses or just - # for responses that failed. + # The set of labels that can be used to describe a specific instance of this + # metric type. The label key name must follow: * Only upper and lower-case + # letters, digits and underscores (_) are allowed. * Label name must start with + # a letter or digit. * The maximum length of a label name is 100 characters. For + # example, the `appengine.googleapis.com/http/server/response_latencies` metric + # type has a label for the HTTP response code, `response_code`, so you can look + # at latencies for successful responses or just for responses that failed. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels @@ -2367,17 +2083,16 @@ module Google # @return [Google::Apis::ServicenetworkingV1::MetricDescriptorMetadata] attr_accessor :metadata - # Whether the metric records instantaneous values, changes to a value, etc. - # Some combinations of `metric_kind` and `value_type` might not be supported. + # Whether the metric records instantaneous values, changes to a value, etc. Some + # combinations of `metric_kind` and `value_type` might not be supported. # Corresponds to the JSON property `metricKind` # @return [String] attr_accessor :metric_kind - # Read-only. If present, then a time - # series, which is identified partially by - # a metric type and a MonitoredResourceDescriptor, that is associated - # with this metric type can only be associated with one of the monitored - # resource types listed here. + # Read-only. If present, then a time series, which is identified partially by a + # metric type and a MonitoredResourceDescriptor, that is associated with this + # metric type can only be associated with one of the monitored resource types + # listed here. # Corresponds to the JSON property `monitoredResourceTypes` # @return [Array] attr_accessor :monitored_resource_types @@ -2387,116 +2102,73 @@ module Google # @return [String] attr_accessor :name - # The metric type, including its DNS name prefix. The type is not - # URL-encoded. + # The metric type, including its DNS name prefix. The type is not URL-encoded. # All service defined metrics must be prefixed with the service name, in the - # format of ``service name`/`relative metric name``, such as - # `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric - # name must follow: + # format of ``service name`/`relative metric name``, such as `cloudsql. + # googleapis.com/database/cpu/utilization`. The relative metric name must follow: # * Only upper and lower-case letters, digits, '/' and underscores '_' are - # allowed. - # * The maximum number of characters allowed for the relative_metric_name is - # 100. - # All user-defined metric types have the DNS name - # `custom.googleapis.com`, `external.googleapis.com`, or - # `logging.googleapis.com/user/`. - # Metric types should use a natural hierarchical grouping. For example: - # "custom.googleapis.com/invoice/paid/amount" - # "external.googleapis.com/prometheus/up" - # "appengine.googleapis.com/http/server/response_latencies" + # allowed. * The maximum number of characters allowed for the + # relative_metric_name is 100. All user-defined metric types have the DNS name ` + # custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/ + # user/`. Metric types should use a natural hierarchical grouping. For example: " + # custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/ + # up" "appengine.googleapis.com/http/server/response_latencies" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # The units in which the metric value is reported. It is only applicable - # if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` - # defines the representation of the stored metric values. - # Different systems may scale the values to be more easily displayed (so a - # value of `0.02KBy` _might_ be displayed as `20By`, and a value of - # `3523KBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is - # `KBy`, then the value of the metric is always in thousands of bytes, no - # matter how it may be displayed.. - # If you want a custom metric to record the exact number of CPU-seconds used - # by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is - # `s`CPU`` (or equivalently `1s`CPU`` or just `s`). If the job uses 12,005 - # CPU-seconds, then the value is written as `12005`. - # Alternatively, if you want a custom metric to record data in a more - # granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is - # `ks`CPU``, and then write the value `12.005` (which is `12005/1000`), - # or use `Kis`CPU`` and write `11.723` (which is `12005/1024`). - # The supported units are a subset of [The Unified Code for Units of - # Measure](http://unitsofmeasure.org/ucum.html) standard: - # **Basic units (UNIT)** - # * `bit` bit - # * `By` byte - # * `s` second - # * `min` minute - # * `h` hour - # * `d` day - # * `1` dimensionless - # **Prefixes (PREFIX)** - # * `k` kilo (10^3) - # * `M` mega (10^6) - # * `G` giga (10^9) - # * `T` tera (10^12) - # * `P` peta (10^15) - # * `E` exa (10^18) - # * `Z` zetta (10^21) - # * `Y` yotta (10^24) - # * `m` milli (10^-3) - # * `u` micro (10^-6) - # * `n` nano (10^-9) - # * `p` pico (10^-12) - # * `f` femto (10^-15) - # * `a` atto (10^-18) - # * `z` zepto (10^-21) - # * `y` yocto (10^-24) - # * `Ki` kibi (2^10) - # * `Mi` mebi (2^20) - # * `Gi` gibi (2^30) - # * `Ti` tebi (2^40) - # * `Pi` pebi (2^50) - # **Grammar** - # The grammar also includes these connectors: - # * `/` division or ratio (as an infix operator). For examples, - # `kBy/`email`` or `MiBy/10ms` (although you should almost never - # have `/s` in a metric `unit`; rates should always be computed at - # query time from the underlying cumulative or delta value). - # * `.` multiplication or composition (as an infix operator). For - # examples, `GBy.d` or `k`watt`.h`. - # The grammar for a unit is as follows: - # Expression = Component ` "." Component ` ` "/" Component ` ; - # Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] - # | Annotation - # | "1" - # ; - # Annotation = "`" NAME "`" ; - # Notes: - # * `Annotation` is just a comment if it follows a `UNIT`. If the annotation - # is used alone, then the unit is equivalent to `1`. For examples, - # ``request`/s == 1/s`, `By`transmitted`/s == By/s`. - # * `NAME` is a sequence of non-blank printable ASCII characters not - # containing ``` or ```. - # * `1` represents a unitary [dimensionless - # unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such - # as in `1/s`. It is typically used when none of the basic units are - # appropriate. For example, "new users per day" can be represented as - # `1/d` or ``new-users`/d` (and a metric value `5` would mean "5 new - # users). Alternatively, "thousands of page views per day" would be - # represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric - # value of `5.3` would mean "5300 page views per day"). - # * `%` represents dimensionless value of 1/100, and annotates values giving - # a percentage (so the metric values are typically in the range of 0..100, - # and a metric value `3` means "3 percent"). - # * `10^2.%` indicates a metric contains a ratio, typically in the range - # 0..1, that will be multiplied by 100 and displayed as a percentage - # (so a metric value `0.03` means "3 percent"). + # The units in which the metric value is reported. It is only applicable if the ` + # value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the + # representation of the stored metric values. Different systems may scale the + # values to be more easily displayed (so a value of `0.02KBy` _might_ be + # displayed as `20By`, and a value of `3523KBy` _might_ be displayed as `3.5MBy`) + # . However, if the `unit` is `KBy`, then the value of the metric is always in + # thousands of bytes, no matter how it may be displayed.. If you want a custom + # metric to record the exact number of CPU-seconds used by a job, you can create + # an `INT64 CUMULATIVE` metric whose `unit` is `s`CPU`` (or equivalently `1s`CPU` + # ` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written + # as `12005`. Alternatively, if you want a custom metric to record data in a + # more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is + # `ks`CPU``, and then write the value `12.005` (which is `12005/1000`), or use ` + # Kis`CPU`` and write `11.723` (which is `12005/1024`). The supported units are + # a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ + # ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` + # second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes ( + # PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^ + # 12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^ + # 24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^- + # 12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto ( + # 10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi ( + # 2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these + # connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/ + # `email`` or `MiBy/10ms` (although you should almost never have `/s` in a + # metric `unit`; rates should always be computed at query time from the + # underlying cumulative or delta value). * `.` multiplication or composition (as + # an infix operator). For examples, `GBy.d` or `k`watt`.h`. The grammar for a + # unit is as follows: Expression = Component ` "." Component ` ` "/" Component ` + # ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; + # Annotation = "`" NAME "`" ; Notes: * `Annotation` is just a comment if it + # follows a `UNIT`. If the annotation is used alone, then the unit is equivalent + # to `1`. For examples, ``request`/s == 1/s`, `By`transmitted`/s == By/s`. * ` + # NAME` is a sequence of non-blank printable ASCII characters not containing ``` + # or ```. * `1` represents a unitary [dimensionless unit](https://en.wikipedia. + # org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used + # when none of the basic units are appropriate. For example, "new users per day" + # can be represented as `1/d` or ``new-users`/d` (and a metric value `5` would + # mean "5 new users). Alternatively, "thousands of page views per day" would be + # represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric value of ` + # 5.3` would mean "5300 page views per day"). * `%` represents dimensionless + # value of 1/100, and annotates values giving a percentage (so the metric values + # are typically in the range of 0..100, and a metric value `3` means "3 percent") + # . * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, + # that will be multiplied by 100 and displayed as a percentage (so a metric + # value `0.03` means "3 percent"). # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit - # Whether the measurement is an integer, a floating-point number, etc. - # Some combinations of `metric_kind` and `value_type` might not be supported. + # Whether the measurement is an integer, a floating-point number, etc. Some + # combinations of `metric_kind` and `value_type` might not be supported. # Corresponds to the JSON property `valueType` # @return [String] attr_accessor :value_type @@ -2525,9 +2197,9 @@ module Google class MetricDescriptorMetadata include Google::Apis::Core::Hashable - # The delay of data points caused by ingestion. Data points older than this - # age are guaranteed to be ingested and available to be read, excluding - # data loss due to errors. + # The delay of data points caused by ingestion. Data points older than this age + # are guaranteed to be ingested and available to be read, excluding data loss + # due to errors. # Corresponds to the JSON property `ingestDelay` # @return [String] attr_accessor :ingest_delay @@ -2539,8 +2211,8 @@ module Google # The sampling period of metric data points. For metrics which are written # periodically, consecutive data points are stored at this time interval, - # excluding data loss due to errors. Metrics with a higher granularity have - # a smaller sampling period. + # excluding data loss due to errors. Metrics with a higher granularity have a + # smaller sampling period. # Corresponds to the JSON property `samplePeriod` # @return [String] attr_accessor :sample_period @@ -2557,22 +2229,21 @@ module Google end end - # Bind API methods to metrics. Binding a method to a metric causes that - # metric's configured quota behaviors to apply to the method call. + # Bind API methods to metrics. Binding a method to a metric causes that metric's + # configured quota behaviors to apply to the method call. class MetricRule include Google::Apis::Core::Hashable # Metrics to update when the selected methods are called, and the associated - # cost applied to each metric. - # The key of the map is the metric name, and the values are the amount - # increased for the metric against which the quota limits are defined. - # The value must not be negative. + # cost applied to each metric. The key of the map is the metric name, and the + # values are the amount increased for the metric against which the quota limits + # are defined. The value must not be negative. # Corresponds to the JSON property `metricCosts` # @return [Hash] attr_accessor :metric_costs - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -2590,66 +2261,33 @@ module Google # Declares an API Interface to be included in this interface. The including # interface must redeclare all the methods from the included interface, but - # documentation and options are inherited as follows: - # - If after comment and whitespace stripping, the documentation - # string of the redeclared method is empty, it will be inherited - # from the original method. - # - Each annotation belonging to the service config (http, - # visibility) which is not set in the redeclared method will be - # inherited. - # - If an http annotation is inherited, the path pattern will be - # modified as follows. Any version prefix will be replaced by the - # version of the including interface plus the root path if - # specified. - # Example of a simple mixin: - # package google.acl.v1; - # service AccessControl ` - # // Get the underlying ACL object. - # rpc GetAcl(GetAclRequest) returns (Acl) ` - # option (google.api.http).get = "/v1/`resource=**`:getAcl"; - # ` - # ` - # package google.storage.v2; - # service Storage ` - # // rpc GetAcl(GetAclRequest) returns (Acl); - # // Get a data record. - # rpc GetData(GetDataRequest) returns (Data) ` - # option (google.api.http).get = "/v2/`resource=**`"; - # ` - # ` - # Example of a mixin configuration: - # apis: - # - name: google.storage.v2.Storage - # mixins: - # - name: google.acl.v1.AccessControl - # The mixin construct implies that all methods in `AccessControl` are - # also declared with same name and request/response types in - # `Storage`. A documentation generator or annotation processor will - # see the effective `Storage.GetAcl` method after inherting - # documentation and annotations as follows: - # service Storage ` - # // Get the underlying ACL object. - # rpc GetAcl(GetAclRequest) returns (Acl) ` - # option (google.api.http).get = "/v2/`resource=**`:getAcl"; - # ` - # ... - # ` - # Note how the version in the path pattern changed from `v1` to `v2`. - # If the `root` field in the mixin is specified, it should be a - # relative path under which inherited HTTP paths are placed. Example: - # apis: - # - name: google.storage.v2.Storage - # mixins: - # - name: google.acl.v1.AccessControl - # root: acls - # This implies the following inherited HTTP annotation: - # service Storage ` - # // Get the underlying ACL object. - # rpc GetAcl(GetAclRequest) returns (Acl) ` - # option (google.api.http).get = "/v2/acls/`resource=**`:getAcl"; - # ` - # ... - # ` + # documentation and options are inherited as follows: - If after comment and + # whitespace stripping, the documentation string of the redeclared method is + # empty, it will be inherited from the original method. - Each annotation + # belonging to the service config (http, visibility) which is not set in the + # redeclared method will be inherited. - If an http annotation is inherited, the + # path pattern will be modified as follows. Any version prefix will be replaced + # by the version of the including interface plus the root path if specified. + # Example of a simple mixin: package google.acl.v1; service AccessControl ` // + # Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) ` + # option (google.api.http).get = "/v1/`resource=**`:getAcl"; ` ` package google. + # storage.v2; service Storage ` // rpc GetAcl(GetAclRequest) returns (Acl); // + # Get a data record. rpc GetData(GetDataRequest) returns (Data) ` option (google. + # api.http).get = "/v2/`resource=**`"; ` ` Example of a mixin configuration: + # apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1. + # AccessControl The mixin construct implies that all methods in `AccessControl` + # are also declared with same name and request/response types in `Storage`. A + # documentation generator or annotation processor will see the effective ` + # Storage.GetAcl` method after inherting documentation and annotations as + # follows: service Storage ` // Get the underlying ACL object. rpc GetAcl( + # GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=** + # `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1` + # to `v2`. If the `root` field in the mixin is specified, it should be a + # relative path under which inherited HTTP paths are placed. Example: apis: - + # name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl + # root: acls This implies the following inherited HTTP annotation: service + # Storage ` // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns ( + # Acl) ` option (google.api.http).get = "/v2/acls/`resource=**`:getAcl"; ` ... ` class Mixin include Google::Apis::Core::Hashable @@ -2658,8 +2296,7 @@ module Google # @return [String] attr_accessor :name - # If non-empty specifies a path under which inherited HTTP paths - # are rooted. + # If non-empty specifies a path under which inherited HTTP paths are rooted. # Corresponds to the JSON property `root` # @return [String] attr_accessor :root @@ -2675,51 +2312,42 @@ module Google end end - # An object that describes the schema of a MonitoredResource object using a - # type name and a set of labels. For example, the monitored resource - # descriptor for Google Compute Engine VM instances has a type of - # `"gce_instance"` and specifies the use of the labels `"instance_id"` and - # `"zone"` to identify particular VM instances. - # Different services can support different monitored resource types. - # The following are specific rules to service defined monitored resources for - # Monitoring and Logging: - # * The `type`, `display_name`, `description`, `labels` and `launch_stage` - # fields are all required. - # * The first label of the monitored resource descriptor must be - # `resource_container`. There are legacy monitored resource descritptors - # start with `project_id`. - # * It must include a `location` label. - # * Maximum of default 5 service defined monitored resource descriptors - # is allowed per service. - # * Maximum of default 10 labels per monitored resource is allowed. - # The default maximum limit can be overridden. Please follow - # https://cloud.google.com/monitoring/quotas + # An object that describes the schema of a MonitoredResource object using a type + # name and a set of labels. For example, the monitored resource descriptor for + # Google Compute Engine VM instances has a type of `"gce_instance"` and + # specifies the use of the labels `"instance_id"` and `"zone"` to identify + # particular VM instances. Different services can support different monitored + # resource types. The following are specific rules to service defined monitored + # resources for Monitoring and Logging: * The `type`, `display_name`, ` + # description`, `labels` and `launch_stage` fields are all required. * The first + # label of the monitored resource descriptor must be `resource_container`. There + # are legacy monitored resource descritptors start with `project_id`. * It must + # include a `location` label. * Maximum of default 5 service defined monitored + # resource descriptors is allowed per service. * Maximum of default 10 labels + # per monitored resource is allowed. The default maximum limit can be overridden. + # Please follow https://cloud.google.com/monitoring/quotas class MonitoredResourceDescriptor include Google::Apis::Core::Hashable - # Optional. A detailed description of the monitored resource type that might - # be used in documentation. + # Optional. A detailed description of the monitored resource type that might be + # used in documentation. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Optional. A concise name for the monitored resource type that might be - # displayed in user interfaces. It should be a Title Cased Noun Phrase, - # without any article or other determiners. For example, - # `"Google Cloud SQL Database"`. + # displayed in user interfaces. It should be a Title Cased Noun Phrase, without + # any article or other determiners. For example, `"Google Cloud SQL Database"`. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Required. A set of labels used to describe instances of this monitored - # resource type. - # The label key name must follow: - # * Only upper and lower-case letters, digits and underscores (_) are - # allowed. - # * Label name must start with a letter or digit. - # * The maximum length of a label name is 100 characters. - # For example, an individual Google Cloud SQL database is - # identified by values for the labels `database_id` and `location`. + # resource type. The label key name must follow: * Only upper and lower-case + # letters, digits and underscores (_) are allowed. * Label name must start with + # a letter or digit. * The maximum length of a label name is 100 characters. For + # example, an individual Google Cloud SQL database is identified by values for + # the labels `database_id` and `location`. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels @@ -2729,27 +2357,25 @@ module Google # @return [String] attr_accessor :launch_stage - # Optional. The resource name of the monitored resource descriptor: - # `"projects/`project_id`/monitoredResourceDescriptors/`type`"` where - # `type` is the value of the `type` field in this object and - # `project_id` is a project ID that provides API-specific context for - # accessing the type. APIs that do not use project information can use the - # resource name format `"monitoredResourceDescriptors/`type`"`. + # Optional. The resource name of the monitored resource descriptor: `"projects/` + # project_id`/monitoredResourceDescriptors/`type`"` where `type` is the value of + # the `type` field in this object and `project_id` is a project ID that provides + # API-specific context for accessing the type. APIs that do not use project + # information can use the resource name format `"monitoredResourceDescriptors/` + # type`"`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The monitored resource type. For example, the type - # `cloudsql_database` represents databases in Google Cloud SQL. - # All service defined monitored resource types must be prefixed with the - # service name, in the format of ``service name`/`relative resource name``. - # The relative resource name must follow: - # * Only upper and lower-case letters and digits are allowed. - # * It must start with upper case character and is recommended to use Upper - # Camel Case style. - # * The maximum number of characters allowed for the relative_resource_name - # is 100. - # Note there are legacy service monitored resources not following this rule. + # Required. The monitored resource type. For example, the type ` + # cloudsql_database` represents databases in Google Cloud SQL. All service + # defined monitored resource types must be prefixed with the service name, in + # the format of ``service name`/`relative resource name``. The relative resource + # name must follow: * Only upper and lower-case letters and digits are allowed. * + # It must start with upper case character and is recommended to use Upper Camel + # Case style. * The maximum number of characters allowed for the + # relative_resource_name is 100. Note there are legacy service monitored + # resources not following this rule. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -2769,75 +2395,47 @@ module Google end end - # Monitoring configuration of the service. - # The example below shows how to configure monitored resources and metrics - # for monitoring. In the example, a monitored resource and two metrics are - # defined. The `library.googleapis.com/book/returned_count` metric is sent - # to both producer and consumer projects, whereas the - # `library.googleapis.com/book/num_overdue` metric is only sent to the - # consumer project. - # monitored_resources: - # - type: library.googleapis.com/Branch - # display_name: "Library Branch" - # description: "A branch of a library." - # launch_stage: GA - # labels: - # - key: resource_container - # description: "The Cloud container (ie. project id) for the Branch." - # - key: location - # description: "The location of the library branch." - # - key: branch_id - # description: "The id of the branch." - # metrics: - # - name: library.googleapis.com/book/returned_count - # display_name: "Books Returned" - # description: "The count of books that have been returned." - # launch_stage: GA - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # - name: library.googleapis.com/book/num_overdue - # display_name: "Books Overdue" - # description: "The current number of overdue books." - # launch_stage: GA - # metric_kind: GAUGE - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # monitoring: - # producer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # consumer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # - library.googleapis.com/book/num_overdue + # Monitoring configuration of the service. The example below shows how to + # configure monitored resources and metrics for monitoring. In the example, a + # monitored resource and two metrics are defined. The `library.googleapis.com/ + # book/returned_count` metric is sent to both producer and consumer projects, + # whereas the `library.googleapis.com/book/num_overdue` metric is only sent to + # the consumer project. monitored_resources: - type: library.googleapis.com/ + # Branch display_name: "Library Branch" description: "A branch of a library." + # launch_stage: GA labels: - key: resource_container description: "The Cloud + # container (ie. project id) for the Branch." - key: location description: "The + # location of the library branch." - key: branch_id description: "The id of the + # branch." metrics: - name: library.googleapis.com/book/returned_count + # display_name: "Books Returned" description: "The count of books that have been + # returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" + # labels: - key: customer_id description: "The id of the customer." - name: + # library.googleapis.com/book/num_overdue display_name: "Books Overdue" + # description: "The current number of overdue books." launch_stage: GA + # metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id + # description: "The id of the customer." monitoring: producer_destinations: - + # monitored_resource: library.googleapis.com/Branch metrics: - library. + # googleapis.com/book/returned_count consumer_destinations: - monitored_resource: + # library.googleapis.com/Branch metrics: - library.googleapis.com/book/ + # returned_count - library.googleapis.com/book/num_overdue class Monitoring include Google::Apis::Core::Hashable - # Monitoring configurations for sending metrics to the consumer project. - # There can be multiple consumer destinations. A monitored resource type may - # appear in multiple monitoring destinations if different aggregations are - # needed for different sets of metrics associated with that monitored - # resource type. A monitored resource and metric pair may only be used once - # in the Monitoring configuration. + # Monitoring configurations for sending metrics to the consumer project. There + # can be multiple consumer destinations. A monitored resource type may appear in + # multiple monitoring destinations if different aggregations are needed for + # different sets of metrics associated with that monitored resource type. A + # monitored resource and metric pair may only be used once in the Monitoring + # configuration. # Corresponds to the JSON property `consumerDestinations` # @return [Array] attr_accessor :consumer_destinations - # Monitoring configurations for sending metrics to the producer project. - # There can be multiple producer destinations. A monitored resource type may - # appear in multiple monitoring destinations if different aggregations are - # needed for different sets of metrics associated with that monitored - # resource type. A monitored resource and metric pair may only be used once - # in the Monitoring configuration. + # Monitoring configurations for sending metrics to the producer project. There + # can be multiple producer destinations. A monitored resource type may appear in + # multiple monitoring destinations if different aggregations are needed for + # different sets of metrics associated with that monitored resource type. A + # monitored resource and metric pair may only be used once in the Monitoring + # configuration. # Corresponds to the JSON property `producerDestinations` # @return [Array] attr_accessor :producer_destinations @@ -2853,19 +2451,19 @@ module Google end end - # Configuration of a specific monitoring destination (the producer project - # or the consumer project). + # Configuration of a specific monitoring destination (the producer project or + # the consumer project). class MonitoringDestination include Google::Apis::Core::Hashable - # Types of the metrics to report to this monitoring destination. - # Each type must be defined in Service.metrics section. + # Types of the metrics to report to this monitoring destination. Each type must + # be defined in Service.metrics section. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics - # The monitored resource type. The type must be defined in - # Service.monitored_resources section. + # The monitored resource type. The type must be defined in Service. + # monitored_resources section. # Corresponds to the JSON property `monitoredResource` # @return [String] attr_accessor :monitored_resource @@ -2882,27 +2480,25 @@ module Google end # OAuth scopes are a way to define data and permissions on data. For example, - # there are scopes defined for "Read-only access to Google Calendar" and - # "Access to Cloud Platform". Users can consent to a scope for an application, - # giving it permission to access that data on their behalf. - # OAuth scope specifications should be fairly coarse grained; a user will need - # to see and understand the text description of what your scope means. - # In most cases: use one or at most two OAuth scopes for an entire family of - # products. If your product has multiple APIs, you should probably be sharing - # the OAuth scope across all of those APIs. - # When you need finer grained OAuth consent screens: talk with your product - # management about how developers will use them in practice. - # Please note that even though each of the canonical scopes is enough for a - # request to be accepted and passed to the backend, a request can still fail - # due to the backend requiring additional scopes or permissions. + # there are scopes defined for "Read-only access to Google Calendar" and "Access + # to Cloud Platform". Users can consent to a scope for an application, giving it + # permission to access that data on their behalf. OAuth scope specifications + # should be fairly coarse grained; a user will need to see and understand the + # text description of what your scope means. In most cases: use one or at most + # two OAuth scopes for an entire family of products. If your product has + # multiple APIs, you should probably be sharing the OAuth scope across all of + # those APIs. When you need finer grained OAuth consent screens: talk with your + # product management about how developers will use them in practice. Please note + # that even though each of the canonical scopes is enough for a request to be + # accepted and passed to the backend, a request can still fail due to the + # backend requiring additional scopes or permissions. class OAuthRequirements include Google::Apis::Core::Hashable - # The list of publicly documented OAuth scopes that are allowed access. An - # OAuth token containing any of these scopes will be accepted. - # Example: - # canonical_scopes: https://www.googleapis.com/auth/calendar, - # https://www.googleapis.com/auth/calendar.read + # The list of publicly documented OAuth scopes that are allowed access. An OAuth + # token containing any of these scopes will be accepted. Example: + # canonical_scopes: https://www.googleapis.com/auth/calendar, https://www. + # googleapis.com/auth/calendar.read # Corresponds to the JSON property `canonicalScopes` # @return [String] attr_accessor :canonical_scopes @@ -2922,47 +2518,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::ServicenetworkingV1::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 @@ -2987,17 +2581,17 @@ module Google include Google::Apis::Core::Hashable # The option's name. For protobuf built-in options (options defined in - # descriptor.proto), this is the short name. For example, `"map_entry"`. - # For custom options, it should be the fully-qualified name. For example, - # `"google.api.http"`. + # descriptor.proto), this is the short name. For example, `"map_entry"`. For + # custom options, it should be the fully-qualified name. For example, `"google. + # api.http"`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The option's value packed in an Any message. If the value is a primitive, - # the corresponding wrapper type defined in google/protobuf/wrappers.proto - # should be used. If the value is an enum, it should be stored as an int32 - # value using the google.protobuf.Int32Value type. + # The option's value packed in an Any message. If the value is a primitive, the + # corresponding wrapper type defined in google/protobuf/wrappers.proto should be + # used. If the value is an enum, it should be stored as an int32 value using the + # google.protobuf.Int32Value type. # Corresponds to the JSON property `value` # @return [Hash] attr_accessor :value @@ -3018,32 +2612,25 @@ module Google class Page include Google::Apis::Core::Hashable - # The Markdown content of the page. You can use (== include `path` - # ==) to include content from a Markdown file. + # The Markdown content of the page. You can use (== include `path` ==) to + # include content from a Markdown file. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content - # The name of the page. It will be used as an identity of the page to - # generate URI of the page, text of the link to this page in navigation, - # etc. The full page name (start from the root page name to this page - # concatenated with `.`) can be used as reference to the page in your - # documentation. For example: - # 
pages:
-        # - name: Tutorial
-        # content: (== include tutorial.md ==)
-        # subpages:
-        # - name: Java
-        # content: (== include tutorial_java.md ==)
-        #
- # You can reference `Java` page using Markdown reference link syntax: - # `Java`. + # The name of the page. It will be used as an identity of the page to generate + # URI of the page, text of the link to this page in navigation, etc. The full + # page name (start from the root page name to this page concatenated with `.`) + # can be used as reference to the page in your documentation. For example: pages: + # - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java + # content: (== include tutorial_java.md ==) You can reference `Java` page using + # Markdown reference link syntax: `Java`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Subpages of this page. The order of subpages specified here will be - # honored in the generated docset. + # Subpages of this page. The order of subpages specified here will be honored in + # the generated docset. # Corresponds to the JSON property `subpages` # @return [Array] attr_accessor :subpages @@ -3064,20 +2651,17 @@ module Google class PolicyBinding include Google::Apis::Core::Hashable - # Required. Member to bind the role with. See - # /iam/docs/reference/rest/v1/Policy#Binding for how to format each member. - # Eg. - # - user:myuser@mydomain.com - # - serviceAccount:my-service-account@app.gserviceaccount.com + # Required. Member to bind the role with. See /iam/docs/reference/rest/v1/Policy# + # Binding for how to format each member. Eg. - user:myuser@mydomain.com - + # serviceAccount:my-service-account@app.gserviceaccount.com # Corresponds to the JSON property `member` # @return [String] attr_accessor :member # Required. Role to apply. Only whitelisted roles can be used at the specified - # granularity. The role must be one of the following: - # - 'roles/container.hostServiceAgentUser' applied on the shared VPC host - # project - # - 'roles/compute.securityAdmin' applied on the shared VPC host project + # granularity. The role must be one of the following: - 'roles/container. + # hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute. + # securityAdmin' applied on the shared VPC host project # Corresponds to the JSON property `role` # @return [String] attr_accessor :role @@ -3093,46 +2677,25 @@ module Google end end - # Quota configuration helps to achieve fairness and budgeting in service - # usage. - # The metric based quota configuration works this way: - # - The service configuration defines a set of metrics. - # - For API calls, the quota.metric_rules maps methods to metrics with - # corresponding costs. - # - The quota.limits defines limits on the metrics, which will be used for - # quota checks at runtime. - # An example quota configuration in yaml format: - # quota: - # limits: - # - name: apiWriteQpsPerProject - # metric: library.googleapis.com/write_calls - # unit: "1/min/`project`" # rate limit for consumer projects - # values: - # STANDARD: 10000 - # # The metric rules bind all methods to the read_calls metric, - # # except for the UpdateBook and DeleteBook methods. These two methods - # # are mapped to the write_calls metric, with the UpdateBook method - # # consuming at twice rate as the DeleteBook method. - # metric_rules: - # - selector: "*" - # metric_costs: - # library.googleapis.com/read_calls: 1 - # - selector: google.example.library.v1.LibraryService.UpdateBook - # metric_costs: - # library.googleapis.com/write_calls: 2 - # - selector: google.example.library.v1.LibraryService.DeleteBook - # metric_costs: - # library.googleapis.com/write_calls: 1 - # Corresponding Metric definition: - # metrics: - # - name: library.googleapis.com/read_calls - # display_name: Read requests - # metric_kind: DELTA - # value_type: INT64 - # - name: library.googleapis.com/write_calls - # display_name: Write requests - # metric_kind: DELTA - # value_type: INT64 + # Quota configuration helps to achieve fairness and budgeting in service usage. + # The metric based quota configuration works this way: - The service + # configuration defines a set of metrics. - For API calls, the quota. + # metric_rules maps methods to metrics with corresponding costs. - The quota. + # limits defines limits on the metrics, which will be used for quota checks at + # runtime. An example quota configuration in yaml format: quota: limits: - name: + # apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/` + # project`" # rate limit for consumer projects values: STANDARD: 10000 # The + # metric rules bind all methods to the read_calls metric, # except for the + # UpdateBook and DeleteBook methods. These two methods # are mapped to the + # write_calls metric, with the UpdateBook method # consuming at twice rate as + # the DeleteBook method. metric_rules: - selector: "*" metric_costs: library. + # googleapis.com/read_calls: 1 - selector: google.example.library.v1. + # LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - + # selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: + # library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: + # - name: library.googleapis.com/read_calls display_name: Read requests + # metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/ + # write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 class Quota include Google::Apis::Core::Hashable @@ -3141,8 +2704,8 @@ module Google # @return [Array] attr_accessor :limits - # List of `MetricRule` definitions, each one mapping a selected method to one - # or more metrics. + # List of `MetricRule` definitions, each one mapping a selected method to one or + # more metrics. # Corresponds to the JSON property `metricRules` # @return [Array] attr_accessor :metric_rules @@ -3159,95 +2722,89 @@ module Google end # `QuotaLimit` defines a specific limit that applies over a specified duration - # for a limit type. There can be at most one limit for a duration and limit - # type combination defined within a `QuotaGroup`. + # for a limit type. There can be at most one limit for a duration and limit type + # combination defined within a `QuotaGroup`. class QuotaLimit include Google::Apis::Core::Hashable - # Default number of tokens that can be consumed during the specified - # duration. This is the number of tokens assigned when a client - # application developer activates the service for his/her project. - # Specifying a value of 0 will block all requests. This can be used if you - # are provisioning quota to selected consumers and blocking others. - # Similarly, a value of -1 will indicate an unlimited quota. No other - # negative values are allowed. - # Used by group-based quotas only. + # Default number of tokens that can be consumed during the specified duration. + # This is the number of tokens assigned when a client application developer + # activates the service for his/her project. Specifying a value of 0 will block + # all requests. This can be used if you are provisioning quota to selected + # consumers and blocking others. Similarly, a value of -1 will indicate an + # unlimited quota. No other negative values are allowed. Used by group-based + # quotas only. # Corresponds to the JSON property `defaultLimit` # @return [Fixnum] attr_accessor :default_limit - # Optional. User-visible, extended description for this quota limit. - # Should be used only when more context is needed to understand this limit - # than provided by the limit's display name (see: `display_name`). + # Optional. User-visible, extended description for this quota limit. Should be + # used only when more context is needed to understand this limit than provided + # by the limit's display name (see: `display_name`). # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # User-visible display name for this limit. - # Optional. If not set, the UI will provide a default display name based on - # the quota configuration. This field can be used to override the default - # display name generated from the configuration. + # User-visible display name for this limit. Optional. If not set, the UI will + # provide a default display name based on the quota configuration. This field + # can be used to override the default display name generated from the + # configuration. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Duration of this limit in textual notation. Must be "100s" or "1d". - # Used by group-based quotas only. + # Duration of this limit in textual notation. Must be "100s" or "1d". Used by + # group-based quotas only. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration - # Free tier value displayed in the Developers Console for this limit. - # The free tier is the number of tokens that will be subtracted from the - # billed amount when billing is enabled. - # This field can only be set on a limit with duration "1d", in a billable - # group; it is invalid on any other limit. If this field is not set, it - # defaults to 0, indicating that there is no free tier for this service. - # Used by group-based quotas only. + # Free tier value displayed in the Developers Console for this limit. The free + # tier is the number of tokens that will be subtracted from the billed amount + # when billing is enabled. This field can only be set on a limit with duration " + # 1d", in a billable group; it is invalid on any other limit. If this field is + # not set, it defaults to 0, indicating that there is no free tier for this + # service. Used by group-based quotas only. # Corresponds to the JSON property `freeTier` # @return [Fixnum] attr_accessor :free_tier - # Maximum number of tokens that can be consumed during the specified - # duration. Client application developers can override the default limit up - # to this maximum. If specified, this value cannot be set to a value less - # than the default limit. If not specified, it is set to the default limit. - # To allow clients to apply overrides with no upper bound, set this to -1, - # indicating unlimited maximum quota. - # Used by group-based quotas only. + # Maximum number of tokens that can be consumed during the specified duration. + # Client application developers can override the default limit up to this + # maximum. If specified, this value cannot be set to a value less than the + # default limit. If not specified, it is set to the default limit. To allow + # clients to apply overrides with no upper bound, set this to -1, indicating + # unlimited maximum quota. Used by group-based quotas only. # Corresponds to the JSON property `maxLimit` # @return [Fixnum] attr_accessor :max_limit - # The name of the metric this quota limit applies to. The quota limits with - # the same metric will be checked together during runtime. The metric must be + # The name of the metric this quota limit applies to. The quota limits with the + # same metric will be checked together during runtime. The metric must be # defined within the service config. # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric - # Name of the quota limit. - # The name must be provided, and it must be unique within the service. The - # name can only include alphanumeric characters as well as '-'. - # The maximum length of the limit name is 64 characters. + # Name of the quota limit. The name must be provided, and it must be unique + # within the service. The name can only include alphanumeric characters as well + # as '-'. The maximum length of the limit name is 64 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Specify the unit of the quota limit. It uses the same syntax as - # Metric.unit. The supported unit kinds are determined by the quota - # backend system. - # Here are some examples: - # * "1/min/`project`" for quota per minute per project. - # Note: the order of unit components is insignificant. - # The "1" at the beginning is required to follow the metric unit syntax. + # Specify the unit of the quota limit. It uses the same syntax as Metric.unit. + # The supported unit kinds are determined by the quota backend system. Here are + # some examples: * "1/min/`project`" for quota per minute per project. Note: the + # order of unit components is insignificant. The "1" at the beginning is + # required to follow the metric unit syntax. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit # Tiered limit values. You must specify this as a key:value pair, with an - # integer value that is the maximum number of requests allowed for the - # specified unit. Currently only STANDARD is supported. + # integer value that is the maximum number of requests allowed for the specified + # unit. Currently only STANDARD is supported. # Corresponds to the JSON property `values` # @return [Hash] attr_accessor :values @@ -3275,15 +2832,14 @@ module Google class Range include Google::Apis::Core::Hashable - # CIDR range in "10.x.x.x/y" format that is within the - # allocated ranges and currently unused. + # CIDR range in "10.x.x.x/y" format that is within the allocated ranges and + # currently unused. # Corresponds to the JSON property `ipCidrRange` # @return [String] attr_accessor :ip_cidr_range # In the Shared VPC host project, the VPC network that's peered with the - # consumer network. For example: - # `projects/1234321/global/networks/host-network` + # consumer network. For example: `projects/1234321/global/networks/host-network` # Corresponds to the JSON property `network` # @return [String] attr_accessor :network @@ -3304,19 +2860,17 @@ module Google include Google::Apis::Core::Hashable # Required. The size of the desired subnet. Use usual CIDR range notation. For - # example, - # '30' to find unused x.x.x.x/30 CIDR range. The goal is to determine if one - # of the allocated ranges has enough free space for a subnet of the requested - # size. + # example, '30' to find unused x.x.x.x/30 CIDR range. The goal is to determine + # if one of the allocated ranges has enough free space for a subnet of the + # requested size. # Corresponds to the JSON property `ipPrefixLength` # @return [Fixnum] attr_accessor :ip_prefix_length - # Optional. DO NOT USE - Under development. - # The size of the desired secondary ranges for the subnet. Use usual CIDR - # range notation. For example, '30' to find unused x.x.x.x/30 CIDR range. The - # goal is to determine that the allocated ranges have enough free space for - # all the requested secondary ranges. + # Optional. DO NOT USE - Under development. The size of the desired secondary + # ranges for the subnet. Use usual CIDR range notation. For example, '30' to + # find unused x.x.x.x/30 CIDR range. The goal is to determine that the allocated + # ranges have enough free space for all the requested secondary ranges. # Corresponds to the JSON property `secondaryRangeIpPrefixLengths` # @return [Array] attr_accessor :secondary_range_ip_prefix_lengths @@ -3353,9 +2907,8 @@ module Google include Google::Apis::Core::Hashable # Required. The network that the consumer is using to connect with services. - # Must be in the form of projects/`project`/global/networks/`network` - # `project` is the project number, as in '12345' - # `network` is the network name. + # Must be in the form of projects/`project`/global/networks/`network` `project` + # is the project number, as in '12345' `network` is the network name. # Corresponds to the JSON property `consumerNetwork` # @return [String] attr_accessor :consumer_network @@ -3366,8 +2919,7 @@ module Google attr_accessor :dns_record_set # Required. The name of the private DNS zone in the shared producer host project - # from - # which the record set will be removed. + # from which the record set will be removed. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3417,16 +2969,14 @@ module Google include Google::Apis::Core::Hashable # Required. The network that the consumer is using to connect with services. - # Must be in the form of projects/`project`/global/networks/`network` - # `project` is the project number, as in '12345' - # `network` is the network name. + # Must be in the form of projects/`project`/global/networks/`network` `project` + # is the project number, as in '12345' `network` is the network name. # Corresponds to the JSON property `consumerNetwork` # @return [String] attr_accessor :consumer_network # Required. The name for both the private zone in the shared producer host - # project and - # the peering zone in the consumer project. + # project and the peering zone in the consumer project. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3471,15 +3021,15 @@ module Google attr_accessor :name # Fully-qualified URL of the VPC network in the producer host tenant project - # that this route applies to. For example: - # `projects/123456/global/networks/host-network` + # that this route applies to. For example: `projects/123456/global/networks/host- + # network` # Corresponds to the JSON property `network` # @return [String] attr_accessor :network # Fully-qualified URL of the gateway that should handle matching packets that - # this route applies to. For example: - # `projects/123456/global/gateways/default-internet-gateway` + # this route applies to. For example: `projects/123456/global/gateways/default- + # internet-gateway` # Corresponds to the JSON property `nextHopGateway` # @return [String] attr_accessor :next_hop_gateway @@ -3502,18 +3052,17 @@ module Google include Google::Apis::Core::Hashable # Required. The prefix length of the IP range. Use usual CIDR range notation. - # For - # example, '30' to find unused x.x.x.x/30 CIDR range. Actual range will be - # determined using allocated range for the consumer peered network and - # returned in the result. + # For example, '30' to find unused x.x.x.x/30 CIDR range. Actual range will be + # determined using allocated range for the consumer peered network and returned + # in the result. # Corresponds to the JSON property `ipPrefixLength` # @return [Fixnum] attr_accessor :ip_prefix_length - # Network name in the consumer project. This network must have been - # already peered with a shared VPC network using CreateConnection - # method. Must be in a form 'projects/`project`/global/networks/`network`'. - # `project` is a project number, as in '12345' `network` is network name. + # Network name in the consumer project. This network must have been already + # peered with a shared VPC network using CreateConnection method. Must be in a + # form 'projects/`project`/global/networks/`network`'. `project` is a project + # number, as in '12345' `network` is network name. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network @@ -3530,50 +3079,32 @@ module Google end # `Service` is the root object of Google service configuration schema. It - # describes basic information about a service, such as the name and the - # title, and delegates other aspects to sub-sections. Each sub-section is - # either a proto message or a repeated proto message that configures a - # specific aspect, such as auth. See each proto message definition for details. - # Example: - # type: google.api.Service - # config_version: 3 - # name: calendar.googleapis.com - # title: Google Calendar API - # apis: - # - name: google.calendar.v3.Calendar - # authentication: - # providers: - # - id: google_calendar_auth - # jwks_uri: https://www.googleapis.com/oauth2/v1/certs - # issuer: https://securetoken.google.com - # rules: - # - selector: "*" - # requirements: - # provider_id: google_calendar_auth + # describes basic information about a service, such as the name and the title, + # and delegates other aspects to sub-sections. Each sub-section is either a + # proto message or a repeated proto message that configures a specific aspect, + # such as auth. See each proto message definition for details. Example: type: + # google.api.Service config_version: 3 name: calendar.googleapis.com title: + # Google Calendar API apis: - name: google.calendar.v3.Calendar authentication: + # providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/ + # oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" + # requirements: provider_id: google_calendar_auth class Service include Google::Apis::Core::Hashable - # A list of API interfaces exported by this service. Only the `name` field - # of the google.protobuf.Api needs to be provided by the configuration - # author, as the remaining fields will be derived from the IDL during the - # normalization process. It is an error to specify an API interface here - # which cannot be resolved against the associated IDL files. + # A list of API interfaces exported by this service. Only the `name` field of + # the google.protobuf.Api needs to be provided by the configuration author, as + # the remaining fields will be derived from the IDL during the normalization + # process. It is an error to specify an API interface here which cannot be + # resolved against the associated IDL files. # Corresponds to the JSON property `apis` # @return [Array] attr_accessor :apis - # `Authentication` defines the authentication configuration for an API. - # Example for an API targeted for external use: - # name: calendar.googleapis.com - # authentication: - # providers: - # - id: google_calendar_auth - # jwks_uri: https://www.googleapis.com/oauth2/v1/certs - # issuer: https://securetoken.google.com - # rules: - # - selector: "*" - # requirements: - # provider_id: google_calendar_auth + # `Authentication` defines the authentication configuration for an API. Example + # for an API targeted for external use: name: calendar.googleapis.com + # authentication: providers: - id: google_calendar_auth jwks_uri: https://www. + # googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - + # selector: "*" requirements: provider_id: google_calendar_auth # Corresponds to the JSON property `authentication` # @return [Google::Apis::ServicenetworkingV1::Authentication] attr_accessor :authentication @@ -3583,211 +3114,136 @@ module Google # @return [Google::Apis::ServicenetworkingV1::Backend] attr_accessor :backend - # Billing related configuration of the service. - # The following example shows how to configure monitored resources and metrics - # for billing, `consumer_destinations` is the only supported destination and - # the monitored resources need at least one label key - # `cloud.googleapis.com/location` to indicate the location of the billing - # usage, using different monitored resources between monitoring and billing is - # recommended so they can be evolved independently: - # monitored_resources: - # - type: library.googleapis.com/billing_branch - # labels: - # - key: cloud.googleapis.com/location - # description: | - # Predefined label to support billing location restriction. - # - key: city - # description: | - # Custom label to define the city where the library branch is located - # in. - # - key: name - # description: Custom label to define the name of the library branch. - # metrics: - # - name: library.googleapis.com/book/borrowed_count - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # billing: - # consumer_destinations: - # - monitored_resource: library.googleapis.com/billing_branch - # metrics: - # - library.googleapis.com/book/borrowed_count + # Billing related configuration of the service. The following example shows how + # to configure monitored resources and metrics for billing, ` + # consumer_destinations` is the only supported destination and the monitored + # resources need at least one label key `cloud.googleapis.com/location` to + # indicate the location of the billing usage, using different monitored + # resources between monitoring and billing is recommended so they can be evolved + # independently: monitored_resources: - type: library.googleapis.com/ + # billing_branch labels: - key: cloud.googleapis.com/location description: | + # Predefined label to support billing location restriction. - key: city + # description: | Custom label to define the city where the library branch is + # located in. - key: name description: Custom label to define the name of the + # library branch. metrics: - name: library.googleapis.com/book/borrowed_count + # metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: + # - monitored_resource: library.googleapis.com/billing_branch metrics: - library. + # googleapis.com/book/borrowed_count # Corresponds to the JSON property `billing` # @return [Google::Apis::ServicenetworkingV1::Billing] attr_accessor :billing - # The semantic version of the service configuration. The config version - # affects the interpretation of the service configuration. For example, - # certain features are enabled by default for certain config versions. - # The latest config version is `3`. + # The semantic version of the service configuration. The config version affects + # the interpretation of the service configuration. For example, certain features + # are enabled by default for certain config versions. The latest config version + # is `3`. # Corresponds to the JSON property `configVersion` # @return [Fixnum] attr_accessor :config_version - # `Context` defines which contexts an API requests. - # Example: - # context: - # rules: - # - selector: "*" - # requested: - # - google.rpc.context.ProjectContext - # - google.rpc.context.OriginContext - # The above specifies that all methods in the API request - # `google.rpc.context.ProjectContext` and - # `google.rpc.context.OriginContext`. - # Available context types are defined in package - # `google.rpc.context`. - # This also provides mechanism to whitelist any protobuf message extension that - # can be sent in grpc metadata using “x-goog-ext--bin” and - # “x-goog-ext--jspb” format. For example, list any service - # specific protobuf types that can appear in grpc metadata as follows in your - # yaml file: - # Example: - # context: - # rules: - # - selector: "google.example.library.v1.LibraryService.CreateBook" - # allowed_request_extensions: - # - google.foo.v1.NewExtension - # allowed_response_extensions: - # - google.foo.v1.NewExtension - # You can also specify extension ID instead of fully qualified extension name - # here. + # `Context` defines which contexts an API requests. Example: context: rules: - + # selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc. + # context.OriginContext The above specifies that all methods in the API request ` + # google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. + # Available context types are defined in package `google.rpc.context`. This also + # provides mechanism to whitelist any protobuf message extension that can be + # sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. + # For example, list any service specific protobuf types that can appear in grpc + # metadata as follows in your yaml file: Example: context: rules: - selector: " + # google.example.library.v1.LibraryService.CreateBook" + # allowed_request_extensions: - google.foo.v1.NewExtension + # allowed_response_extensions: - google.foo.v1.NewExtension You can also specify + # extension ID instead of fully qualified extension name here. # Corresponds to the JSON property `context` # @return [Google::Apis::ServicenetworkingV1::Context] attr_accessor :context - # Selects and configures the service controller used by the service. The - # service controller handles features like abuse, quota, billing, logging, - # monitoring, etc. + # Selects and configures the service controller used by the service. The service + # controller handles features like abuse, quota, billing, logging, monitoring, + # etc. # Corresponds to the JSON property `control` # @return [Google::Apis::ServicenetworkingV1::Control] attr_accessor :control - # Customize service error responses. For example, list any service - # specific protobuf types that can appear in error detail lists of - # error responses. - # Example: - # custom_error: - # types: - # - google.foo.v1.CustomError - # - google.foo.v1.AnotherError + # Customize service error responses. For example, list any service specific + # protobuf types that can appear in error detail lists of error responses. + # Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1. + # AnotherError # Corresponds to the JSON property `customError` # @return [Google::Apis::ServicenetworkingV1::CustomError] attr_accessor :custom_error - # `Documentation` provides the information for describing a service. - # Example: - # 
documentation:
-        # summary: >
-        # The Google Calendar API gives access
-        # to most calendar features.
-        # pages:
-        # - name: Overview
-        # content: (== include google/foo/overview.md ==)
-        # - name: Tutorial
-        # content: (== include google/foo/tutorial.md ==)
-        # subpages;
-        # - name: Java
-        # content: (== include google/foo/tutorial_java.md ==)
-        # rules:
-        # - selector: google.calendar.Calendar.Get
-        # description: >
-        # ...
-        # - selector: google.calendar.Calendar.Put
-        # description: >
-        # ...
-        #
- # Documentation is provided in markdown syntax. In addition to - # standard markdown features, definition lists, tables and fenced - # code blocks are supported. Section headers can be provided and are - # interpreted relative to the section nesting of the context where - # a documentation fragment is embedded. - # Documentation from the IDL is merged with documentation defined - # via the config at normalization time, where documentation provided - # by config rules overrides IDL provided. - # A number of constructs specific to the API platform are supported - # in documentation text. - # In order to reference a proto element, the following - # notation can be used: - # 
[fully.qualified.proto.name][]
- # To override the display text used for the link, this can be used: - # 
[display text][fully.qualified.proto.name]
- # Text can be excluded from doc using the following notation: - # 
(-- internal comment --)
- # A few directives are available in documentation. Note that - # directives must appear on a single line to be properly - # identified. The `include` directive includes a markdown file from - # an external source: - # 
(== include path/to/file ==)
- # The `resource_for` directive marks a message to be the resource of - # a collection in REST view. If it is not specified, tools attempt - # to infer the resource from the operations in a collection: - # 
(== resource_for v1.shelves.books ==)
- # The directive `suppress_warning` does not directly affect documentation - # and is documented together with service config validation. + # `Documentation` provides the information for describing a service. Example: + # documentation: summary: > The Google Calendar API gives access to most + # calendar features. pages: - name: Overview content: (== include google/foo/ + # overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md == + # ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==) + # rules: - selector: google.calendar.Calendar.Get description: > ... - selector: + # google.calendar.Calendar.Put description: > ... Documentation is provided in + # markdown syntax. In addition to standard markdown features, definition lists, + # tables and fenced code blocks are supported. Section headers can be provided + # and are interpreted relative to the section nesting of the context where a + # documentation fragment is embedded. Documentation from the IDL is merged with + # documentation defined via the config at normalization time, where + # documentation provided by config rules overrides IDL provided. A number of + # constructs specific to the API platform are supported in documentation text. + # In order to reference a proto element, the following notation can be used: [ + # fully.qualified.proto.name][] To override the display text used for the link, + # this can be used: [display text][fully.qualified.proto.name] Text can be + # excluded from doc using the following notation: (-- internal comment --) A few + # directives are available in documentation. Note that directives must appear on + # a single line to be properly identified. The `include` directive includes a + # markdown file from an external source: (== include path/to/file ==) The ` + # resource_for` directive marks a message to be the resource of a collection in + # REST view. If it is not specified, tools attempt to infer the resource from + # the operations in a collection: (== resource_for v1.shelves.books ==) The + # directive `suppress_warning` does not directly affect documentation and is + # documented together with service config validation. # Corresponds to the JSON property `documentation` # @return [Google::Apis::ServicenetworkingV1::Documentation] attr_accessor :documentation - # Configuration for network endpoints. If this is empty, then an endpoint - # with the same name as the service is automatically generated to service all - # defined APIs. + # Configuration for network endpoints. If this is empty, then an endpoint with + # the same name as the service is automatically generated to service all defined + # APIs. # Corresponds to the JSON property `endpoints` # @return [Array] attr_accessor :endpoints - # A list of all enum types included in this API service. Enums - # referenced directly or indirectly by the `apis` are automatically - # included. Enums which are not referenced but shall be included - # should be listed here by name. Example: - # enums: - # - name: google.someapi.v1.SomeEnum + # A list of all enum types included in this API service. Enums referenced + # directly or indirectly by the `apis` are automatically included. Enums which + # are not referenced but shall be included should be listed here by name. + # Example: enums: - name: google.someapi.v1.SomeEnum # Corresponds to the JSON property `enums` # @return [Array] attr_accessor :enums # Defines the HTTP configuration for an API service. It contains a list of - # HttpRule, each specifying the mapping of an RPC method - # to one or more HTTP REST API methods. + # HttpRule, each specifying the mapping of an RPC method to one or more HTTP + # REST API methods. # Corresponds to the JSON property `http` # @return [Google::Apis::ServicenetworkingV1::Http] attr_accessor :http - # A unique ID for a specific instance of this message, typically assigned - # by the client for tracking purpose. Must be no longer than 63 characters - # and only lower case letters, digits, '.', '_' and '-' are allowed. If - # empty, the server may choose to generate one instead. + # A unique ID for a specific instance of this message, typically assigned by the + # client for tracking purpose. Must be no longer than 63 characters and only + # lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server + # may choose to generate one instead. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Logging configuration of the service. - # The following example shows how to configure logs to be sent to the - # producer and consumer projects. In the example, the `activity_history` - # log is sent to both the producer and consumer projects, whereas the - # `purchase_history` log is only sent to the producer project. - # monitored_resources: - # - type: library.googleapis.com/branch - # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. - # logs: - # - name: activity_history - # labels: - # - key: /customer_id - # - name: purchase_history - # logging: - # producer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history - # - purchase_history - # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history + # Logging configuration of the service. The following example shows how to + # configure logs to be sent to the producer and consumer projects. In the + # example, the `activity_history` log is sent to both the producer and consumer + # projects, whereas the `purchase_history` log is only sent to the producer + # project. monitored_resources: - type: library.googleapis.com/branch labels: - + # key: /city description: The city where the library branch is located in. - key: + # /name description: The name of the branch. logs: - name: activity_history + # labels: - key: /customer_id - name: purchase_history logging: + # producer_destinations: - monitored_resource: library.googleapis.com/branch + # logs: - activity_history - purchase_history consumer_destinations: - + # monitored_resource: library.googleapis.com/branch logs: - activity_history # Corresponds to the JSON property `logging` # @return [Google::Apis::ServicenetworkingV1::Logging] attr_accessor :logging @@ -3802,70 +3258,41 @@ module Google # @return [Array] attr_accessor :metrics - # Defines the monitored resources used by this service. This is required - # by the Service.monitoring and Service.logging configurations. + # Defines the monitored resources used by this service. This is required by the + # Service.monitoring and Service.logging configurations. # Corresponds to the JSON property `monitoredResources` # @return [Array] attr_accessor :monitored_resources - # Monitoring configuration of the service. - # The example below shows how to configure monitored resources and metrics - # for monitoring. In the example, a monitored resource and two metrics are - # defined. The `library.googleapis.com/book/returned_count` metric is sent - # to both producer and consumer projects, whereas the - # `library.googleapis.com/book/num_overdue` metric is only sent to the - # consumer project. - # monitored_resources: - # - type: library.googleapis.com/Branch - # display_name: "Library Branch" - # description: "A branch of a library." - # launch_stage: GA - # labels: - # - key: resource_container - # description: "The Cloud container (ie. project id) for the Branch." - # - key: location - # description: "The location of the library branch." - # - key: branch_id - # description: "The id of the branch." - # metrics: - # - name: library.googleapis.com/book/returned_count - # display_name: "Books Returned" - # description: "The count of books that have been returned." - # launch_stage: GA - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # - name: library.googleapis.com/book/num_overdue - # display_name: "Books Overdue" - # description: "The current number of overdue books." - # launch_stage: GA - # metric_kind: GAUGE - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # monitoring: - # producer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # consumer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # - library.googleapis.com/book/num_overdue + # Monitoring configuration of the service. The example below shows how to + # configure monitored resources and metrics for monitoring. In the example, a + # monitored resource and two metrics are defined. The `library.googleapis.com/ + # book/returned_count` metric is sent to both producer and consumer projects, + # whereas the `library.googleapis.com/book/num_overdue` metric is only sent to + # the consumer project. monitored_resources: - type: library.googleapis.com/ + # Branch display_name: "Library Branch" description: "A branch of a library." + # launch_stage: GA labels: - key: resource_container description: "The Cloud + # container (ie. project id) for the Branch." - key: location description: "The + # location of the library branch." - key: branch_id description: "The id of the + # branch." metrics: - name: library.googleapis.com/book/returned_count + # display_name: "Books Returned" description: "The count of books that have been + # returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" + # labels: - key: customer_id description: "The id of the customer." - name: + # library.googleapis.com/book/num_overdue display_name: "Books Overdue" + # description: "The current number of overdue books." launch_stage: GA + # metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id + # description: "The id of the customer." monitoring: producer_destinations: - + # monitored_resource: library.googleapis.com/Branch metrics: - library. + # googleapis.com/book/returned_count consumer_destinations: - monitored_resource: + # library.googleapis.com/Branch metrics: - library.googleapis.com/book/ + # returned_count - library.googleapis.com/book/num_overdue # Corresponds to the JSON property `monitoring` # @return [Google::Apis::ServicenetworkingV1::Monitoring] attr_accessor :monitoring - # The service name, which is a DNS-like logical identifier for the - # service, such as `calendar.googleapis.com`. The service name - # typically goes through DNS verification to make sure the owner - # of the service also owns the DNS name. + # The service name, which is a DNS-like logical identifier for the service, such + # as `calendar.googleapis.com`. The service name typically goes through DNS + # verification to make sure the owner of the service also owns the DNS name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3875,46 +3302,25 @@ module Google # @return [String] attr_accessor :producer_project_id - # Quota configuration helps to achieve fairness and budgeting in service - # usage. - # The metric based quota configuration works this way: - # - The service configuration defines a set of metrics. - # - For API calls, the quota.metric_rules maps methods to metrics with - # corresponding costs. - # - The quota.limits defines limits on the metrics, which will be used for - # quota checks at runtime. - # An example quota configuration in yaml format: - # quota: - # limits: - # - name: apiWriteQpsPerProject - # metric: library.googleapis.com/write_calls - # unit: "1/min/`project`" # rate limit for consumer projects - # values: - # STANDARD: 10000 - # # The metric rules bind all methods to the read_calls metric, - # # except for the UpdateBook and DeleteBook methods. These two methods - # # are mapped to the write_calls metric, with the UpdateBook method - # # consuming at twice rate as the DeleteBook method. - # metric_rules: - # - selector: "*" - # metric_costs: - # library.googleapis.com/read_calls: 1 - # - selector: google.example.library.v1.LibraryService.UpdateBook - # metric_costs: - # library.googleapis.com/write_calls: 2 - # - selector: google.example.library.v1.LibraryService.DeleteBook - # metric_costs: - # library.googleapis.com/write_calls: 1 - # Corresponding Metric definition: - # metrics: - # - name: library.googleapis.com/read_calls - # display_name: Read requests - # metric_kind: DELTA - # value_type: INT64 - # - name: library.googleapis.com/write_calls - # display_name: Write requests - # metric_kind: DELTA - # value_type: INT64 + # Quota configuration helps to achieve fairness and budgeting in service usage. + # The metric based quota configuration works this way: - The service + # configuration defines a set of metrics. - For API calls, the quota. + # metric_rules maps methods to metrics with corresponding costs. - The quota. + # limits defines limits on the metrics, which will be used for quota checks at + # runtime. An example quota configuration in yaml format: quota: limits: - name: + # apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/` + # project`" # rate limit for consumer projects values: STANDARD: 10000 # The + # metric rules bind all methods to the read_calls metric, # except for the + # UpdateBook and DeleteBook methods. These two methods # are mapped to the + # write_calls metric, with the UpdateBook method # consuming at twice rate as + # the DeleteBook method. metric_rules: - selector: "*" metric_costs: library. + # googleapis.com/read_calls: 1 - selector: google.example.library.v1. + # LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - + # selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: + # library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: + # - name: library.googleapis.com/read_calls display_name: Read requests + # metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/ + # write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 # Corresponds to the JSON property `quota` # @return [Google::Apis::ServicenetworkingV1::Quota] attr_accessor :quota @@ -3924,20 +3330,18 @@ module Google # @return [Google::Apis::ServicenetworkingV1::SourceInfo] attr_accessor :source_info - # ### System parameter configuration - # A system parameter is a special kind of parameter defined by the API - # system, not by an individual API. It is typically mapped to an HTTP header - # and/or a URL query parameter. This configuration specifies which methods - # change the names of the system parameters. + # ### System parameter configuration A system parameter is a special kind of + # parameter defined by the API system, not by an individual API. It is typically + # mapped to an HTTP header and/or a URL query parameter. This configuration + # specifies which methods change the names of the system parameters. # Corresponds to the JSON property `systemParameters` # @return [Google::Apis::ServicenetworkingV1::SystemParameters] attr_accessor :system_parameters - # A list of all proto message types included in this API service. - # It serves similar purpose as [google.api.Service.types], except that - # these types are not needed by user-defined APIs. Therefore, they will not - # show up in the generated discovery doc. This field should only be used - # to define system APIs in ESF. + # A list of all proto message types included in this API service. It serves + # similar purpose as [google.api.Service.types], except that these types are not + # needed by user-defined APIs. Therefore, they will not show up in the generated + # discovery doc. This field should only be used to define system APIs in ESF. # Corresponds to the JSON property `systemTypes` # @return [Array] attr_accessor :system_types @@ -3947,12 +3351,10 @@ module Google # @return [String] attr_accessor :title - # A list of all proto message types included in this API service. - # Types referenced directly or indirectly by the `apis` are - # automatically included. Messages which are not referenced but - # shall be included, such as types used by the `google.protobuf.Any` type, - # should be listed here by name. Example: - # types: + # A list of all proto message types included in this API service. Types + # referenced directly or indirectly by the `apis` are automatically included. + # Messages which are not referenced but shall be included, such as types used by + # the `google.protobuf.Any` type, should be listed here by name. Example: types: # - name: google.protobuf.Int32 # Corresponds to the JSON property `types` # @return [Array] @@ -3999,32 +3401,28 @@ module Google end end - # The per-product per-project service identity for a service. - # Use this field to configure per-product per-project service identity. - # Example of a service identity configuration. - # usage: - # service_identity: - # - service_account_parent: "projects/123456789" - # display_name: "Cloud XXX Service Agent" - # description: "Used as the identity of Cloud XXX to access resources" + # The per-product per-project service identity for a service. Use this field to + # configure per-product per-project service identity. Example of a service + # identity configuration. usage: service_identity: - service_account_parent: " + # projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used + # as the identity of Cloud XXX to access resources" class ServiceIdentity include Google::Apis::Core::Hashable - # Optional. A user-specified opaque description of the service account. - # Must be less than or equal to 256 UTF-8 bytes. + # Optional. A user-specified opaque description of the service account. Must be + # less than or equal to 256 UTF-8 bytes. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Optional. A user-specified name for the service account. - # Must be less than or equal to 100 UTF-8 bytes. + # Optional. A user-specified name for the service account. Must be less than or + # equal to 100 UTF-8 bytes. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # A service account project that hosts the service accounts. - # An example name would be: - # `projects/123456789` + # A service account project that hosts the service accounts. An example name + # would be: `projects/123456789` # Corresponds to the JSON property `serviceAccountParent` # @return [String] attr_accessor :service_account_parent @@ -4041,13 +3439,13 @@ module Google end end - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. class SourceContext include Google::Apis::Core::Hashable # The path-qualified name of the .proto file that contained the associated - # protobuf element. For example: `"google/protobuf/source_context.proto"`. + # protobuf element. For example: `"google/protobuf/source_context.proto"`. # Corresponds to the JSON property `fileName` # @return [String] attr_accessor :file_name @@ -4081,12 +3479,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 @@ -4095,15 +3493,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 @@ -4130,21 +3528,19 @@ module Google # @return [String] attr_accessor :ip_cidr_range - # Subnetwork name. - # See https://cloud.google.com/compute/docs/vpc/ + # Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # In the Shared VPC host project, the VPC network that's peered with the - # consumer network. For example: - # `projects/1234321/global/networks/host-network` + # consumer network. For example: `projects/1234321/global/networks/host-network` # Corresponds to the JSON property `network` # @return [String] attr_accessor :network - # This is a discovered subnet that is not within the current consumer - # allocated ranges. + # This is a discovered subnet that is not within the current consumer allocated + # ranges. # Corresponds to the JSON property `outsideAllocation` # @return [Boolean] attr_accessor :outside_allocation @@ -4169,8 +3565,7 @@ module Google class SystemParameter include Google::Apis::Core::Hashable - # Define the HTTP header name to use for the parameter. It is case - # insensitive. + # Define the HTTP header name to use for the parameter. It is case insensitive. # Corresponds to the JSON property `httpHeader` # @return [String] attr_accessor :http_header @@ -4198,23 +3593,20 @@ module Google end end - # Define a system parameter rule mapping system parameter definitions to - # methods. + # Define a system parameter rule mapping system parameter definitions to methods. class SystemParameterRule include Google::Apis::Core::Hashable - # Define parameters. Multiple names may be defined for a parameter. - # For a given method call, only one of them should be used. If multiple - # names are used the behavior is implementation-dependent. - # If none of the specified names are present the behavior is - # parameter-dependent. + # Define parameters. Multiple names may be defined for a parameter. For a given + # method call, only one of them should be used. If multiple names are used the + # behavior is implementation-dependent. If none of the specified names are + # present the behavior is parameter-dependent. # Corresponds to the JSON property `parameters` # @return [Array] attr_accessor :parameters # Selects the methods to which this rule applies. Use '*' to indicate all - # methods in all APIs. - # Refer to selector for syntax details. + # methods in all APIs. Refer to selector for syntax details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -4230,36 +3622,23 @@ module Google end end - # ### System parameter configuration - # A system parameter is a special kind of parameter defined by the API - # system, not by an individual API. It is typically mapped to an HTTP header - # and/or a URL query parameter. This configuration specifies which methods - # change the names of the system parameters. + # ### System parameter configuration A system parameter is a special kind of + # parameter defined by the API system, not by an individual API. It is typically + # mapped to an HTTP header and/or a URL query parameter. This configuration + # specifies which methods change the names of the system parameters. class SystemParameters include Google::Apis::Core::Hashable - # Define system parameters. - # The parameters defined here will override the default parameters - # implemented by the system. If this field is missing from the service - # config, default system parameters will be used. Default system parameters - # and names is implementation-dependent. - # Example: define api key for all methods - # system_parameters - # rules: - # - selector: "*" - # parameters: - # - name: api_key - # url_query_parameter: api_key - # Example: define 2 api key names for a specific method. - # system_parameters - # rules: - # - selector: "/ListShelves" - # parameters: - # - name: api_key - # http_header: Api-Key1 - # - name: api_key - # http_header: Api-Key2 - # **NOTE:** All service configuration rules follow "last one wins" order. + # Define system parameters. The parameters defined here will override the + # default parameters implemented by the system. If this field is missing from + # the service config, default system parameters will be used. Default system + # parameters and names is implementation-dependent. Example: define api key for + # all methods system_parameters rules: - selector: "*" parameters: - name: + # api_key url_query_parameter: api_key Example: define 2 api key names for a + # specific method. system_parameters rules: - selector: "/ListShelves" + # parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: + # Api-Key2 **NOTE:** All service configuration rules follow "last one wins" + # order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -4298,8 +3677,8 @@ module Google # @return [Array] attr_accessor :options - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. # Corresponds to the JSON property `sourceContext` # @return [Google::Apis::ServicenetworkingV1::SourceContext] attr_accessor :source_context @@ -4340,15 +3719,13 @@ module Google # Request to update a record set from a private managed DNS zone in the shared # producer host project. The name, type, ttl, and data values of the existing - # record set must all exactly match an existing record set in the specified - # zone. + # record set must all exactly match an existing record set in the specified zone. class UpdateDnsRecordSetRequest include Google::Apis::Core::Hashable # Required. The network that the consumer is using to connect with services. - # Must be in the form of projects/`project`/global/networks/`network` - # `project` is the project number, as in '12345' - # `network` is the network name. + # Must be in the form of projects/`project`/global/networks/`network` `project` + # is the project number, as in '12345' `network` is the network name. # Corresponds to the JSON property `consumerNetwork` # @return [String] attr_accessor :consumer_network @@ -4364,8 +3741,7 @@ module Google attr_accessor :new_dns_record_set # Required. The name of the private DNS zone in the shared producer host project - # from - # which the record set will be removed. + # from which the record set will be removed. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -4388,37 +3764,33 @@ module Google include Google::Apis::Core::Hashable # The full resource name of a channel used for sending notifications to the - # service producer. - # Google Service Management currently only supports - # [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification - # channel. To use Google Cloud Pub/Sub as the channel, this must be the name - # of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format - # documented in https://cloud.google.com/pubsub/docs/overview. + # service producer. Google Service Management currently only supports [Google + # Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To + # use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/ + # Sub topic that uses the Cloud Pub/Sub topic name format documented in https:// + # cloud.google.com/pubsub/docs/overview. # Corresponds to the JSON property `producerNotificationChannel` # @return [String] attr_accessor :producer_notification_channel # Requirements that must be satisfied before a consumer project can use the - # service. Each requirement is of the form /; - # for example 'serviceusage.googleapis.com/billing-enabled'. + # service. Each requirement is of the form /; for example 'serviceusage. + # googleapis.com/billing-enabled'. # Corresponds to the JSON property `requirements` # @return [Array] attr_accessor :requirements - # A list of usage rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of usage rules that apply to individual API methods. **NOTE:** All + # service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules - # The per-product per-project service identity for a service. - # Use this field to configure per-product per-project service identity. - # Example of a service identity configuration. - # usage: - # service_identity: - # - service_account_parent: "projects/123456789" - # display_name: "Cloud XXX Service Agent" - # description: "Used as the identity of Cloud XXX to access resources" + # The per-product per-project service identity for a service. Use this field to + # configure per-product per-project service identity. Example of a service + # identity configuration. usage: service_identity: - service_account_parent: " + # projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used + # as the identity of Cloud XXX to access resources" # Corresponds to the JSON property `serviceIdentity` # @return [Google::Apis::ServicenetworkingV1::ServiceIdentity] attr_accessor :service_identity @@ -4436,45 +3808,36 @@ module Google end end - # Usage configuration rules for the service. - # NOTE: Under development. - # Use this rule to configure unregistered calls for the service. Unregistered - # calls are calls that do not contain consumer project identity. - # (Example: calls that do not contain an API key). - # By default, API methods do not allow unregistered calls, and each method call - # must be identified by a consumer project identity. Use this rule to - # allow/disallow unregistered calls. - # Example of an API that wants to allow unregistered calls for entire service. - # usage: - # rules: - # - selector: "*" - # allow_unregistered_calls: true - # Example of a method that wants to allow unregistered calls. - # usage: - # rules: - # - selector: "google.example.library.v1.LibraryService.CreateBook" - # allow_unregistered_calls: true + # Usage configuration rules for the service. NOTE: Under development. Use this + # rule to configure unregistered calls for the service. Unregistered calls are + # calls that do not contain consumer project identity. (Example: calls that do + # not contain an API key). By default, API methods do not allow unregistered + # calls, and each method call must be identified by a consumer project identity. + # Use this rule to allow/disallow unregistered calls. Example of an API that + # wants to allow unregistered calls for entire service. usage: rules: - selector: + # "*" allow_unregistered_calls: true Example of a method that wants to allow + # unregistered calls. usage: rules: - selector: "google.example.library.v1. + # LibraryService.CreateBook" allow_unregistered_calls: true class UsageRule include Google::Apis::Core::Hashable - # If true, the selected method allows unregistered calls, e.g. calls - # that don't identify any user or application. + # If true, the selected method allows unregistered calls, e.g. calls that don't + # identify any user or application. # Corresponds to the JSON property `allowUnregisteredCalls` # @return [Boolean] attr_accessor :allow_unregistered_calls alias_method :allow_unregistered_calls?, :allow_unregistered_calls # Selects the methods to which this rule applies. Use '*' to indicate all - # methods in all APIs. - # Refer to selector for syntax details. + # methods in all APIs. Refer to selector for syntax details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector - # If true, the selected method should skip service control and the control - # plane features, such as quota and billing, will not be available. - # This flag is used by Google Cloud Endpoints to bypass checks for internal - # methods, such as service health check methods. + # If true, the selected method should skip service control and the control plane + # features, such as quota and billing, will not be available. This flag is used + # by Google Cloud Endpoints to bypass checks for internal methods, such as + # service health check methods. # Corresponds to the JSON property `skipServiceControl` # @return [Boolean] attr_accessor :skip_service_control @@ -4497,9 +3860,8 @@ module Google include Google::Apis::Core::Hashable # Required. The network that the consumer is using to connect with services. - # Must be in - # the form of projects/`project`/global/networks/`network` `project` is a - # project number, as in '12345' `network` is network name. + # Must be in the form of projects/`project`/global/networks/`network` `project` + # is a project number, as in '12345' `network` is network name. # Corresponds to the JSON property `consumerNetwork` # @return [String] attr_accessor :consumer_network @@ -4514,13 +3876,12 @@ module Google # @return [Google::Apis::ServicenetworkingV1::RangeReservation] attr_accessor :range_reservation - # The validations will be performed in the order listed in the - # ValidationError enum. The first failure will return. If a validation is not - # requested, then the next one will be performed. - # SERVICE_NETWORKING_NOT_ENABLED and NETWORK_NOT_PEERED checks are performed - # for all requests where validation is requested. NETWORK_NOT_FOUND and - # NETWORK_DISCONNECTED checks are done for requests that have - # validate_network set to true. + # The validations will be performed in the order listed in the ValidationError + # enum. The first failure will return. If a validation is not requested, then + # the next one will be performed. SERVICE_NETWORKING_NOT_ENABLED and + # NETWORK_NOT_PEERED checks are performed for all requests where validation is + # requested. NETWORK_NOT_FOUND and NETWORK_DISCONNECTED checks are done for + # requests that have validate_network set to true. # Corresponds to the JSON property `validateNetwork` # @return [Boolean] attr_accessor :validate_network diff --git a/generated/google/apis/servicenetworking_v1/service.rb b/generated/google/apis/servicenetworking_v1/service.rb index 9a518eb5b..74d491618 100644 --- a/generated/google/apis/servicenetworking_v1/service.rb +++ b/generated/google/apis/servicenetworking_v1/service.rb @@ -48,15 +48,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. @@ -90,10 +88,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 @@ -123,9 +121,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 @@ -155,15 +152,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 @@ -204,20 +200,18 @@ module Google # For service producers, provisions a new subnet in a peered service's shared # VPC network in the requested region and with the requested size that's - # expressed as a CIDR range (number of leading bits of ipV4 network mask). - # The method checks against the assigned allocated ranges to find a - # non-conflicting IP address range. The method will reuse a subnet if - # subsequent calls contain the same subnet name, region, and prefix length. - # This method will make producer's tenant project to be a shared VPC service - # project as needed. + # expressed as a CIDR range (number of leading bits of ipV4 network mask). The + # method checks against the assigned allocated ranges to find a non-conflicting + # IP address range. The method will reuse a subnet if subsequent calls contain + # the same subnet name, region, and prefix length. This method will make + # producer's tenant project to be a shared VPC service project as needed. # @param [String] parent # Required. A tenant project in the service producer organization, in the - # following format: services/`service`/`collection-id`/`resource-id`. - # `collection-id` is the cloud resource collection type that represents the - # tenant project. Only `projects` are supported. - # `resource-id` is the tenant project numeric id, such as - # `123456`. `service` the name of the peering service, such as - # `service-peering.example.com`. This service must already be + # following format: services/`service`/`collection-id`/`resource-id`. ` + # collection-id` is the cloud resource collection type that represents the + # tenant project. Only `projects` are supported. `resource-id` is the tenant + # project numeric id, such as `123456`. `service` the name of the peering + # service, such as `service-peering.example.com`. This service must already be # enabled in the service consumer's project. # @param [Google::Apis::ServicenetworkingV1::AddSubnetworkRequest] add_subnetwork_request_object # @param [String] fields @@ -252,8 +246,8 @@ module Google # Disables VPC service controls for a connection. # @param [String] parent # The service that is managing peering connectivity for a service producer's - # organization. For Google services that support this functionality, this - # value is `services/servicenetworking.googleapis.com`. + # organization. For Google services that support this functionality, this value + # is `services/servicenetworking.googleapis.com`. # @param [Google::Apis::ServicenetworkingV1::DisableVpcServiceControlsRequest] disable_vpc_service_controls_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -287,8 +281,8 @@ module Google # Enables VPC service controls for a connection. # @param [String] parent # The service that is managing peering connectivity for a service producer's - # organization. For Google services that support this functionality, this - # value is `services/servicenetworking.googleapis.com`. + # organization. For Google services that support this functionality, this value + # is `services/servicenetworking.googleapis.com`. # @param [Google::Apis::ServicenetworkingV1::EnableVpcServiceControlsRequest] enable_vpc_service_controls_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -319,16 +313,14 @@ module Google execute_or_queue_command(command, &block) end - # Service producers can use this method to find a currently unused range - # within consumer allocated ranges. This returned range is not reserved, - # and not guaranteed to remain unused. It will validate previously provided - # allocated ranges, find non-conflicting sub-range of requested size - # (expressed in number of leading bits of ipv4 network mask, as in CIDR range - # notation). + # Service producers can use this method to find a currently unused range within + # consumer allocated ranges. This returned range is not reserved, and not + # guaranteed to remain unused. It will validate previously provided allocated + # ranges, find non-conflicting sub-range of requested size (expressed in number + # of leading bits of ipv4 network mask, as in CIDR range notation). # @param [String] parent # Required. This is in a form services/`service`. `service` the name of the - # private - # access management service, for example 'service-peering.example.com'. + # private access management service, for example 'service-peering.example.com'. # @param [Google::Apis::ServicenetworkingV1::SearchRangeRequest] search_range_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -359,15 +351,14 @@ module Google execute_or_queue_command(command, &block) end - # Service producers use this method to validate if the consumer provided - # network, project and requested range are valid. This allows them to use - # a fail-fast mechanism for consumer requests, and not have to wait for - # AddSubnetwork operation completion to determine if user request is invalid. + # Service producers use this method to validate if the consumer provided network, + # project and requested range are valid. This allows them to use a fail-fast + # mechanism for consumer requests, and not have to wait for AddSubnetwork + # operation completion to determine if user request is invalid. # @param [String] parent # Required. This is in a form services/`service` where `service` is the name of - # the - # private access management service. For example - # 'service-peering.example.com'. + # the private access management service. For example 'service-peering.example. + # com'. # @param [Google::Apis::ServicenetworkingV1::ValidateConsumerConfigRequest] validate_consumer_config_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -398,17 +389,17 @@ module Google execute_or_queue_command(command, &block) end - # Creates a private connection that establishes a VPC Network Peering - # connection to a VPC network in the service producer's organization. - # The administrator of the service consumer's VPC network invokes this - # method. The administrator must assign one or more allocated IP ranges for - # provisioning subnetworks in the service producer's VPC network. This - # connection is used for all supported services in the service producer's - # organization, so it only needs to be invoked once. + # Creates a private connection that establishes a VPC Network Peering connection + # to a VPC network in the service producer's organization. The administrator of + # the service consumer's VPC network invokes this method. The administrator must + # assign one or more allocated IP ranges for provisioning subnetworks in the + # service producer's VPC network. This connection is used for all supported + # services in the service producer's organization, so it only needs to be + # invoked once. # @param [String] parent # The service that is managing peering connectivity for a service producer's - # organization. For Google services that support this functionality, this - # value is `services/servicenetworking.googleapis.com`. + # organization. For Google services that support this functionality, this value + # is `services/servicenetworking.googleapis.com`. # @param [Google::Apis::ServicenetworkingV1::Connection] connection_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -439,22 +430,19 @@ module Google execute_or_queue_command(command, &block) end - # List the private connections that are configured in a service consumer's - # VPC network. + # List the private connections that are configured in a service consumer's VPC + # network. # @param [String] parent # The service that is managing peering connectivity for a service producer's - # organization. For Google services that support this functionality, this - # value is `services/servicenetworking.googleapis.com`. - # If you specify `services/-` as the parameter value, all configured peering - # services are listed. + # organization. For Google services that support this functionality, this value + # is `services/servicenetworking.googleapis.com`. If you specify `services/-` as + # the parameter value, all configured peering services are listed. # @param [String] network # The name of service consumer's VPC network that's connected with service - # producer network through a private connection. The network name must be in - # the following format: - # `projects/`project`/global/networks/`network``. `project` is a - # project number, such as in `12345` that includes the VPC service - # consumer's VPC network. `network` is the name of the service consumer's VPC - # network. + # producer network through a private connection. The network name must be in the + # following format: `projects/`project`/global/networks/`network``. `project` is + # a project number, such as in `12345` that includes the VPC service consumer's + # VPC network. `network` is the name of the service consumer's VPC network. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -487,18 +475,17 @@ module Google # @param [String] name # The private service connection that connects to a service producer # organization. The name includes both the private service name and the VPC - # network peering name in the format of - # `services/`peering_service_name`/connections/`vpc_peering_name``. For - # Google services that support this functionality, this is - # `services/servicenetworking.googleapis.com/connections/servicenetworking- - # googleapis-com`. + # network peering name in the format of `services/`peering_service_name`/ + # connections/`vpc_peering_name``. For Google services that support this + # functionality, this is `services/servicenetworking.googleapis.com/connections/ + # servicenetworking-googleapis-com`. # @param [Google::Apis::ServicenetworkingV1::Connection] connection_object # @param [Boolean] force - # If a previously defined allocated range is removed, force flag must be - # set to true. + # If a previously defined allocated range is removed, force flag must be set to + # true. # @param [String] update_mask - # The update mask. If this is omitted, it defaults to "*". You can only - # update the listed peering ranges. + # The update mask. If this is omitted, it defaults to "*". You can only update + # the listed peering ranges. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -534,9 +521,8 @@ module Google # zones in the shared producer host project. # @param [String] parent # Required. The service that is managing peering connectivity for a service - # producer's - # organization. For Google services that support this functionality, this - # value is `services/servicenetworking.googleapis.com`. + # producer's organization. For Google services that support this functionality, + # this value is `services/servicenetworking.googleapis.com`. # @param [Google::Apis::ServicenetworkingV1::AddDnsRecordSetRequest] add_dns_record_set_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -567,13 +553,12 @@ module Google execute_or_queue_command(command, &block) end - # Service producers can use this method to remove DNS record sets from - # private DNS zones in the shared producer host project. + # Service producers can use this method to remove DNS record sets from private + # DNS zones in the shared producer host project. # @param [String] parent # Required. The service that is managing peering connectivity for a service - # producer's - # organization. For Google services that support this functionality, this - # value is `services/servicenetworking.googleapis.com`. + # producer's organization. For Google services that support this functionality, + # this value is `services/servicenetworking.googleapis.com`. # @param [Google::Apis::ServicenetworkingV1::RemoveDnsRecordSetRequest] remove_dns_record_set_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -604,13 +589,12 @@ module Google execute_or_queue_command(command, &block) end - # Service producers can use this method to update DNS record sets from - # private DNS zones in the shared producer host project. + # Service producers can use this method to update DNS record sets from private + # DNS zones in the shared producer host project. # @param [String] parent # Required. The service that is managing peering connectivity for a service - # producer's - # organization. For Google services that support this functionality, this - # value is `services/servicenetworking.googleapis.com`. + # producer's organization. For Google services that support this functionality, + # this value is `services/servicenetworking.googleapis.com`. # @param [Google::Apis::ServicenetworkingV1::UpdateDnsRecordSetRequest] update_dns_record_set_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -641,14 +625,12 @@ module Google execute_or_queue_command(command, &block) end - # Service producers can use this method to add private DNS zones in the - # shared producer host project and matching peering zones in the consumer - # project. + # Service producers can use this method to add private DNS zones in the shared + # producer host project and matching peering zones in the consumer project. # @param [String] parent # Required. The service that is managing peering connectivity for a service - # producer's - # organization. For Google services that support this functionality, this - # value is `services/servicenetworking.googleapis.com`. + # producer's organization. For Google services that support this functionality, + # this value is `services/servicenetworking.googleapis.com`. # @param [Google::Apis::ServicenetworkingV1::AddDnsZoneRequest] add_dns_zone_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -684,9 +666,8 @@ module Google # project. # @param [String] parent # Required. The service that is managing peering connectivity for a service - # producer's - # organization. For Google services that support this functionality, this - # value is `services/servicenetworking.googleapis.com`. + # producer's organization. For Google services that support this functionality, + # this value is `services/servicenetworking.googleapis.com`. # @param [Google::Apis::ServicenetworkingV1::RemoveDnsZoneRequest] remove_dns_zone_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -718,14 +699,13 @@ module Google end # Service producers can use this method to add roles in the shared VPC host - # project. Each role is bound to the provided member. Each role must be - # selected from within a whitelisted set of roles. Each role is applied at - # only the granularity specified in the whitelist. + # project. Each role is bound to the provided member. Each role must be selected + # from within a whitelisted set of roles. Each role is applied at only the + # granularity specified in the whitelist. # @param [String] parent # Required. This is in a form services/`service` where `service` is the name of - # the - # private access management service. For example - # 'service-peering.example.com'. + # the private access management service. For example 'service-peering.example. + # com'. # @param [Google::Apis::ServicenetworkingV1::AddRolesRequest] add_roles_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/servicenetworking_v1beta.rb b/generated/google/apis/servicenetworking_v1beta.rb index 5f401d6ec..5eb2d5d03 100644 --- a/generated/google/apis/servicenetworking_v1beta.rb +++ b/generated/google/apis/servicenetworking_v1beta.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started module ServicenetworkingV1beta VERSION = 'V1beta' - REVISION = '20200721' + REVISION = '20200801' # 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_v1beta/classes.rb b/generated/google/apis/servicenetworking_v1beta/classes.rb index 97538fcf5..e1ce96684 100644 --- a/generated/google/apis/servicenetworking_v1beta/classes.rb +++ b/generated/google/apis/servicenetworking_v1beta/classes.rb @@ -114,21 +114,20 @@ module Google class AddSubnetworkRequest include Google::Apis::Core::Hashable - # Required. A resource that represents the service consumer, such as - # `projects/123456`. The project number can be different from the - # value in the consumer network parameter. For example, the network might be - # part of a Shared VPC network. In those cases, Service Networking validates - # that this resource belongs to that Shared VPC. + # Required. A resource that represents the service consumer, such as `projects/ + # 123456`. The project number can be different from the value in the consumer + # network parameter. For example, the network might be part of a Shared VPC + # network. In those cases, Service Networking validates that this resource + # belongs to that Shared VPC. # Corresponds to the JSON property `consumer` # @return [String] attr_accessor :consumer - # Required. The name of the service consumer's VPC network. The network - # must have an existing private connection that was provisioned through the - # connections.create method. The name must be in the following format: - # `projects/`project`/global/networks/`network``, where `project` - # is a project number, such as `12345`. `network` is the name of a - # VPC network in the project. + # Required. The name of the service consumer's VPC network. The network must + # have an existing private connection that was provisioned through the + # connections.create method. The name must be in the following format: `projects/ + # `project`/global/networks/`network``, where `project` is a project number, + # such as `12345`. `network` is the name of a VPC network in the project. # Corresponds to the JSON property `consumerNetwork` # @return [String] attr_accessor :consumer_network @@ -138,38 +137,38 @@ module Google # @return [String] attr_accessor :description - # Required. The prefix length of the subnet's IP address range. Use CIDR - # range notation, such as `30` to provision a subnet with an - # `x.x.x.x/30` CIDR range. The IP address range is drawn from a - # pool of available ranges in the service consumer's allocated range. + # Required. The prefix length of the subnet's IP address range. Use CIDR range + # notation, such as `30` to provision a subnet with an `x.x.x.x/30` CIDR range. + # The IP address range is drawn from a pool of available ranges in the service + # consumer's allocated range. # Corresponds to the JSON property `ipPrefixLength` # @return [Fixnum] attr_accessor :ip_prefix_length - # Required. The name of a [region](/compute/docs/regions-zones) - # for the subnet, such `europe-west1`. + # Required. The name of a [region](/compute/docs/regions-zones) for the subnet, + # such `europe-west1`. # Corresponds to the JSON property `region` # @return [String] attr_accessor :region - # Optional. The starting address of a range. The address must be a valid - # IPv4 address in the x.x.x.x format. This value combined with the IP prefix - # range is the CIDR range for the subnet. The range must be within the - # allocated range that is assigned to the private connection. If the CIDR - # range isn't available, the call fails. + # Optional. The starting address of a range. The address must be a valid IPv4 + # address in the x.x.x.x format. This value combined with the IP prefix range is + # the CIDR range for the subnet. The range must be within the allocated range + # that is assigned to the private connection. If the CIDR range isn't available, + # the call fails. # Corresponds to the JSON property `requestedAddress` # @return [String] attr_accessor :requested_address # Required. A name for the new subnet. For information about the naming - # requirements, see [subnetwork](/compute/docs/reference/rest/v1/subnetworks) - # in the Compute API documentation. + # requirements, see [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in + # the Compute API documentation. # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork - # A list of members that are granted the `compute.networkUser` - # role on the subnet. + # A list of members that are granted the `compute.networkUser` role on the + # subnet. # Corresponds to the JSON property `subnetworkUsers` # @return [Array] attr_accessor :subnetwork_users @@ -191,14 +190,13 @@ module Google end end - # Api is a light-weight descriptor for an API Interface. - # Interfaces are also described as "protocol buffer services" in some contexts, - # such as by the "service" keyword in a .proto file, but they are different - # from API Services, which represent a concrete implementation of an interface - # as opposed to simply a description of methods and bindings. They are also - # sometimes simply referred to as "APIs" in other contexts, such as the name of - # this message itself. See https://cloud.google.com/apis/design/glossary for - # detailed terminology. + # Api is a light-weight descriptor for an API Interface. Interfaces are also + # described as "protocol buffer services" in some contexts, such as by the " + # service" keyword in a .proto file, but they are different from API Services, + # which represent a concrete implementation of an interface as opposed to simply + # a description of methods and bindings. They are also sometimes simply referred + # to as "APIs" in other contexts, such as the name of this message itself. See + # https://cloud.google.com/apis/design/glossary for detailed terminology. class Api include Google::Apis::Core::Hashable @@ -212,8 +210,8 @@ module Google # @return [Array] attr_accessor :mixins - # The fully qualified name of this interface, including package name - # followed by the interface's simple name. + # The fully qualified name of this interface, including package name followed by + # the interface's simple name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -223,8 +221,8 @@ module Google # @return [Array] attr_accessor :options - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. # Corresponds to the JSON property `sourceContext` # @return [Google::Apis::ServicenetworkingV1beta::SourceContext] attr_accessor :source_context @@ -234,23 +232,19 @@ module Google # @return [String] attr_accessor :syntax - # A version string for this interface. If specified, must have the form - # `major-version.minor-version`, as in `1.10`. If the minor version is - # omitted, it defaults to zero. If the entire version field is empty, the - # major version is derived from the package name, as outlined below. If the - # field is not empty, the version in the package name will be verified to be - # consistent with what is provided here. - # The versioning schema uses [semantic - # versioning](http://semver.org) where the major version number - # indicates a breaking change and the minor version an additive, - # non-breaking change. Both version numbers are signals to users - # what to expect from different versions, and should be carefully - # chosen based on the product plan. - # The major version is also reflected in the package name of the - # interface, which must end in `v`, as in - # `google.feature.v1`. For major versions 0 and 1, the suffix can - # be omitted. Zero major versions must only be used for - # experimental, non-GA interfaces. + # A version string for this interface. If specified, must have the form `major- + # version.minor-version`, as in `1.10`. If the minor version is omitted, it + # defaults to zero. If the entire version field is empty, the major version is + # derived from the package name, as outlined below. If the field is not empty, + # the version in the package name will be verified to be consistent with what is + # provided here. The versioning schema uses [semantic versioning](http://semver. + # org) where the major version number indicates a breaking change and the minor + # version an additive, non-breaking change. Both version numbers are signals to + # users what to expect from different versions, and should be carefully chosen + # based on the product plan. The major version is also reflected in the package + # name of the interface, which must end in `v`, as in `google.feature.v1`. For + # major versions 0 and 1, the suffix can be omitted. Zero major versions must + # only be used for experimental, non-GA interfaces. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -271,85 +265,63 @@ module Google end end - # Configuration for an authentication provider, including support for - # [JSON Web Token - # (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + # Configuration for an authentication provider, including support for [JSON Web + # Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). class AuthProvider include Google::Apis::Core::Hashable - # The list of JWT - # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32# - # section-4.1.3). - # that are allowed to access. A JWT containing any of these audiences will - # be accepted. When this setting is absent, JWTs with audiences: - # - "https://[service.name]/[google.protobuf.Api.name]" - # - "https://[service.name]/" - # will be accepted. - # For example, if no audiences are in the setting, LibraryService API will - # accept JWTs with the following audiences: - # - + # The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json- + # web-token-32#section-4.1.3). that are allowed to access. A JWT containing any + # of these audiences will be accepted. When this setting is absent, JWTs with + # audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[ + # service.name]/" will be accepted. For example, if no audiences are in the + # setting, LibraryService API will accept JWTs with the following audiences: - # https://library-example.googleapis.com/google.example.library.v1. - # LibraryService - # - https://library-example.googleapis.com/ - # Example: - # audiences: bookstore_android.apps.googleusercontent.com, - # bookstore_web.apps.googleusercontent.com + # LibraryService - https://library-example.googleapis.com/ Example: audiences: + # bookstore_android.apps.googleusercontent.com, bookstore_web.apps. + # googleusercontent.com # Corresponds to the JSON property `audiences` # @return [String] attr_accessor :audiences - # Redirect URL if JWT token is required but not present or is expired. - # Implement authorizationUrl of securityDefinitions in OpenAPI spec. + # Redirect URL if JWT token is required but not present or is expired. Implement + # authorizationUrl of securityDefinitions in OpenAPI spec. # Corresponds to the JSON property `authorizationUrl` # @return [String] attr_accessor :authorization_url - # The unique identifier of the auth provider. It will be referred to by - # `AuthRequirement.provider_id`. - # Example: "bookstore_auth". + # The unique identifier of the auth provider. It will be referred to by ` + # AuthRequirement.provider_id`. Example: "bookstore_auth". # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Identifies the principal that issued the JWT. See - # https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - # Usually a URL or an email address. - # Example: https://securetoken.google.com - # Example: 1234567-compute@developer.gserviceaccount.com + # Identifies the principal that issued the JWT. See https://tools.ietf.org/html/ + # draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email + # address. Example: https://securetoken.google.com Example: 1234567-compute@ + # developer.gserviceaccount.com # Corresponds to the JSON property `issuer` # @return [String] attr_accessor :issuer - # URL of the provider's public key set to validate signature of the JWT. See - # [OpenID - # Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html# - # ProviderMetadata). - # Optional if the key set document: - # - can be retrieved from - # [OpenID - # Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of - # the issuer. - # - can be inferred from the email domain of the issuer (e.g. a Google - # service account). - # Example: https://www.googleapis.com/oauth2/v1/certs + # URL of the provider's public key set to validate signature of the JWT. See [ + # OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html# + # ProviderMetadata). Optional if the key set document: - can be retrieved from [ + # OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html + # of the issuer. - can be inferred from the email domain of the issuer (e.g. a + # Google service account). Example: https://www.googleapis.com/oauth2/v1/certs # Corresponds to the JSON property `jwksUri` # @return [String] attr_accessor :jwks_uri - # Defines the locations to extract the JWT. - # JWT locations can be either from HTTP headers or URL query parameters. - # The rule is that the first match wins. The checking order is: checking - # all headers first, then URL query parameters. - # If not specified, default to use following 3 locations: - # 1) Authorization: Bearer - # 2) x-goog-iap-jwt-assertion - # 3) access_token query parameter - # Default locations can be specified as followings: - # jwt_locations: - # - header: Authorization - # value_prefix: "Bearer " - # - header: x-goog-iap-jwt-assertion - # - query: access_token + # Defines the locations to extract the JWT. JWT locations can be either from + # HTTP headers or URL query parameters. The rule is that the first match wins. + # The checking order is: checking all headers first, then URL query parameters. + # If not specified, default to use following 3 locations: 1) Authorization: + # Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default + # locations can be specified as followings: jwt_locations: - header: + # Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - + # query: access_token # Corresponds to the JSON property `jwtLocations` # @return [Array] attr_accessor :jwt_locations @@ -369,34 +341,26 @@ module Google end end - # User-defined authentication requirements, including support for - # [JSON Web Token - # (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + # User-defined authentication requirements, including support for [JSON Web + # Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). class AuthRequirement include Google::Apis::Core::Hashable - # NOTE: This will be deprecated soon, once AuthProvider.audiences is - # implemented and accepted in all the runtime components. - # The list of JWT - # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32# - # section-4.1.3). - # that are allowed to access. A JWT containing any of these audiences will - # be accepted. When this setting is absent, only JWTs with audience - # "https://Service_name/API_name" - # will be accepted. For example, if no audiences are in the setting, - # LibraryService API will only accept JWTs with the following audience - # "https://library-example.googleapis.com/google.example.library.v1. - # LibraryService". - # Example: - # audiences: bookstore_android.apps.googleusercontent.com, - # bookstore_web.apps.googleusercontent.com + # NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented + # and accepted in all the runtime components. The list of JWT [audiences](https:/ + # /tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that + # are allowed to access. A JWT containing any of these audiences will be + # accepted. When this setting is absent, only JWTs with audience "https:// + # Service_name/API_name" will be accepted. For example, if no audiences are in + # the setting, LibraryService API will only accept JWTs with the following + # audience "https://library-example.googleapis.com/google.example.library.v1. + # LibraryService". Example: audiences: bookstore_android.apps.googleusercontent. + # com, bookstore_web.apps.googleusercontent.com # Corresponds to the JSON property `audiences` # @return [String] attr_accessor :audiences - # id from authentication provider. - # Example: - # provider_id: bookstore_auth + # id from authentication provider. Example: provider_id: bookstore_auth # Corresponds to the JSON property `providerId` # @return [String] attr_accessor :provider_id @@ -412,18 +376,11 @@ module Google end end - # `Authentication` defines the authentication configuration for an API. - # Example for an API targeted for external use: - # name: calendar.googleapis.com - # authentication: - # providers: - # - id: google_calendar_auth - # jwks_uri: https://www.googleapis.com/oauth2/v1/certs - # issuer: https://securetoken.google.com - # rules: - # - selector: "*" - # requirements: - # provider_id: google_calendar_auth + # `Authentication` defines the authentication configuration for an API. Example + # for an API targeted for external use: name: calendar.googleapis.com + # authentication: providers: - id: google_calendar_auth jwks_uri: https://www. + # googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - + # selector: "*" requirements: provider_id: google_calendar_auth class Authentication include Google::Apis::Core::Hashable @@ -432,8 +389,8 @@ module Google # @return [Array] attr_accessor :providers - # A list of authentication rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of authentication rules that apply to individual API methods. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -449,13 +406,11 @@ module Google end end - # Authentication rules for the service. - # By default, if a method has any authentication requirements, every request - # must include a valid credential matching one of the requirements. - # It's an error to include more than one kind of credential in a single - # request. - # If a method doesn't have any auth requirements, request credentials will be - # ignored. + # Authentication rules for the service. By default, if a method has any + # authentication requirements, every request must include a valid credential + # matching one of the requirements. It's an error to include more than one kind + # of credential in a single request. If a method doesn't have any auth + # requirements, request credentials will be ignored. class AuthenticationRule include Google::Apis::Core::Hashable @@ -466,19 +421,18 @@ module Google alias_method :allow_without_credential?, :allow_without_credential # OAuth scopes are a way to define data and permissions on data. For example, - # there are scopes defined for "Read-only access to Google Calendar" and - # "Access to Cloud Platform". Users can consent to a scope for an application, - # giving it permission to access that data on their behalf. - # OAuth scope specifications should be fairly coarse grained; a user will need - # to see and understand the text description of what your scope means. - # In most cases: use one or at most two OAuth scopes for an entire family of - # products. If your product has multiple APIs, you should probably be sharing - # the OAuth scope across all of those APIs. - # When you need finer grained OAuth consent screens: talk with your product - # management about how developers will use them in practice. - # Please note that even though each of the canonical scopes is enough for a - # request to be accepted and passed to the backend, a request can still fail - # due to the backend requiring additional scopes or permissions. + # there are scopes defined for "Read-only access to Google Calendar" and "Access + # to Cloud Platform". Users can consent to a scope for an application, giving it + # permission to access that data on their behalf. OAuth scope specifications + # should be fairly coarse grained; a user will need to see and understand the + # text description of what your scope means. In most cases: use one or at most + # two OAuth scopes for an entire family of products. If your product has + # multiple APIs, you should probably be sharing the OAuth scope across all of + # those APIs. When you need finer grained OAuth consent screens: talk with your + # product management about how developers will use them in practice. Please note + # that even though each of the canonical scopes is enough for a request to be + # accepted and passed to the backend, a request can still fail due to the + # backend requiring additional scopes or permissions. # Corresponds to the JSON property `oauth` # @return [Google::Apis::ServicenetworkingV1beta::OAuthRequirements] attr_accessor :oauth @@ -488,8 +442,8 @@ module Google # @return [Array] attr_accessor :requirements - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -511,8 +465,8 @@ module Google class Backend include Google::Apis::Core::Hashable - # A list of API backend rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of API backend rules that apply to individual API methods. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -531,21 +485,13 @@ module Google class BackendRule include Google::Apis::Core::Hashable - # The address of the API backend. - # The scheme is used to determine the backend protocol and security. - # The following schemes are accepted: - # SCHEME PROTOCOL SECURITY - # http:// HTTP None - # https:// HTTP TLS - # grpc:// gRPC None - # grpcs:// gRPC TLS - # It is recommended to explicitly include a scheme. Leaving out the scheme - # may cause constrasting behaviors across platforms. - # If the port is unspecified, the default is: - # - 80 for schemes without TLS - # - 443 for schemes with TLS - # For HTTP backends, use protocol - # to specify the protocol version. + # The address of the API backend. The scheme is used to determine the backend + # protocol and security. The following schemes are accepted: SCHEME PROTOCOL + # SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC + # TLS It is recommended to explicitly include a scheme. Leaving out the scheme + # may cause constrasting behaviors across platforms. If the port is unspecified, + # the default is: - 80 for schemes without TLS - 443 for schemes with TLS For + # HTTP backends, use protocol to specify the protocol version. # Corresponds to the JSON property `address` # @return [String] attr_accessor :address @@ -556,18 +502,18 @@ module Google # @return [Float] attr_accessor :deadline - # When disable_auth is true, a JWT ID token won't be generated and the - # original "Authorization" HTTP header will be preserved. If the header is - # used to carry the original token and is expected by the backend, this - # field must be set to true to preserve the header. + # When disable_auth is true, a JWT ID token won't be generated and the original " + # Authorization" HTTP header will be preserved. If the header is used to carry + # the original token and is expected by the backend, this field must be set to + # true to preserve the header. # Corresponds to the JSON property `disableAuth` # @return [Boolean] attr_accessor :disable_auth alias_method :disable_auth?, :disable_auth - # The JWT audience is used when generating a JWT ID token for the backend. - # This ID token will be added in the HTTP "authorization" header, and sent - # to the backend. + # The JWT audience is used when generating a JWT ID token for the backend. This + # ID token will be added in the HTTP "authorization" header, and sent to the + # backend. # Corresponds to the JSON property `jwtAudience` # @return [String] attr_accessor :jwt_audience @@ -578,8 +524,8 @@ module Google # @return [Float] attr_accessor :min_deadline - # The number of seconds to wait for the completion of a long running - # operation. The default is no deadline. + # The number of seconds to wait for the completion of a long running operation. + # The default is no deadline. # Corresponds to the JSON property `operationDeadline` # @return [Float] attr_accessor :operation_deadline @@ -589,29 +535,21 @@ module Google # @return [String] attr_accessor :path_translation - # The protocol used for sending a request to the backend. - # The supported values are "http/1.1" and "h2". - # The default value is inferred from the scheme in the - # address field: - # SCHEME PROTOCOL - # http:// http/1.1 - # https:// http/1.1 - # grpc:// h2 - # grpcs:// h2 - # For secure HTTP backends (https://) that support HTTP/2, set this field - # to "h2" for improved performance. - # Configuring this field to non-default values is only supported for secure - # HTTP backends. This field will be ignored for all other backends. - # See - # https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype- - # values.xhtml#alpn-protocol-ids - # for more details on the supported values. + # The protocol used for sending a request to the backend. The supported values + # are "http/1.1" and "h2". The default value is inferred from the scheme in the + # address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 + # grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this + # field to "h2" for improved performance. Configuring this field to non-default + # values is only supported for secure HTTP backends. This field will be ignored + # for all other backends. See https://www.iana.org/assignments/tls-extensiontype- + # values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on + # the supported values. # Corresponds to the JSON property `protocol` # @return [String] attr_accessor :protocol - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -634,42 +572,28 @@ module Google end end - # Billing related configuration of the service. - # The following example shows how to configure monitored resources and metrics - # for billing, `consumer_destinations` is the only supported destination and - # the monitored resources need at least one label key - # `cloud.googleapis.com/location` to indicate the location of the billing - # usage, using different monitored resources between monitoring and billing is - # recommended so they can be evolved independently: - # monitored_resources: - # - type: library.googleapis.com/billing_branch - # labels: - # - key: cloud.googleapis.com/location - # description: | - # Predefined label to support billing location restriction. - # - key: city - # description: | - # Custom label to define the city where the library branch is located - # in. - # - key: name - # description: Custom label to define the name of the library branch. - # metrics: - # - name: library.googleapis.com/book/borrowed_count - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # billing: - # consumer_destinations: - # - monitored_resource: library.googleapis.com/billing_branch - # metrics: - # - library.googleapis.com/book/borrowed_count + # Billing related configuration of the service. The following example shows how + # to configure monitored resources and metrics for billing, ` + # consumer_destinations` is the only supported destination and the monitored + # resources need at least one label key `cloud.googleapis.com/location` to + # indicate the location of the billing usage, using different monitored + # resources between monitoring and billing is recommended so they can be evolved + # independently: monitored_resources: - type: library.googleapis.com/ + # billing_branch labels: - key: cloud.googleapis.com/location description: | + # Predefined label to support billing location restriction. - key: city + # description: | Custom label to define the city where the library branch is + # located in. - key: name description: Custom label to define the name of the + # library branch. metrics: - name: library.googleapis.com/book/borrowed_count + # metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: + # - monitored_resource: library.googleapis.com/billing_branch metrics: - library. + # googleapis.com/book/borrowed_count class Billing include Google::Apis::Core::Hashable - # Billing configurations for sending metrics to the consumer project. - # There can be multiple consumer destinations per service, each one must have - # a different monitored resource type. A metric can be used in at most - # one consumer destination. + # Billing configurations for sending metrics to the consumer project. There can + # be multiple consumer destinations per service, each one must have a different + # monitored resource type. A metric can be used in at most one consumer + # destination. # Corresponds to the JSON property `consumerDestinations` # @return [Array] attr_accessor :consumer_destinations @@ -684,19 +608,19 @@ module Google end end - # Configuration of a specific billing destination (Currently only support - # bill against consumer project). + # Configuration of a specific billing destination (Currently only support bill + # against consumer project). class BillingDestination include Google::Apis::Core::Hashable - # Names of the metrics to report to this billing destination. - # Each name must be defined in Service.metrics section. + # Names of the metrics to report to this billing destination. Each name must be + # defined in Service.metrics section. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics - # The monitored resource type. The type must be defined in - # Service.monitored_resources section. + # The monitored resource type. The type must be defined in Service. + # monitored_resources section. # Corresponds to the JSON property `monitoredResource` # @return [String] attr_accessor :monitored_resource @@ -719,34 +643,30 @@ module Google include Google::Apis::Core::Hashable # The name of service consumer's VPC network that's connected with service - # producer network, in the following format: - # `projects/`project`/global/networks/`network``. - # ``project`` is a project number, such as in `12345` that includes - # the VPC service consumer's VPC network. ``network`` is the name of the - # service consumer's VPC network. + # producer network, in the following format: `projects/`project`/global/networks/ + # `network``. ``project`` is a project number, such as in `12345` that includes + # the VPC service consumer's VPC network. ``network`` is the name of the service + # consumer's VPC network. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network # Output only. The name of the VPC Network Peering connection that was created - # by the - # service producer. + # by the service producer. # Corresponds to the JSON property `peering` # @return [String] attr_accessor :peering - # The name of one or more allocated IP address ranges for this service - # producer of type `PEERING`. - # Note that invoking this method with a different range when connection is - # already established will not modify already provisioned service + # The name of one or more allocated IP address ranges for this service producer + # of type `PEERING`. Note that invoking this method with a different range when + # connection is already established will not modify already provisioned service # producer subnetworks. # Corresponds to the JSON property `reservedPeeringRanges` # @return [Array] attr_accessor :reserved_peering_ranges # Output only. The name of the peering service that's associated with this - # connection, in - # the following format: `services/`service name``. + # connection, in the following format: `services/`service name``. # Corresponds to the JSON property `service` # @return [String] attr_accessor :service @@ -764,39 +684,24 @@ module Google end end - # `Context` defines which contexts an API requests. - # Example: - # context: - # rules: - # - selector: "*" - # requested: - # - google.rpc.context.ProjectContext - # - google.rpc.context.OriginContext - # The above specifies that all methods in the API request - # `google.rpc.context.ProjectContext` and - # `google.rpc.context.OriginContext`. - # Available context types are defined in package - # `google.rpc.context`. - # This also provides mechanism to whitelist any protobuf message extension that - # can be sent in grpc metadata using “x-goog-ext--bin” and - # “x-goog-ext--jspb” format. For example, list any service - # specific protobuf types that can appear in grpc metadata as follows in your - # yaml file: - # Example: - # context: - # rules: - # - selector: "google.example.library.v1.LibraryService.CreateBook" - # allowed_request_extensions: - # - google.foo.v1.NewExtension - # allowed_response_extensions: - # - google.foo.v1.NewExtension - # You can also specify extension ID instead of fully qualified extension name - # here. + # `Context` defines which contexts an API requests. Example: context: rules: - + # selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc. + # context.OriginContext The above specifies that all methods in the API request ` + # google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. + # Available context types are defined in package `google.rpc.context`. This also + # provides mechanism to whitelist any protobuf message extension that can be + # sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. + # For example, list any service specific protobuf types that can appear in grpc + # metadata as follows in your yaml file: Example: context: rules: - selector: " + # google.example.library.v1.LibraryService.CreateBook" + # allowed_request_extensions: - google.foo.v1.NewExtension + # allowed_response_extensions: - google.foo.v1.NewExtension You can also specify + # extension ID instead of fully qualified extension name here. class Context include Google::Apis::Core::Hashable - # A list of RPC context rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of RPC context rules that apply to individual API methods. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -816,14 +721,14 @@ module Google class ContextRule include Google::Apis::Core::Hashable - # A list of full type names or extension IDs of extensions allowed in grpc - # side channel from client to backend. + # A list of full type names or extension IDs of extensions allowed in grpc side + # channel from client to backend. # Corresponds to the JSON property `allowedRequestExtensions` # @return [Array] attr_accessor :allowed_request_extensions - # A list of full type names or extension IDs of extensions allowed in grpc - # side channel from backend to client. + # A list of full type names or extension IDs of extensions allowed in grpc side + # channel from backend to client. # Corresponds to the JSON property `allowedResponseExtensions` # @return [Array] attr_accessor :allowed_response_extensions @@ -838,8 +743,8 @@ module Google # @return [Array] attr_accessor :requested - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -858,14 +763,14 @@ module Google end end - # Selects and configures the service controller used by the service. The - # service controller handles features like abuse, quota, billing, logging, - # monitoring, etc. + # Selects and configures the service controller used by the service. The service + # controller handles features like abuse, quota, billing, logging, monitoring, + # etc. class Control include Google::Apis::Core::Hashable - # The service control environment to use. If empty, no control plane - # feature (like quota and billing) will be enabled. + # The service control environment to use. If empty, no control plane feature ( + # like quota and billing) will be enabled. # Corresponds to the JSON property `environment` # @return [String] attr_accessor :environment @@ -880,19 +785,15 @@ module Google end end - # Customize service error responses. For example, list any service - # specific protobuf types that can appear in error detail lists of - # error responses. - # Example: - # custom_error: - # types: - # - google.foo.v1.CustomError - # - google.foo.v1.AnotherError + # Customize service error responses. For example, list any service specific + # protobuf types that can appear in error detail lists of error responses. + # Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1. + # AnotherError class CustomError include Google::Apis::Core::Hashable - # The list of custom error rules that apply to individual API messages. - # **NOTE:** All service configuration rules follow "last one wins" order. + # The list of custom error rules that apply to individual API messages. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -917,15 +818,15 @@ module Google class CustomErrorRule include Google::Apis::Core::Hashable - # Mark this message as possible payload in error response. Otherwise, - # objects of this type will be filtered when they appear in error payload. + # Mark this message as possible payload in error response. Otherwise, objects of + # this type will be filtered when they appear in error payload. # Corresponds to the JSON property `isErrorType` # @return [Boolean] attr_accessor :is_error_type alias_method :is_error_type?, :is_error_type - # Selects messages to which this rule applies. - # Refer to selector for syntax details. + # Selects messages to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -1014,9 +915,9 @@ module Google # @return [String] attr_accessor :dns_suffix - # User assigned name for this resource. Must be unique within the project. - # The name must be 1-63 characters long, must begin with a letter, end with - # a letter or digit, and only contain lowercase letters, digits or dashes. + # User assigned name for this resource. Must be unique within the project. The + # name must be 1-63 characters long, must begin with a letter, end with a letter + # or digit, and only contain lowercase letters, digits or dashes. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1032,56 +933,32 @@ module Google end end - # `Documentation` provides the information for describing a service. - # Example: - # 
documentation:
-      # summary: >
-      # The Google Calendar API gives access
-      # to most calendar features.
-      # pages:
-      # - name: Overview
-      # content: (== include google/foo/overview.md ==)
-      # - name: Tutorial
-      # content: (== include google/foo/tutorial.md ==)
-      # subpages;
-      # - name: Java
-      # content: (== include google/foo/tutorial_java.md ==)
-      # rules:
-      # - selector: google.calendar.Calendar.Get
-      # description: >
-      # ...
-      # - selector: google.calendar.Calendar.Put
-      # description: >
-      # ...
-      #
- # Documentation is provided in markdown syntax. In addition to - # standard markdown features, definition lists, tables and fenced - # code blocks are supported. Section headers can be provided and are - # interpreted relative to the section nesting of the context where - # a documentation fragment is embedded. - # Documentation from the IDL is merged with documentation defined - # via the config at normalization time, where documentation provided - # by config rules overrides IDL provided. - # A number of constructs specific to the API platform are supported - # in documentation text. - # In order to reference a proto element, the following - # notation can be used: - # 
[fully.qualified.proto.name][]
- # To override the display text used for the link, this can be used: - # 
[display text][fully.qualified.proto.name]
- # Text can be excluded from doc using the following notation: - # 
(-- internal comment --)
- # A few directives are available in documentation. Note that - # directives must appear on a single line to be properly - # identified. The `include` directive includes a markdown file from - # an external source: - # 
(== include path/to/file ==)
- # The `resource_for` directive marks a message to be the resource of - # a collection in REST view. If it is not specified, tools attempt - # to infer the resource from the operations in a collection: - # 
(== resource_for v1.shelves.books ==)
- # The directive `suppress_warning` does not directly affect documentation - # and is documented together with service config validation. + # `Documentation` provides the information for describing a service. Example: + # documentation: summary: > The Google Calendar API gives access to most + # calendar features. pages: - name: Overview content: (== include google/foo/ + # overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md == + # ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==) + # rules: - selector: google.calendar.Calendar.Get description: > ... - selector: + # google.calendar.Calendar.Put description: > ... Documentation is provided in + # markdown syntax. In addition to standard markdown features, definition lists, + # tables and fenced code blocks are supported. Section headers can be provided + # and are interpreted relative to the section nesting of the context where a + # documentation fragment is embedded. Documentation from the IDL is merged with + # documentation defined via the config at normalization time, where + # documentation provided by config rules overrides IDL provided. A number of + # constructs specific to the API platform are supported in documentation text. + # In order to reference a proto element, the following notation can be used: [ + # fully.qualified.proto.name][] To override the display text used for the link, + # this can be used: [display text][fully.qualified.proto.name] Text can be + # excluded from doc using the following notation: (-- internal comment --) A few + # directives are available in documentation. Note that directives must appear on + # a single line to be properly identified. The `include` directive includes a + # markdown file from an external source: (== include path/to/file ==) The ` + # resource_for` directive marks a message to be the resource of a collection in + # REST view. If it is not specified, tools attempt to infer the resource from + # the operations in a collection: (== resource_for v1.shelves.books ==) The + # directive `suppress_warning` does not directly affect documentation and is + # documented together with service config validation. class Documentation include Google::Apis::Core::Hashable @@ -1090,19 +967,11 @@ module Google # @return [String] attr_accessor :documentation_root_url - # Declares a single overview page. For example: - # 
documentation:
-        # summary: ...
-        # overview: (== include overview.md ==)
-        #
- # This is a shortcut for the following declaration (using pages style): - # 
documentation:
-        # summary: ...
-        # pages:
-        # - name: Overview
-        # content: (== include overview.md ==)
-        #
- # Note: you cannot specify both `overview` field and `pages` field. + # Declares a single overview page. For example: documentation: summary: ... + # overview: (== include overview.md ==) This is a shortcut for the following + # declaration (using pages style): documentation: summary: ... pages: - name: + # Overview content: (== include overview.md ==) Note: you cannot specify both ` + # overview` field and `pages` field. # Corresponds to the JSON property `overview` # @return [String] attr_accessor :overview @@ -1112,22 +981,20 @@ module Google # @return [Array] attr_accessor :pages - # A list of documentation rules that apply to individual API elements. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of documentation rules that apply to individual API elements. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules - # Specifies the service root url if the default one (the service name - # from the yaml file) is not suitable. This can be seen in any fully - # specified service urls as well as sections that show a base that other - # urls are relative to. + # Specifies the service root url if the default one (the service name from the + # yaml file) is not suitable. This can be seen in any fully specified service + # urls as well as sections that show a base that other urls are relative to. # Corresponds to the JSON property `serviceRootUrl` # @return [String] attr_accessor :service_root_url - # A short summary of what the service does. Can only be provided by - # plain text. + # A short summary of what the service does. Can only be provided by plain text. # Corresponds to the JSON property `summary` # @return [String] attr_accessor :summary @@ -1151,8 +1018,8 @@ module Google class DocumentationRule include Google::Apis::Core::Hashable - # Deprecation description of the selected element(s). It can be provided if - # an element is marked as `deprecated`. + # Deprecation description of the selected element(s). It can be provided if an + # element is marked as `deprecated`. # Corresponds to the JSON property `deprecationDescription` # @return [String] attr_accessor :deprecation_description @@ -1184,35 +1051,28 @@ module Google end end - # `Endpoint` describes a network endpoint that serves a set of APIs. - # A service may expose any number of endpoints, and all endpoints share the - # same service configuration, such as quota configuration and monitoring - # configuration. - # Example service configuration: - # name: library-example.googleapis.com - # endpoints: - # # Below entry makes 'google.example.library.v1.Library' - # # API be served from endpoint address library-example.googleapis.com. - # # It also allows HTTP OPTIONS calls to be passed to the backend, for - # # it to decide whether the subsequent cross-origin request is - # # allowed to proceed. - # - name: library-example.googleapis.com - # allow_cors: true + # `Endpoint` describes a network endpoint that serves a set of APIs. A service + # may expose any number of endpoints, and all endpoints share the same service + # configuration, such as quota configuration and monitoring configuration. + # Example service configuration: name: library-example.googleapis.com endpoints: + # # Below entry makes 'google.example.library.v1.Library' # API be served from + # endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS + # calls to be passed to the backend, for # it to decide whether the subsequent + # cross-origin request is # allowed to proceed. - name: library-example. + # googleapis.com allow_cors: true class Endpoint include Google::Apis::Core::Hashable # DEPRECATED: This field is no longer supported. Instead of using aliases, - # please specify multiple google.api.Endpoint for each of the intended - # aliases. + # please specify multiple google.api.Endpoint for each of the intended aliases. # Additional names that this endpoint will be hosted on. # Corresponds to the JSON property `aliases` # @return [Array] attr_accessor :aliases - # Allowing - # [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka - # cross-domain traffic, would allow the backends served from this endpoint to - # receive and respond to HTTP OPTIONS requests. The response will be used by + # Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), + # aka cross-domain traffic, would allow the backends served from this endpoint + # to receive and respond to HTTP OPTIONS requests. The response will be used by # the browser to determine whether the subsequent cross-origin request is # allowed to proceed. # Corresponds to the JSON property `allowCors` @@ -1226,10 +1086,9 @@ module Google attr_accessor :name # The specification of an Internet routable address of API frontend that will - # handle requests to this [API - # Endpoint](https://cloud.google.com/apis/design/glossary). It should be - # either a valid IPv4 address or a fully-qualified domain name. For example, - # "8.8.8.8" or "myservice.appspot.com". + # handle requests to this [API Endpoint](https://cloud.google.com/apis/design/ + # glossary). It should be either a valid IPv4 address or a fully-qualified + # domain name. For example, "8.8.8.8" or "myservice.appspot.com". # Corresponds to the JSON property `target` # @return [String] attr_accessor :target @@ -1266,8 +1125,8 @@ module Google # @return [Array] attr_accessor :options - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. # Corresponds to the JSON property `sourceContext` # @return [Google::Apis::ServicenetworkingV1beta::SourceContext] attr_accessor :source_context @@ -1356,8 +1215,8 @@ module Google # @return [Fixnum] attr_accessor :number - # The index of the field type in `Type.oneofs`, for message or enumeration - # types. The first type has index 1; zero means the type is not in the list. + # The index of the field type in `Type.oneofs`, for message or enumeration types. + # The first type has index 1; zero means the type is not in the list. # Corresponds to the JSON property `oneofIndex` # @return [Fixnum] attr_accessor :oneof_index @@ -1373,8 +1232,8 @@ module Google attr_accessor :packed alias_method :packed?, :packed - # The field type URL, without the scheme, for message or enumeration - # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + # The field type URL, without the scheme, for message or enumeration types. + # Example: `"type.googleapis.com/google.protobuf.Timestamp"`. # Corresponds to the JSON property `typeUrl` # @return [String] attr_accessor :type_url @@ -1408,21 +1267,19 @@ module Google # @return [String] attr_accessor :ip_cidr_range - # Subnetwork name. - # See https://cloud.google.com/compute/docs/vpc/ + # Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # In the Shared VPC host project, the VPC network that's peered with the - # consumer network. For example: - # `projects/1234321/global/networks/host-network` + # consumer network. For example: `projects/1234321/global/networks/host-network` # Corresponds to the JSON property `network` # @return [String] attr_accessor :network - # This is a discovered subnet that is not within the current consumer - # allocated ranges. + # This is a discovered subnet that is not within the current consumer allocated + # ranges. # Corresponds to the JSON property `outsideAllocation` # @return [Boolean] attr_accessor :outside_allocation @@ -1442,23 +1299,22 @@ module Google end # Defines the HTTP configuration for an API service. It contains a list of - # HttpRule, each specifying the mapping of an RPC method - # to one or more HTTP REST API methods. + # HttpRule, each specifying the mapping of an RPC method to one or more HTTP + # REST API methods. class Http include Google::Apis::Core::Hashable # When set to true, URL path parameters will be fully URI-decoded except in # cases of single segment matches in reserved expansion, where "%2F" will be - # left encoded. - # The default behavior is to not decode RFC 6570 reserved characters in multi - # segment matches. + # left encoded. The default behavior is to not decode RFC 6570 reserved + # characters in multi segment matches. # Corresponds to the JSON property `fullyDecodeReservedExpansion` # @return [Boolean] attr_accessor :fully_decode_reserved_expansion alias_method :fully_decode_reserved_expansion?, :fully_decode_reserved_expansion - # A list of HTTP configuration rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of HTTP configuration rules that apply to individual API methods. ** + # NOTE:** All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -1474,251 +1330,156 @@ module Google end end - # # gRPC Transcoding - # gRPC Transcoding is a feature for mapping between a gRPC method and one or - # more HTTP REST endpoints. It allows developers to build a single API service - # that supports both gRPC APIs and REST APIs. Many systems, including [Google - # APIs](https://github.com/googleapis/googleapis), - # [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC - # Gateway](https://github.com/grpc-ecosystem/grpc-gateway), - # and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature - # and use it for large scale production services. - # `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies - # how different portions of the gRPC request message are mapped to the URL - # path, URL query parameters, and HTTP request body. It also controls how the - # gRPC response message is mapped to the HTTP response body. `HttpRule` is + # # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC + # method and one or more HTTP REST endpoints. It allows developers to build a + # single API service that supports both gRPC APIs and REST APIs. Many systems, + # including [Google APIs](https://github.com/googleapis/googleapis), [Cloud + # Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github. + # com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/ + # envoy) proxy support this feature and use it for large scale production + # services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping + # specifies how different portions of the gRPC request message are mapped to the + # URL path, URL query parameters, and HTTP request body. It also controls how + # the gRPC response message is mapped to the HTTP response body. `HttpRule` is # typically specified as an `google.api.http` annotation on the gRPC method. # Each mapping specifies a URL path template and an HTTP method. The path # template may refer to one or more fields in the gRPC request message, as long - # as each field is a non-repeated field with a primitive (non-message) type. - # The path template controls how fields of the request message are mapped to - # the URL path. - # Example: - # service Messaging ` - # rpc GetMessage(GetMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # get: "/v1/`name=messages/*`" - # `; - # ` - # ` - # message GetMessageRequest ` - # string name = 1; // Mapped to URL path. - # ` - # message Message ` - # string text = 1; // The resource content. - # ` - # This enables an HTTP REST to gRPC mapping as below: - # HTTP | gRPC - # -----|----- - # `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` - # Any fields in the request message which are not bound by the path template - # automatically become HTTP query parameters if there is no HTTP request body. - # For example: - # service Messaging ` - # rpc GetMessage(GetMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # get:"/v1/messages/`message_id`" - # `; - # ` - # ` - # message GetMessageRequest ` - # message SubMessage ` - # string subfield = 1; - # ` - # string message_id = 1; // Mapped to URL path. - # int64 revision = 2; // Mapped to URL query parameter `revision`. - # SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. - # ` - # This enables a HTTP JSON to RPC mapping as below: - # HTTP | gRPC - # -----|----- - # `GET /v1/messages/123456?revision=2&sub.subfield=foo` | - # `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: - # "foo"))` - # Note that fields which are mapped to URL query parameters must have a - # primitive type or a repeated primitive type or a non-repeated message type. - # In the case of a repeated type, the parameter can be repeated in the URL - # as `...?param=A¶m=B`. In the case of a message type, each field of the - # message is mapped to a separate parameter, such as - # `...?foo.a=A&foo.b=B&foo.c=C`. - # For HTTP methods that allow a request body, the `body` field - # specifies the mapping. Consider a REST update method on the - # message resource collection: - # service Messaging ` - # rpc UpdateMessage(UpdateMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # patch: "/v1/messages/`message_id`" - # body: "message" - # `; - # ` - # ` - # message UpdateMessageRequest ` - # string message_id = 1; // mapped to the URL - # Message message = 2; // mapped to the body - # ` - # The following HTTP JSON to RPC mapping is enabled, where the - # representation of the JSON in the request body is determined by - # protos JSON encoding: - # HTTP | gRPC - # -----|----- - # `PATCH /v1/messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: - # "123456" message ` text: "Hi!" `)` - # The special name `*` can be used in the body mapping to define that - # every field not bound by the path template should be mapped to the - # request body. This enables the following alternative definition of - # the update method: - # service Messaging ` - # rpc UpdateMessage(Message) returns (Message) ` - # option (google.api.http) = ` - # patch: "/v1/messages/`message_id`" - # body: "*" - # `; - # ` - # ` - # message Message ` - # string message_id = 1; - # string text = 2; - # ` - # The following HTTP JSON to RPC mapping is enabled: - # HTTP | gRPC - # -----|----- - # `PATCH /v1/messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: - # "123456" text: "Hi!")` - # Note that when using `*` in the body mapping, it is not possible to - # have HTTP parameters, as all fields not bound by the path end in - # the body. This makes this option more rarely used in practice when - # defining REST APIs. The common usage of `*` is in custom methods - # which don't use the URL at all for transferring data. - # It is possible to define multiple HTTP methods for one RPC by using - # the `additional_bindings` option. Example: - # service Messaging ` - # rpc GetMessage(GetMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # get: "/v1/messages/`message_id`" - # additional_bindings ` - # get: "/v1/users/`user_id`/messages/`message_id`" - # ` - # `; - # ` - # ` - # message GetMessageRequest ` - # string message_id = 1; - # string user_id = 2; - # ` - # This enables the following two alternative HTTP JSON to RPC mappings: - # HTTP | gRPC - # -----|----- - # `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` - # `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: - # "123456")` - # ## Rules for HTTP mapping - # 1. Leaf request fields (recursive expansion nested messages in the request - # message) are classified into three categories: - # - Fields referred by the path template. They are passed via the URL path. - # - Fields referred by the HttpRule.body. They are passed via the HTTP - # request body. - # - All other fields are passed via the URL query parameters, and the - # parameter name is the field path in the request message. A repeated - # field can be represented as multiple query parameters under the same - # name. - # 2. If HttpRule.body is "*", there is no URL query parameter, all fields - # are passed via URL path and HTTP request body. - # 3. If HttpRule.body is omitted, there is no HTTP request body, all - # fields are passed via URL path and URL query parameters. - # ### Path template syntax - # Template = "/" Segments [ Verb ] ; - # Segments = Segment ` "/" Segment ` ; - # Segment = "*" | "**" | LITERAL | Variable ; - # Variable = "`" FieldPath [ "=" Segments ] "`" ; - # FieldPath = IDENT ` "." IDENT ` ; - # Verb = ":" LITERAL ; - # The syntax `*` matches a single URL path segment. The syntax `**` matches - # zero or more URL path segments, which must be the last part of the URL path - # except the `Verb`. - # The syntax `Variable` matches part of the URL path as specified by its - # template. A variable template must not contain other variables. If a variable - # matches a single path segment, its template may be omitted, e.g. ``var`` - # is equivalent to ``var=*``. - # The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` - # contains any reserved character, such characters should be percent-encoded - # before the matching. - # If a variable contains exactly one path segment, such as `"`var`"` or - # `"`var=*`"`, when such a variable is expanded into a URL path on the client - # side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The - # server side does the reverse decoding. Such variables show up in the - # [Discovery - # Document](https://developers.google.com/discovery/v1/reference/apis) as - # ``var``. - # If a variable contains multiple path segments, such as `"`var=foo/*`"` - # or `"`var=**`"`, when such a variable is expanded into a URL path on the - # client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. - # The server side does the reverse decoding, except "%2F" and "%2f" are left - # unchanged. Such variables show up in the - # [Discovery - # Document](https://developers.google.com/discovery/v1/reference/apis) as - # ``+var``. - # ## Using gRPC API Service Configuration - # gRPC API Service Configuration (service config) is a configuration language - # for configuring a gRPC service to become a user-facing product. The - # service config is simply the YAML representation of the `google.api.Service` - # proto message. + # as each field is a non-repeated field with a primitive (non-message) type. The + # path template controls how fields of the request message are mapped to the URL + # path. Example: service Messaging ` rpc GetMessage(GetMessageRequest) returns ( + # Message) ` option (google.api.http) = ` get: "/v1/`name=messages/*`" `; ` ` + # message GetMessageRequest ` string name = 1; // Mapped to URL path. ` message + # Message ` string text = 1; // The resource content. ` This enables an HTTP + # REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/ + # 123456` | `GetMessage(name: "messages/123456")` Any fields in the request + # message which are not bound by the path template automatically become HTTP + # query parameters if there is no HTTP request body. For example: service + # Messaging ` rpc GetMessage(GetMessageRequest) returns (Message) ` option ( + # google.api.http) = ` get:"/v1/messages/`message_id`" `; ` ` message + # GetMessageRequest ` message SubMessage ` string subfield = 1; ` string + # message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL + # query parameter `revision`. SubMessage sub = 3; // Mapped to URL query + # parameter `sub.subfield`. ` This enables a HTTP JSON to RPC mapping as below: + # HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | + # `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo")) + # ` Note that fields which are mapped to URL query parameters must have a + # primitive type or a repeated primitive type or a non-repeated message type. In + # the case of a repeated type, the parameter can be repeated in the URL as `...? + # param=A¶m=B`. In the case of a message type, each field of the message is + # mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For + # HTTP methods that allow a request body, the `body` field specifies the mapping. + # Consider a REST update method on the message resource collection: service + # Messaging ` rpc UpdateMessage(UpdateMessageRequest) returns (Message) ` option + # (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "message" `; ` ` + # message UpdateMessageRequest ` string message_id = 1; // mapped to the URL + # Message message = 2; // mapped to the body ` The following HTTP JSON to RPC + # mapping is enabled, where the representation of the JSON in the request body + # is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/ + # messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456" + # message ` text: "Hi!" `)` The special name `*` can be used in the body mapping + # to define that every field not bound by the path template should be mapped to + # the request body. This enables the following alternative definition of the + # update method: service Messaging ` rpc UpdateMessage(Message) returns (Message) + # ` option (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "*" `; + # ` ` message Message ` string message_id = 1; string text = 2; ` The following + # HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/ + # messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456" text: + # "Hi!")` Note that when using `*` in the body mapping, it is not possible to + # have HTTP parameters, as all fields not bound by the path end in the body. + # This makes this option more rarely used in practice when defining REST APIs. + # The common usage of `*` is in custom methods which don't use the URL at all + # for transferring data. It is possible to define multiple HTTP methods for one + # RPC by using the `additional_bindings` option. Example: service Messaging ` + # rpc GetMessage(GetMessageRequest) returns (Message) ` option (google.api.http) + # = ` get: "/v1/messages/`message_id`" additional_bindings ` get: "/v1/users/` + # user_id`/messages/`message_id`" ` `; ` ` message GetMessageRequest ` string + # message_id = 1; string user_id = 2; ` This enables the following two + # alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/ + # messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/ + # messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules + # for HTTP mapping 1. Leaf request fields (recursive expansion nested messages + # in the request message) are classified into three categories: - Fields + # referred by the path template. They are passed via the URL path. - Fields + # referred by the HttpRule.body. They are passed via the HTTP request body. - + # All other fields are passed via the URL query parameters, and the parameter + # name is the field path in the request message. A repeated field can be + # represented as multiple query parameters under the same name. 2. If HttpRule. + # body is "*", there is no URL query parameter, all fields are passed via URL + # path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP + # request body, all fields are passed via URL path and URL query parameters. ### + # Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment ` "/ + # " Segment ` ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "`" + # FieldPath [ "=" Segments ] "`" ; FieldPath = IDENT ` "." IDENT ` ; Verb = ":" + # LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` + # matches zero or more URL path segments, which must be the last part of the URL + # path except the `Verb`. The syntax `Variable` matches part of the URL path as + # specified by its template. A variable template must not contain other + # variables. If a variable matches a single path segment, its template may be + # omitted, e.g. ``var`` is equivalent to ``var=*``. The syntax `LITERAL` matches + # literal text in the URL path. If the `LITERAL` contains any reserved character, + # such characters should be percent-encoded before the matching. If a variable + # contains exactly one path segment, such as `"`var`"` or `"`var=*`"`, when such + # a variable is expanded into a URL path on the client side, all characters + # except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse + # decoding. Such variables show up in the [Discovery Document](https:// + # developers.google.com/discovery/v1/reference/apis) as ``var``. If a variable + # contains multiple path segments, such as `"`var=foo/*`"` or `"`var=**`"`, when + # such a variable is expanded into a URL path on the client side, all characters + # except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the + # reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables + # show up in the [Discovery Document](https://developers.google.com/discovery/v1/ + # reference/apis) as ``+var``. ## Using gRPC API Service Configuration gRPC API + # Service Configuration (service config) is a configuration language for + # configuring a gRPC service to become a user-facing product. The service config + # is simply the YAML representation of the `google.api.Service` proto message. # As an alternative to annotating your proto file, you can configure gRPC - # transcoding in your service config YAML files. You do this by specifying a - # `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same - # effect as the proto annotation. This can be particularly useful if you - # have a proto that is reused in multiple services. Note that any transcoding - # specified in the service config will override any matching transcoding - # configuration in the proto. - # Example: - # http: - # rules: - # # Selects a gRPC method and applies HttpRule to it. - # - selector: example.v1.Messaging.GetMessage - # get: /v1/messages/`message_id`/`sub.subfield` - # ## Special notes - # When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the - # proto to JSON conversion must follow the [proto3 - # specification](https://developers.google.com/protocol-buffers/docs/proto3#json) - # . - # While the single segment variable follows the semantics of - # [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String - # Expansion, the multi segment variable **does not** follow RFC 6570 Section - # 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion - # does not expand special characters like `?` and `#`, which would lead - # to invalid URLs. As the result, gRPC Transcoding uses a custom encoding - # for multi segment variables. - # The path variables **must not** refer to any repeated or mapped field, - # because client libraries are not capable of handling such variable expansion. - # The path variables **must not** capture the leading "/" character. The reason - # is that the most common use case "`var`" does not capture the leading "/" - # character. For consistency, all path variables must share the same behavior. - # Repeated message fields must not be mapped to URL query parameters, because - # no client library can support such complicated mapping. - # If an API needs to use a JSON array for request or response body, it can map - # the request or response body to a repeated field. However, some gRPC - # Transcoding implementations may not support this feature. + # transcoding in your service config YAML files. You do this by specifying a ` + # HttpRule` that maps the gRPC method to a REST endpoint, achieving the same + # effect as the proto annotation. This can be particularly useful if you have a + # proto that is reused in multiple services. Note that any transcoding specified + # in the service config will override any matching transcoding configuration in + # the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule + # to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/` + # message_id`/`sub.subfield` ## Special notes When gRPC Transcoding is used to + # map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow + # the [proto3 specification](https://developers.google.com/protocol-buffers/docs/ + # proto3#json). While the single segment variable follows the semantics of [RFC + # 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String + # Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2. + # 3 Reserved Expansion. The reason is that the Reserved Expansion does not + # expand special characters like `?` and `#`, which would lead to invalid URLs. + # As the result, gRPC Transcoding uses a custom encoding for multi segment + # variables. The path variables **must not** refer to any repeated or mapped + # field, because client libraries are not capable of handling such variable + # expansion. The path variables **must not** capture the leading "/" character. + # The reason is that the most common use case "`var`" does not capture the + # leading "/" character. For consistency, all path variables must share the same + # behavior. Repeated message fields must not be mapped to URL query parameters, + # because no client library can support such complicated mapping. If an API + # needs to use a JSON array for request or response body, it can map the request + # or response body to a repeated field. However, some gRPC Transcoding + # implementations may not support this feature. class HttpRule include Google::Apis::Core::Hashable - # Additional HTTP bindings for the selector. Nested bindings must - # not contain an `additional_bindings` field themselves (that is, - # the nesting may only be one level deep). + # Additional HTTP bindings for the selector. Nested bindings must not contain an + # `additional_bindings` field themselves (that is, the nesting may only be one + # level deep). # Corresponds to the JSON property `additionalBindings` # @return [Array] attr_accessor :additional_bindings - # When this flag is set to true, HTTP requests will be allowed to invoke a - # half-duplex streaming method. + # When this flag is set to true, HTTP requests will be allowed to invoke a half- + # duplex streaming method. # Corresponds to the JSON property `allowHalfDuplex` # @return [Boolean] attr_accessor :allow_half_duplex alias_method :allow_half_duplex?, :allow_half_duplex - # The name of the request field whose value is mapped to the HTTP request - # body, or `*` for mapping all request fields not captured by the path - # pattern to the HTTP body, or omitted for not having any HTTP request body. - # NOTE: the referred field must be present at the top-level of the request - # message type. + # The name of the request field whose value is mapped to the HTTP request body, + # or `*` for mapping all request fields not captured by the path pattern to the + # HTTP body, or omitted for not having any HTTP request body. NOTE: the referred + # field must be present at the top-level of the request message type. # Corresponds to the JSON property `body` # @return [String] attr_accessor :body @@ -1733,8 +1494,7 @@ module Google # @return [String] attr_accessor :delete - # Maps to HTTP GET. Used for listing and getting information about - # resources. + # Maps to HTTP GET. Used for listing and getting information about resources. # Corresponds to the JSON property `get` # @return [String] attr_accessor :get @@ -1755,16 +1515,15 @@ module Google attr_accessor :put # Optional. The name of the response field whose value is mapped to the HTTP - # response body. When omitted, the entire response message will be used - # as the HTTP response body. - # NOTE: The referred field must be present at the top-level of the response - # message type. + # response body. When omitted, the entire response message will be used as the + # HTTP response body. NOTE: The referred field must be present at the top-level + # of the response message type. # Corresponds to the JSON property `responseBody` # @return [String] attr_accessor :response_body - # Selects a method to which this rule applies. - # Refer to selector for syntax details. + # Selects a method to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -1803,13 +1562,12 @@ module Google # @return [String] attr_accessor :query - # The value prefix. The value format is "value_prefix`token`" - # Only applies to "in" header type. Must be empty for "in" query type. - # If not empty, the header value has to match (case sensitive) this prefix. - # If not matched, JWT will not be extracted. If matched, JWT will be - # extracted after the prefix is removed. - # For example, for "Authorization: Bearer `JWT`", - # value_prefix="Bearer " with a space at the end. + # The value prefix. The value format is "value_prefix`token`" Only applies to " + # in" header type. Must be empty for "in" query type. If not empty, the header + # value has to match (case sensitive) this prefix. If not matched, JWT will not + # be extracted. If matched, JWT will be extracted after the prefix is removed. + # For example, for "Authorization: Bearer `JWT`", value_prefix="Bearer " with a + # space at the end. # Corresponds to the JSON property `valuePrefix` # @return [String] attr_accessor :value_prefix @@ -1857,8 +1615,8 @@ module Google end end - # ListConnectionsResponse is the response to list peering states for the - # given service and consumer project. + # ListConnectionsResponse is the response to list peering states for the given + # service and consumer project. class ListConnectionsResponse include Google::Apis::Core::Hashable @@ -1877,39 +1635,35 @@ module Google end end - # A description of a log type. Example in YAML format: - # - name: library.googleapis.com/activity_history - # description: The history of borrowing and returning library items. - # display_name: Activity - # labels: - # - key: /customer_id + # A description of a log type. Example in YAML format: - name: library. + # googleapis.com/activity_history description: The history of borrowing and + # returning library items. display_name: Activity labels: - key: /customer_id # description: Identifier of a library customer class LogDescriptor include Google::Apis::Core::Hashable - # A human-readable description of this log. This information appears in - # the documentation and can contain details. + # A human-readable description of this log. This information appears in the + # documentation and can contain details. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # The human-readable name for this log. This information appears on - # the user interface and should be concise. + # The human-readable name for this log. This information appears on the user + # interface and should be concise. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # The set of labels that are available to describe a specific log entry. - # Runtime requests that contain labels not specified here are - # considered invalid. + # The set of labels that are available to describe a specific log entry. Runtime + # requests that contain labels not specified here are considered invalid. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels - # The name of the log. It must be less than 512 characters long and can - # include the following characters: upper- and lower-case alphanumeric - # characters [A-Za-z0-9], and punctuation characters including - # slash, underscore, hyphen, period [/_-.]. + # The name of the log. It must be less than 512 characters long and can include + # the following characters: upper- and lower-case alphanumeric characters [A-Za- + # z0-9], and punctuation characters including slash, underscore, hyphen, period [ + # /_-.]. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1927,48 +1681,30 @@ module Google end end - # Logging configuration of the service. - # The following example shows how to configure logs to be sent to the - # producer and consumer projects. In the example, the `activity_history` - # log is sent to both the producer and consumer projects, whereas the - # `purchase_history` log is only sent to the producer project. - # monitored_resources: - # - type: library.googleapis.com/branch - # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. - # logs: - # - name: activity_history - # labels: - # - key: /customer_id - # - name: purchase_history - # logging: - # producer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history - # - purchase_history - # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history + # Logging configuration of the service. The following example shows how to + # configure logs to be sent to the producer and consumer projects. In the + # example, the `activity_history` log is sent to both the producer and consumer + # projects, whereas the `purchase_history` log is only sent to the producer + # project. monitored_resources: - type: library.googleapis.com/branch labels: - + # key: /city description: The city where the library branch is located in. - key: + # /name description: The name of the branch. logs: - name: activity_history + # labels: - key: /customer_id - name: purchase_history logging: + # producer_destinations: - monitored_resource: library.googleapis.com/branch + # logs: - activity_history - purchase_history consumer_destinations: - + # monitored_resource: library.googleapis.com/branch logs: - activity_history class Logging include Google::Apis::Core::Hashable - # Logging configurations for sending logs to the consumer project. - # There can be multiple consumer destinations, each one must have a - # different monitored resource type. A log can be used in at most - # one consumer destination. + # Logging configurations for sending logs to the consumer project. There can be + # multiple consumer destinations, each one must have a different monitored + # resource type. A log can be used in at most one consumer destination. # Corresponds to the JSON property `consumerDestinations` # @return [Array] attr_accessor :consumer_destinations - # Logging configurations for sending logs to the producer project. - # There can be multiple producer destinations, each one must have a - # different monitored resource type. A log can be used in at most - # one producer destination. + # Logging configurations for sending logs to the producer project. There can be + # multiple producer destinations, each one must have a different monitored + # resource type. A log can be used in at most one producer destination. # Corresponds to the JSON property `producerDestinations` # @return [Array] attr_accessor :producer_destinations @@ -1984,21 +1720,20 @@ module Google end end - # Configuration of a specific logging destination (the producer project - # or the consumer project). + # Configuration of a specific logging destination (the producer project or the + # consumer project). class LoggingDestination include Google::Apis::Core::Hashable - # Names of the logs to be sent to this destination. Each name must - # be defined in the Service.logs section. If the log name is - # not a domain scoped name, it will be automatically prefixed with - # the service name followed by "/". + # Names of the logs to be sent to this destination. Each name must be defined in + # the Service.logs section. If the log name is not a domain scoped name, it will + # be automatically prefixed with the service name followed by "/". # Corresponds to the JSON property `logs` # @return [Array] attr_accessor :logs - # The monitored resource type. The type must be defined in the - # Service.monitored_resources section. + # The monitored resource type. The type must be defined in the Service. + # monitored_resources section. # Corresponds to the JSON property `monitoredResource` # @return [String] attr_accessor :monitored_resource @@ -2073,16 +1808,13 @@ module Google # Defines a metric type and its schema. Once a metric descriptor is created, # deleting or altering it stops data collection and makes the metric type's - # existing data unusable. - # The following are specific rules for service defined Monitoring metric - # descriptors: - # * `type`, `metric_kind`, `value_type` and `description` - # fields are all required. The `unit` field must be specified - # if the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. - # * Maximum of default 500 metric descriptors per service is allowed. - # * Maximum of default 10 labels per metric descriptor is allowed. - # The default maximum limit can be overridden. Please follow - # https://cloud.google.com/monitoring/quotas + # existing data unusable. The following are specific rules for service defined + # Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and ` + # description` fields are all required. The `unit` field must be specified if + # the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default + # 500 metric descriptors per service is allowed. * Maximum of default 10 labels + # per metric descriptor is allowed. The default maximum limit can be overridden. + # Please follow https://cloud.google.com/monitoring/quotas class MetricDescriptor include Google::Apis::Core::Hashable @@ -2091,26 +1823,21 @@ module Google # @return [String] attr_accessor :description - # A concise name for the metric, which can be displayed in user interfaces. - # Use sentence case without an ending period, for example "Request count". - # This field is optional but it is recommended to be set for any metrics - # associated with user-visible concepts, such as Quota. + # A concise name for the metric, which can be displayed in user interfaces. Use + # sentence case without an ending period, for example "Request count". This + # field is optional but it is recommended to be set for any metrics associated + # with user-visible concepts, such as Quota. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # The set of labels that can be used to describe a specific - # instance of this metric type. - # The label key name must follow: - # * Only upper and lower-case letters, digits and underscores (_) are - # allowed. - # * Label name must start with a letter or digit. - # * The maximum length of a label name is 100 characters. - # For example, the - # `appengine.googleapis.com/http/server/response_latencies` metric - # type has a label for the HTTP response code, `response_code`, so - # you can look at latencies for successful responses or just - # for responses that failed. + # The set of labels that can be used to describe a specific instance of this + # metric type. The label key name must follow: * Only upper and lower-case + # letters, digits and underscores (_) are allowed. * Label name must start with + # a letter or digit. * The maximum length of a label name is 100 characters. For + # example, the `appengine.googleapis.com/http/server/response_latencies` metric + # type has a label for the HTTP response code, `response_code`, so you can look + # at latencies for successful responses or just for responses that failed. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels @@ -2125,17 +1852,16 @@ module Google # @return [Google::Apis::ServicenetworkingV1beta::MetricDescriptorMetadata] attr_accessor :metadata - # Whether the metric records instantaneous values, changes to a value, etc. - # Some combinations of `metric_kind` and `value_type` might not be supported. + # Whether the metric records instantaneous values, changes to a value, etc. Some + # combinations of `metric_kind` and `value_type` might not be supported. # Corresponds to the JSON property `metricKind` # @return [String] attr_accessor :metric_kind - # Read-only. If present, then a time - # series, which is identified partially by - # a metric type and a MonitoredResourceDescriptor, that is associated - # with this metric type can only be associated with one of the monitored - # resource types listed here. + # Read-only. If present, then a time series, which is identified partially by a + # metric type and a MonitoredResourceDescriptor, that is associated with this + # metric type can only be associated with one of the monitored resource types + # listed here. # Corresponds to the JSON property `monitoredResourceTypes` # @return [Array] attr_accessor :monitored_resource_types @@ -2145,116 +1871,73 @@ module Google # @return [String] attr_accessor :name - # The metric type, including its DNS name prefix. The type is not - # URL-encoded. + # The metric type, including its DNS name prefix. The type is not URL-encoded. # All service defined metrics must be prefixed with the service name, in the - # format of ``service name`/`relative metric name``, such as - # `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric - # name must follow: + # format of ``service name`/`relative metric name``, such as `cloudsql. + # googleapis.com/database/cpu/utilization`. The relative metric name must follow: # * Only upper and lower-case letters, digits, '/' and underscores '_' are - # allowed. - # * The maximum number of characters allowed for the relative_metric_name is - # 100. - # All user-defined metric types have the DNS name - # `custom.googleapis.com`, `external.googleapis.com`, or - # `logging.googleapis.com/user/`. - # Metric types should use a natural hierarchical grouping. For example: - # "custom.googleapis.com/invoice/paid/amount" - # "external.googleapis.com/prometheus/up" - # "appengine.googleapis.com/http/server/response_latencies" + # allowed. * The maximum number of characters allowed for the + # relative_metric_name is 100. All user-defined metric types have the DNS name ` + # custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/ + # user/`. Metric types should use a natural hierarchical grouping. For example: " + # custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/ + # up" "appengine.googleapis.com/http/server/response_latencies" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # The units in which the metric value is reported. It is only applicable - # if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` - # defines the representation of the stored metric values. - # Different systems may scale the values to be more easily displayed (so a - # value of `0.02KBy` _might_ be displayed as `20By`, and a value of - # `3523KBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is - # `KBy`, then the value of the metric is always in thousands of bytes, no - # matter how it may be displayed.. - # If you want a custom metric to record the exact number of CPU-seconds used - # by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is - # `s`CPU`` (or equivalently `1s`CPU`` or just `s`). If the job uses 12,005 - # CPU-seconds, then the value is written as `12005`. - # Alternatively, if you want a custom metric to record data in a more - # granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is - # `ks`CPU``, and then write the value `12.005` (which is `12005/1000`), - # or use `Kis`CPU`` and write `11.723` (which is `12005/1024`). - # The supported units are a subset of [The Unified Code for Units of - # Measure](http://unitsofmeasure.org/ucum.html) standard: - # **Basic units (UNIT)** - # * `bit` bit - # * `By` byte - # * `s` second - # * `min` minute - # * `h` hour - # * `d` day - # * `1` dimensionless - # **Prefixes (PREFIX)** - # * `k` kilo (10^3) - # * `M` mega (10^6) - # * `G` giga (10^9) - # * `T` tera (10^12) - # * `P` peta (10^15) - # * `E` exa (10^18) - # * `Z` zetta (10^21) - # * `Y` yotta (10^24) - # * `m` milli (10^-3) - # * `u` micro (10^-6) - # * `n` nano (10^-9) - # * `p` pico (10^-12) - # * `f` femto (10^-15) - # * `a` atto (10^-18) - # * `z` zepto (10^-21) - # * `y` yocto (10^-24) - # * `Ki` kibi (2^10) - # * `Mi` mebi (2^20) - # * `Gi` gibi (2^30) - # * `Ti` tebi (2^40) - # * `Pi` pebi (2^50) - # **Grammar** - # The grammar also includes these connectors: - # * `/` division or ratio (as an infix operator). For examples, - # `kBy/`email`` or `MiBy/10ms` (although you should almost never - # have `/s` in a metric `unit`; rates should always be computed at - # query time from the underlying cumulative or delta value). - # * `.` multiplication or composition (as an infix operator). For - # examples, `GBy.d` or `k`watt`.h`. - # The grammar for a unit is as follows: - # Expression = Component ` "." Component ` ` "/" Component ` ; - # Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] - # | Annotation - # | "1" - # ; - # Annotation = "`" NAME "`" ; - # Notes: - # * `Annotation` is just a comment if it follows a `UNIT`. If the annotation - # is used alone, then the unit is equivalent to `1`. For examples, - # ``request`/s == 1/s`, `By`transmitted`/s == By/s`. - # * `NAME` is a sequence of non-blank printable ASCII characters not - # containing ``` or ```. - # * `1` represents a unitary [dimensionless - # unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such - # as in `1/s`. It is typically used when none of the basic units are - # appropriate. For example, "new users per day" can be represented as - # `1/d` or ``new-users`/d` (and a metric value `5` would mean "5 new - # users). Alternatively, "thousands of page views per day" would be - # represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric - # value of `5.3` would mean "5300 page views per day"). - # * `%` represents dimensionless value of 1/100, and annotates values giving - # a percentage (so the metric values are typically in the range of 0..100, - # and a metric value `3` means "3 percent"). - # * `10^2.%` indicates a metric contains a ratio, typically in the range - # 0..1, that will be multiplied by 100 and displayed as a percentage - # (so a metric value `0.03` means "3 percent"). + # The units in which the metric value is reported. It is only applicable if the ` + # value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the + # representation of the stored metric values. Different systems may scale the + # values to be more easily displayed (so a value of `0.02KBy` _might_ be + # displayed as `20By`, and a value of `3523KBy` _might_ be displayed as `3.5MBy`) + # . However, if the `unit` is `KBy`, then the value of the metric is always in + # thousands of bytes, no matter how it may be displayed.. If you want a custom + # metric to record the exact number of CPU-seconds used by a job, you can create + # an `INT64 CUMULATIVE` metric whose `unit` is `s`CPU`` (or equivalently `1s`CPU` + # ` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written + # as `12005`. Alternatively, if you want a custom metric to record data in a + # more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is + # `ks`CPU``, and then write the value `12.005` (which is `12005/1000`), or use ` + # Kis`CPU`` and write `11.723` (which is `12005/1024`). The supported units are + # a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ + # ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` + # second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes ( + # PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^ + # 12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^ + # 24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^- + # 12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto ( + # 10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi ( + # 2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these + # connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/ + # `email`` or `MiBy/10ms` (although you should almost never have `/s` in a + # metric `unit`; rates should always be computed at query time from the + # underlying cumulative or delta value). * `.` multiplication or composition (as + # an infix operator). For examples, `GBy.d` or `k`watt`.h`. The grammar for a + # unit is as follows: Expression = Component ` "." Component ` ` "/" Component ` + # ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; + # Annotation = "`" NAME "`" ; Notes: * `Annotation` is just a comment if it + # follows a `UNIT`. If the annotation is used alone, then the unit is equivalent + # to `1`. For examples, ``request`/s == 1/s`, `By`transmitted`/s == By/s`. * ` + # NAME` is a sequence of non-blank printable ASCII characters not containing ``` + # or ```. * `1` represents a unitary [dimensionless unit](https://en.wikipedia. + # org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used + # when none of the basic units are appropriate. For example, "new users per day" + # can be represented as `1/d` or ``new-users`/d` (and a metric value `5` would + # mean "5 new users). Alternatively, "thousands of page views per day" would be + # represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric value of ` + # 5.3` would mean "5300 page views per day"). * `%` represents dimensionless + # value of 1/100, and annotates values giving a percentage (so the metric values + # are typically in the range of 0..100, and a metric value `3` means "3 percent") + # . * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, + # that will be multiplied by 100 and displayed as a percentage (so a metric + # value `0.03` means "3 percent"). # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit - # Whether the measurement is an integer, a floating-point number, etc. - # Some combinations of `metric_kind` and `value_type` might not be supported. + # Whether the measurement is an integer, a floating-point number, etc. Some + # combinations of `metric_kind` and `value_type` might not be supported. # Corresponds to the JSON property `valueType` # @return [String] attr_accessor :value_type @@ -2283,9 +1966,9 @@ module Google class MetricDescriptorMetadata include Google::Apis::Core::Hashable - # The delay of data points caused by ingestion. Data points older than this - # age are guaranteed to be ingested and available to be read, excluding - # data loss due to errors. + # The delay of data points caused by ingestion. Data points older than this age + # are guaranteed to be ingested and available to be read, excluding data loss + # due to errors. # Corresponds to the JSON property `ingestDelay` # @return [String] attr_accessor :ingest_delay @@ -2297,8 +1980,8 @@ module Google # The sampling period of metric data points. For metrics which are written # periodically, consecutive data points are stored at this time interval, - # excluding data loss due to errors. Metrics with a higher granularity have - # a smaller sampling period. + # excluding data loss due to errors. Metrics with a higher granularity have a + # smaller sampling period. # Corresponds to the JSON property `samplePeriod` # @return [String] attr_accessor :sample_period @@ -2315,22 +1998,21 @@ module Google end end - # Bind API methods to metrics. Binding a method to a metric causes that - # metric's configured quota behaviors to apply to the method call. + # Bind API methods to metrics. Binding a method to a metric causes that metric's + # configured quota behaviors to apply to the method call. class MetricRule include Google::Apis::Core::Hashable # Metrics to update when the selected methods are called, and the associated - # cost applied to each metric. - # The key of the map is the metric name, and the values are the amount - # increased for the metric against which the quota limits are defined. - # The value must not be negative. + # cost applied to each metric. The key of the map is the metric name, and the + # values are the amount increased for the metric against which the quota limits + # are defined. The value must not be negative. # Corresponds to the JSON property `metricCosts` # @return [Hash] attr_accessor :metric_costs - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -2348,66 +2030,33 @@ module Google # Declares an API Interface to be included in this interface. The including # interface must redeclare all the methods from the included interface, but - # documentation and options are inherited as follows: - # - If after comment and whitespace stripping, the documentation - # string of the redeclared method is empty, it will be inherited - # from the original method. - # - Each annotation belonging to the service config (http, - # visibility) which is not set in the redeclared method will be - # inherited. - # - If an http annotation is inherited, the path pattern will be - # modified as follows. Any version prefix will be replaced by the - # version of the including interface plus the root path if - # specified. - # Example of a simple mixin: - # package google.acl.v1; - # service AccessControl ` - # // Get the underlying ACL object. - # rpc GetAcl(GetAclRequest) returns (Acl) ` - # option (google.api.http).get = "/v1/`resource=**`:getAcl"; - # ` - # ` - # package google.storage.v2; - # service Storage ` - # // rpc GetAcl(GetAclRequest) returns (Acl); - # // Get a data record. - # rpc GetData(GetDataRequest) returns (Data) ` - # option (google.api.http).get = "/v2/`resource=**`"; - # ` - # ` - # Example of a mixin configuration: - # apis: - # - name: google.storage.v2.Storage - # mixins: - # - name: google.acl.v1.AccessControl - # The mixin construct implies that all methods in `AccessControl` are - # also declared with same name and request/response types in - # `Storage`. A documentation generator or annotation processor will - # see the effective `Storage.GetAcl` method after inherting - # documentation and annotations as follows: - # service Storage ` - # // Get the underlying ACL object. - # rpc GetAcl(GetAclRequest) returns (Acl) ` - # option (google.api.http).get = "/v2/`resource=**`:getAcl"; - # ` - # ... - # ` - # Note how the version in the path pattern changed from `v1` to `v2`. - # If the `root` field in the mixin is specified, it should be a - # relative path under which inherited HTTP paths are placed. Example: - # apis: - # - name: google.storage.v2.Storage - # mixins: - # - name: google.acl.v1.AccessControl - # root: acls - # This implies the following inherited HTTP annotation: - # service Storage ` - # // Get the underlying ACL object. - # rpc GetAcl(GetAclRequest) returns (Acl) ` - # option (google.api.http).get = "/v2/acls/`resource=**`:getAcl"; - # ` - # ... - # ` + # documentation and options are inherited as follows: - If after comment and + # whitespace stripping, the documentation string of the redeclared method is + # empty, it will be inherited from the original method. - Each annotation + # belonging to the service config (http, visibility) which is not set in the + # redeclared method will be inherited. - If an http annotation is inherited, the + # path pattern will be modified as follows. Any version prefix will be replaced + # by the version of the including interface plus the root path if specified. + # Example of a simple mixin: package google.acl.v1; service AccessControl ` // + # Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) ` + # option (google.api.http).get = "/v1/`resource=**`:getAcl"; ` ` package google. + # storage.v2; service Storage ` // rpc GetAcl(GetAclRequest) returns (Acl); // + # Get a data record. rpc GetData(GetDataRequest) returns (Data) ` option (google. + # api.http).get = "/v2/`resource=**`"; ` ` Example of a mixin configuration: + # apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1. + # AccessControl The mixin construct implies that all methods in `AccessControl` + # are also declared with same name and request/response types in `Storage`. A + # documentation generator or annotation processor will see the effective ` + # Storage.GetAcl` method after inherting documentation and annotations as + # follows: service Storage ` // Get the underlying ACL object. rpc GetAcl( + # GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=** + # `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1` + # to `v2`. If the `root` field in the mixin is specified, it should be a + # relative path under which inherited HTTP paths are placed. Example: apis: - + # name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl + # root: acls This implies the following inherited HTTP annotation: service + # Storage ` // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns ( + # Acl) ` option (google.api.http).get = "/v2/acls/`resource=**`:getAcl"; ` ... ` class Mixin include Google::Apis::Core::Hashable @@ -2416,8 +2065,7 @@ module Google # @return [String] attr_accessor :name - # If non-empty specifies a path under which inherited HTTP paths - # are rooted. + # If non-empty specifies a path under which inherited HTTP paths are rooted. # Corresponds to the JSON property `root` # @return [String] attr_accessor :root @@ -2433,51 +2081,42 @@ module Google end end - # An object that describes the schema of a MonitoredResource object using a - # type name and a set of labels. For example, the monitored resource - # descriptor for Google Compute Engine VM instances has a type of - # `"gce_instance"` and specifies the use of the labels `"instance_id"` and - # `"zone"` to identify particular VM instances. - # Different services can support different monitored resource types. - # The following are specific rules to service defined monitored resources for - # Monitoring and Logging: - # * The `type`, `display_name`, `description`, `labels` and `launch_stage` - # fields are all required. - # * The first label of the monitored resource descriptor must be - # `resource_container`. There are legacy monitored resource descritptors - # start with `project_id`. - # * It must include a `location` label. - # * Maximum of default 5 service defined monitored resource descriptors - # is allowed per service. - # * Maximum of default 10 labels per monitored resource is allowed. - # The default maximum limit can be overridden. Please follow - # https://cloud.google.com/monitoring/quotas + # An object that describes the schema of a MonitoredResource object using a type + # name and a set of labels. For example, the monitored resource descriptor for + # Google Compute Engine VM instances has a type of `"gce_instance"` and + # specifies the use of the labels `"instance_id"` and `"zone"` to identify + # particular VM instances. Different services can support different monitored + # resource types. The following are specific rules to service defined monitored + # resources for Monitoring and Logging: * The `type`, `display_name`, ` + # description`, `labels` and `launch_stage` fields are all required. * The first + # label of the monitored resource descriptor must be `resource_container`. There + # are legacy monitored resource descritptors start with `project_id`. * It must + # include a `location` label. * Maximum of default 5 service defined monitored + # resource descriptors is allowed per service. * Maximum of default 10 labels + # per monitored resource is allowed. The default maximum limit can be overridden. + # Please follow https://cloud.google.com/monitoring/quotas class MonitoredResourceDescriptor include Google::Apis::Core::Hashable - # Optional. A detailed description of the monitored resource type that might - # be used in documentation. + # Optional. A detailed description of the monitored resource type that might be + # used in documentation. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Optional. A concise name for the monitored resource type that might be - # displayed in user interfaces. It should be a Title Cased Noun Phrase, - # without any article or other determiners. For example, - # `"Google Cloud SQL Database"`. + # displayed in user interfaces. It should be a Title Cased Noun Phrase, without + # any article or other determiners. For example, `"Google Cloud SQL Database"`. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Required. A set of labels used to describe instances of this monitored - # resource type. - # The label key name must follow: - # * Only upper and lower-case letters, digits and underscores (_) are - # allowed. - # * Label name must start with a letter or digit. - # * The maximum length of a label name is 100 characters. - # For example, an individual Google Cloud SQL database is - # identified by values for the labels `database_id` and `location`. + # resource type. The label key name must follow: * Only upper and lower-case + # letters, digits and underscores (_) are allowed. * Label name must start with + # a letter or digit. * The maximum length of a label name is 100 characters. For + # example, an individual Google Cloud SQL database is identified by values for + # the labels `database_id` and `location`. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels @@ -2487,27 +2126,25 @@ module Google # @return [String] attr_accessor :launch_stage - # Optional. The resource name of the monitored resource descriptor: - # `"projects/`project_id`/monitoredResourceDescriptors/`type`"` where - # `type` is the value of the `type` field in this object and - # `project_id` is a project ID that provides API-specific context for - # accessing the type. APIs that do not use project information can use the - # resource name format `"monitoredResourceDescriptors/`type`"`. + # Optional. The resource name of the monitored resource descriptor: `"projects/` + # project_id`/monitoredResourceDescriptors/`type`"` where `type` is the value of + # the `type` field in this object and `project_id` is a project ID that provides + # API-specific context for accessing the type. APIs that do not use project + # information can use the resource name format `"monitoredResourceDescriptors/` + # type`"`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The monitored resource type. For example, the type - # `cloudsql_database` represents databases in Google Cloud SQL. - # All service defined monitored resource types must be prefixed with the - # service name, in the format of ``service name`/`relative resource name``. - # The relative resource name must follow: - # * Only upper and lower-case letters and digits are allowed. - # * It must start with upper case character and is recommended to use Upper - # Camel Case style. - # * The maximum number of characters allowed for the relative_resource_name - # is 100. - # Note there are legacy service monitored resources not following this rule. + # Required. The monitored resource type. For example, the type ` + # cloudsql_database` represents databases in Google Cloud SQL. All service + # defined monitored resource types must be prefixed with the service name, in + # the format of ``service name`/`relative resource name``. The relative resource + # name must follow: * Only upper and lower-case letters and digits are allowed. * + # It must start with upper case character and is recommended to use Upper Camel + # Case style. * The maximum number of characters allowed for the + # relative_resource_name is 100. Note there are legacy service monitored + # resources not following this rule. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -2527,75 +2164,47 @@ module Google end end - # Monitoring configuration of the service. - # The example below shows how to configure monitored resources and metrics - # for monitoring. In the example, a monitored resource and two metrics are - # defined. The `library.googleapis.com/book/returned_count` metric is sent - # to both producer and consumer projects, whereas the - # `library.googleapis.com/book/num_overdue` metric is only sent to the - # consumer project. - # monitored_resources: - # - type: library.googleapis.com/Branch - # display_name: "Library Branch" - # description: "A branch of a library." - # launch_stage: GA - # labels: - # - key: resource_container - # description: "The Cloud container (ie. project id) for the Branch." - # - key: location - # description: "The location of the library branch." - # - key: branch_id - # description: "The id of the branch." - # metrics: - # - name: library.googleapis.com/book/returned_count - # display_name: "Books Returned" - # description: "The count of books that have been returned." - # launch_stage: GA - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # - name: library.googleapis.com/book/num_overdue - # display_name: "Books Overdue" - # description: "The current number of overdue books." - # launch_stage: GA - # metric_kind: GAUGE - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # monitoring: - # producer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # consumer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # - library.googleapis.com/book/num_overdue + # Monitoring configuration of the service. The example below shows how to + # configure monitored resources and metrics for monitoring. In the example, a + # monitored resource and two metrics are defined. The `library.googleapis.com/ + # book/returned_count` metric is sent to both producer and consumer projects, + # whereas the `library.googleapis.com/book/num_overdue` metric is only sent to + # the consumer project. monitored_resources: - type: library.googleapis.com/ + # Branch display_name: "Library Branch" description: "A branch of a library." + # launch_stage: GA labels: - key: resource_container description: "The Cloud + # container (ie. project id) for the Branch." - key: location description: "The + # location of the library branch." - key: branch_id description: "The id of the + # branch." metrics: - name: library.googleapis.com/book/returned_count + # display_name: "Books Returned" description: "The count of books that have been + # returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" + # labels: - key: customer_id description: "The id of the customer." - name: + # library.googleapis.com/book/num_overdue display_name: "Books Overdue" + # description: "The current number of overdue books." launch_stage: GA + # metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id + # description: "The id of the customer." monitoring: producer_destinations: - + # monitored_resource: library.googleapis.com/Branch metrics: - library. + # googleapis.com/book/returned_count consumer_destinations: - monitored_resource: + # library.googleapis.com/Branch metrics: - library.googleapis.com/book/ + # returned_count - library.googleapis.com/book/num_overdue class Monitoring include Google::Apis::Core::Hashable - # Monitoring configurations for sending metrics to the consumer project. - # There can be multiple consumer destinations. A monitored resource type may - # appear in multiple monitoring destinations if different aggregations are - # needed for different sets of metrics associated with that monitored - # resource type. A monitored resource and metric pair may only be used once - # in the Monitoring configuration. + # Monitoring configurations for sending metrics to the consumer project. There + # can be multiple consumer destinations. A monitored resource type may appear in + # multiple monitoring destinations if different aggregations are needed for + # different sets of metrics associated with that monitored resource type. A + # monitored resource and metric pair may only be used once in the Monitoring + # configuration. # Corresponds to the JSON property `consumerDestinations` # @return [Array] attr_accessor :consumer_destinations - # Monitoring configurations for sending metrics to the producer project. - # There can be multiple producer destinations. A monitored resource type may - # appear in multiple monitoring destinations if different aggregations are - # needed for different sets of metrics associated with that monitored - # resource type. A monitored resource and metric pair may only be used once - # in the Monitoring configuration. + # Monitoring configurations for sending metrics to the producer project. There + # can be multiple producer destinations. A monitored resource type may appear in + # multiple monitoring destinations if different aggregations are needed for + # different sets of metrics associated with that monitored resource type. A + # monitored resource and metric pair may only be used once in the Monitoring + # configuration. # Corresponds to the JSON property `producerDestinations` # @return [Array] attr_accessor :producer_destinations @@ -2611,19 +2220,19 @@ module Google end end - # Configuration of a specific monitoring destination (the producer project - # or the consumer project). + # Configuration of a specific monitoring destination (the producer project or + # the consumer project). class MonitoringDestination include Google::Apis::Core::Hashable - # Types of the metrics to report to this monitoring destination. - # Each type must be defined in Service.metrics section. + # Types of the metrics to report to this monitoring destination. Each type must + # be defined in Service.metrics section. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics - # The monitored resource type. The type must be defined in - # Service.monitored_resources section. + # The monitored resource type. The type must be defined in Service. + # monitored_resources section. # Corresponds to the JSON property `monitoredResource` # @return [String] attr_accessor :monitored_resource @@ -2640,27 +2249,25 @@ module Google end # OAuth scopes are a way to define data and permissions on data. For example, - # there are scopes defined for "Read-only access to Google Calendar" and - # "Access to Cloud Platform". Users can consent to a scope for an application, - # giving it permission to access that data on their behalf. - # OAuth scope specifications should be fairly coarse grained; a user will need - # to see and understand the text description of what your scope means. - # In most cases: use one or at most two OAuth scopes for an entire family of - # products. If your product has multiple APIs, you should probably be sharing - # the OAuth scope across all of those APIs. - # When you need finer grained OAuth consent screens: talk with your product - # management about how developers will use them in practice. - # Please note that even though each of the canonical scopes is enough for a - # request to be accepted and passed to the backend, a request can still fail - # due to the backend requiring additional scopes or permissions. + # there are scopes defined for "Read-only access to Google Calendar" and "Access + # to Cloud Platform". Users can consent to a scope for an application, giving it + # permission to access that data on their behalf. OAuth scope specifications + # should be fairly coarse grained; a user will need to see and understand the + # text description of what your scope means. In most cases: use one or at most + # two OAuth scopes for an entire family of products. If your product has + # multiple APIs, you should probably be sharing the OAuth scope across all of + # those APIs. When you need finer grained OAuth consent screens: talk with your + # product management about how developers will use them in practice. Please note + # that even though each of the canonical scopes is enough for a request to be + # accepted and passed to the backend, a request can still fail due to the + # backend requiring additional scopes or permissions. class OAuthRequirements include Google::Apis::Core::Hashable - # The list of publicly documented OAuth scopes that are allowed access. An - # OAuth token containing any of these scopes will be accepted. - # Example: - # canonical_scopes: https://www.googleapis.com/auth/calendar, - # https://www.googleapis.com/auth/calendar.read + # The list of publicly documented OAuth scopes that are allowed access. An OAuth + # token containing any of these scopes will be accepted. Example: + # canonical_scopes: https://www.googleapis.com/auth/calendar, https://www. + # googleapis.com/auth/calendar.read # Corresponds to the JSON property `canonicalScopes` # @return [String] attr_accessor :canonical_scopes @@ -2680,47 +2287,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::ServicenetworkingV1beta::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 @@ -2745,17 +2350,17 @@ module Google include Google::Apis::Core::Hashable # The option's name. For protobuf built-in options (options defined in - # descriptor.proto), this is the short name. For example, `"map_entry"`. - # For custom options, it should be the fully-qualified name. For example, - # `"google.api.http"`. + # descriptor.proto), this is the short name. For example, `"map_entry"`. For + # custom options, it should be the fully-qualified name. For example, `"google. + # api.http"`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The option's value packed in an Any message. If the value is a primitive, - # the corresponding wrapper type defined in google/protobuf/wrappers.proto - # should be used. If the value is an enum, it should be stored as an int32 - # value using the google.protobuf.Int32Value type. + # The option's value packed in an Any message. If the value is a primitive, the + # corresponding wrapper type defined in google/protobuf/wrappers.proto should be + # used. If the value is an enum, it should be stored as an int32 value using the + # google.protobuf.Int32Value type. # Corresponds to the JSON property `value` # @return [Hash] attr_accessor :value @@ -2776,32 +2381,25 @@ module Google class Page include Google::Apis::Core::Hashable - # The Markdown content of the page. You can use (== include `path` - # ==) to include content from a Markdown file. + # The Markdown content of the page. You can use (== include `path` ==) to + # include content from a Markdown file. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content - # The name of the page. It will be used as an identity of the page to - # generate URI of the page, text of the link to this page in navigation, - # etc. The full page name (start from the root page name to this page - # concatenated with `.`) can be used as reference to the page in your - # documentation. For example: - # 
pages:
-        # - name: Tutorial
-        # content: (== include tutorial.md ==)
-        # subpages:
-        # - name: Java
-        # content: (== include tutorial_java.md ==)
-        #
- # You can reference `Java` page using Markdown reference link syntax: - # `Java`. + # The name of the page. It will be used as an identity of the page to generate + # URI of the page, text of the link to this page in navigation, etc. The full + # page name (start from the root page name to this page concatenated with `.`) + # can be used as reference to the page in your documentation. For example: pages: + # - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java + # content: (== include tutorial_java.md ==) You can reference `Java` page using + # Markdown reference link syntax: `Java`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Subpages of this page. The order of subpages specified here will be - # honored in the generated docset. + # Subpages of this page. The order of subpages specified here will be honored in + # the generated docset. # Corresponds to the JSON property `subpages` # @return [Array] attr_accessor :subpages @@ -2822,20 +2420,17 @@ module Google class PolicyBinding include Google::Apis::Core::Hashable - # Required. Member to bind the role with. See - # /iam/docs/reference/rest/v1/Policy#Binding for how to format each member. - # Eg. - # - user:myuser@mydomain.com - # - serviceAccount:my-service-account@app.gserviceaccount.com + # Required. Member to bind the role with. See /iam/docs/reference/rest/v1/Policy# + # Binding for how to format each member. Eg. - user:myuser@mydomain.com - + # serviceAccount:my-service-account@app.gserviceaccount.com # Corresponds to the JSON property `member` # @return [String] attr_accessor :member # Required. Role to apply. Only whitelisted roles can be used at the specified - # granularity. The role must be one of the following: - # - 'roles/container.hostServiceAgentUser' applied on the shared VPC host - # project - # - 'roles/compute.securityAdmin' applied on the shared VPC host project + # granularity. The role must be one of the following: - 'roles/container. + # hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute. + # securityAdmin' applied on the shared VPC host project # Corresponds to the JSON property `role` # @return [String] attr_accessor :role @@ -2851,46 +2446,25 @@ module Google end end - # Quota configuration helps to achieve fairness and budgeting in service - # usage. - # The metric based quota configuration works this way: - # - The service configuration defines a set of metrics. - # - For API calls, the quota.metric_rules maps methods to metrics with - # corresponding costs. - # - The quota.limits defines limits on the metrics, which will be used for - # quota checks at runtime. - # An example quota configuration in yaml format: - # quota: - # limits: - # - name: apiWriteQpsPerProject - # metric: library.googleapis.com/write_calls - # unit: "1/min/`project`" # rate limit for consumer projects - # values: - # STANDARD: 10000 - # # The metric rules bind all methods to the read_calls metric, - # # except for the UpdateBook and DeleteBook methods. These two methods - # # are mapped to the write_calls metric, with the UpdateBook method - # # consuming at twice rate as the DeleteBook method. - # metric_rules: - # - selector: "*" - # metric_costs: - # library.googleapis.com/read_calls: 1 - # - selector: google.example.library.v1.LibraryService.UpdateBook - # metric_costs: - # library.googleapis.com/write_calls: 2 - # - selector: google.example.library.v1.LibraryService.DeleteBook - # metric_costs: - # library.googleapis.com/write_calls: 1 - # Corresponding Metric definition: - # metrics: - # - name: library.googleapis.com/read_calls - # display_name: Read requests - # metric_kind: DELTA - # value_type: INT64 - # - name: library.googleapis.com/write_calls - # display_name: Write requests - # metric_kind: DELTA - # value_type: INT64 + # Quota configuration helps to achieve fairness and budgeting in service usage. + # The metric based quota configuration works this way: - The service + # configuration defines a set of metrics. - For API calls, the quota. + # metric_rules maps methods to metrics with corresponding costs. - The quota. + # limits defines limits on the metrics, which will be used for quota checks at + # runtime. An example quota configuration in yaml format: quota: limits: - name: + # apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/` + # project`" # rate limit for consumer projects values: STANDARD: 10000 # The + # metric rules bind all methods to the read_calls metric, # except for the + # UpdateBook and DeleteBook methods. These two methods # are mapped to the + # write_calls metric, with the UpdateBook method # consuming at twice rate as + # the DeleteBook method. metric_rules: - selector: "*" metric_costs: library. + # googleapis.com/read_calls: 1 - selector: google.example.library.v1. + # LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - + # selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: + # library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: + # - name: library.googleapis.com/read_calls display_name: Read requests + # metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/ + # write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 class Quota include Google::Apis::Core::Hashable @@ -2899,8 +2473,8 @@ module Google # @return [Array] attr_accessor :limits - # List of `MetricRule` definitions, each one mapping a selected method to one - # or more metrics. + # List of `MetricRule` definitions, each one mapping a selected method to one or + # more metrics. # Corresponds to the JSON property `metricRules` # @return [Array] attr_accessor :metric_rules @@ -2917,95 +2491,89 @@ module Google end # `QuotaLimit` defines a specific limit that applies over a specified duration - # for a limit type. There can be at most one limit for a duration and limit - # type combination defined within a `QuotaGroup`. + # for a limit type. There can be at most one limit for a duration and limit type + # combination defined within a `QuotaGroup`. class QuotaLimit include Google::Apis::Core::Hashable - # Default number of tokens that can be consumed during the specified - # duration. This is the number of tokens assigned when a client - # application developer activates the service for his/her project. - # Specifying a value of 0 will block all requests. This can be used if you - # are provisioning quota to selected consumers and blocking others. - # Similarly, a value of -1 will indicate an unlimited quota. No other - # negative values are allowed. - # Used by group-based quotas only. + # Default number of tokens that can be consumed during the specified duration. + # This is the number of tokens assigned when a client application developer + # activates the service for his/her project. Specifying a value of 0 will block + # all requests. This can be used if you are provisioning quota to selected + # consumers and blocking others. Similarly, a value of -1 will indicate an + # unlimited quota. No other negative values are allowed. Used by group-based + # quotas only. # Corresponds to the JSON property `defaultLimit` # @return [Fixnum] attr_accessor :default_limit - # Optional. User-visible, extended description for this quota limit. - # Should be used only when more context is needed to understand this limit - # than provided by the limit's display name (see: `display_name`). + # Optional. User-visible, extended description for this quota limit. Should be + # used only when more context is needed to understand this limit than provided + # by the limit's display name (see: `display_name`). # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # User-visible display name for this limit. - # Optional. If not set, the UI will provide a default display name based on - # the quota configuration. This field can be used to override the default - # display name generated from the configuration. + # User-visible display name for this limit. Optional. If not set, the UI will + # provide a default display name based on the quota configuration. This field + # can be used to override the default display name generated from the + # configuration. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Duration of this limit in textual notation. Must be "100s" or "1d". - # Used by group-based quotas only. + # Duration of this limit in textual notation. Must be "100s" or "1d". Used by + # group-based quotas only. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration - # Free tier value displayed in the Developers Console for this limit. - # The free tier is the number of tokens that will be subtracted from the - # billed amount when billing is enabled. - # This field can only be set on a limit with duration "1d", in a billable - # group; it is invalid on any other limit. If this field is not set, it - # defaults to 0, indicating that there is no free tier for this service. - # Used by group-based quotas only. + # Free tier value displayed in the Developers Console for this limit. The free + # tier is the number of tokens that will be subtracted from the billed amount + # when billing is enabled. This field can only be set on a limit with duration " + # 1d", in a billable group; it is invalid on any other limit. If this field is + # not set, it defaults to 0, indicating that there is no free tier for this + # service. Used by group-based quotas only. # Corresponds to the JSON property `freeTier` # @return [Fixnum] attr_accessor :free_tier - # Maximum number of tokens that can be consumed during the specified - # duration. Client application developers can override the default limit up - # to this maximum. If specified, this value cannot be set to a value less - # than the default limit. If not specified, it is set to the default limit. - # To allow clients to apply overrides with no upper bound, set this to -1, - # indicating unlimited maximum quota. - # Used by group-based quotas only. + # Maximum number of tokens that can be consumed during the specified duration. + # Client application developers can override the default limit up to this + # maximum. If specified, this value cannot be set to a value less than the + # default limit. If not specified, it is set to the default limit. To allow + # clients to apply overrides with no upper bound, set this to -1, indicating + # unlimited maximum quota. Used by group-based quotas only. # Corresponds to the JSON property `maxLimit` # @return [Fixnum] attr_accessor :max_limit - # The name of the metric this quota limit applies to. The quota limits with - # the same metric will be checked together during runtime. The metric must be + # The name of the metric this quota limit applies to. The quota limits with the + # same metric will be checked together during runtime. The metric must be # defined within the service config. # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric - # Name of the quota limit. - # The name must be provided, and it must be unique within the service. The - # name can only include alphanumeric characters as well as '-'. - # The maximum length of the limit name is 64 characters. + # Name of the quota limit. The name must be provided, and it must be unique + # within the service. The name can only include alphanumeric characters as well + # as '-'. The maximum length of the limit name is 64 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Specify the unit of the quota limit. It uses the same syntax as - # Metric.unit. The supported unit kinds are determined by the quota - # backend system. - # Here are some examples: - # * "1/min/`project`" for quota per minute per project. - # Note: the order of unit components is insignificant. - # The "1" at the beginning is required to follow the metric unit syntax. + # Specify the unit of the quota limit. It uses the same syntax as Metric.unit. + # The supported unit kinds are determined by the quota backend system. Here are + # some examples: * "1/min/`project`" for quota per minute per project. Note: the + # order of unit components is insignificant. The "1" at the beginning is + # required to follow the metric unit syntax. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit # Tiered limit values. You must specify this as a key:value pair, with an - # integer value that is the maximum number of requests allowed for the - # specified unit. Currently only STANDARD is supported. + # integer value that is the maximum number of requests allowed for the specified + # unit. Currently only STANDARD is supported. # Corresponds to the JSON property `values` # @return [Hash] attr_accessor :values @@ -3033,15 +2601,14 @@ module Google class Range include Google::Apis::Core::Hashable - # CIDR range in "10.x.x.x/y" format that is within the - # allocated ranges and currently unused. + # CIDR range in "10.x.x.x/y" format that is within the allocated ranges and + # currently unused. # Corresponds to the JSON property `ipCidrRange` # @return [String] attr_accessor :ip_cidr_range # In the Shared VPC host project, the VPC network that's peered with the - # consumer network. For example: - # `projects/1234321/global/networks/host-network` + # consumer network. For example: `projects/1234321/global/networks/host-network` # Corresponds to the JSON property `network` # @return [String] attr_accessor :network @@ -3127,15 +2694,15 @@ module Google attr_accessor :name # Fully-qualified URL of the VPC network in the producer host tenant project - # that this route applies to. For example: - # `projects/123456/global/networks/host-network` + # that this route applies to. For example: `projects/123456/global/networks/host- + # network` # Corresponds to the JSON property `network` # @return [String] attr_accessor :network # Fully-qualified URL of the gateway that should handle matching packets that - # this route applies to. For example: - # `projects/123456/global/gateways/default-internet-gateway` + # this route applies to. For example: `projects/123456/global/gateways/default- + # internet-gateway` # Corresponds to the JSON property `nextHopGateway` # @return [String] attr_accessor :next_hop_gateway @@ -3157,21 +2724,18 @@ module Google class SearchRangeRequest include Google::Apis::Core::Hashable - # Required. The prefix length of the IP range. - # Use usual CIDR range notation. - # For example, '30' to find unused x.x.x.x/30 CIDR range. - # Actual range will be determined using allocated range for the consumer - # peered network and returned in the result. + # Required. The prefix length of the IP range. Use usual CIDR range notation. + # For example, '30' to find unused x.x.x.x/30 CIDR range. Actual range will be + # determined using allocated range for the consumer peered network and returned + # in the result. # Corresponds to the JSON property `ipPrefixLength` # @return [Fixnum] attr_accessor :ip_prefix_length - # Network name in the consumer project. This network must have been - # already peered with a shared VPC network using CreateConnection - # method. - # Must be in a form 'projects/`project`/global/networks/`network`'. - # `project` is a project number, as in '12345' - # `network` is network name. + # Network name in the consumer project. This network must have been already + # peered with a shared VPC network using CreateConnection method. Must be in a + # form 'projects/`project`/global/networks/`network`'. `project` is a project + # number, as in '12345' `network` is network name. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network @@ -3188,50 +2752,32 @@ module Google end # `Service` is the root object of Google service configuration schema. It - # describes basic information about a service, such as the name and the - # title, and delegates other aspects to sub-sections. Each sub-section is - # either a proto message or a repeated proto message that configures a - # specific aspect, such as auth. See each proto message definition for details. - # Example: - # type: google.api.Service - # config_version: 3 - # name: calendar.googleapis.com - # title: Google Calendar API - # apis: - # - name: google.calendar.v3.Calendar - # authentication: - # providers: - # - id: google_calendar_auth - # jwks_uri: https://www.googleapis.com/oauth2/v1/certs - # issuer: https://securetoken.google.com - # rules: - # - selector: "*" - # requirements: - # provider_id: google_calendar_auth + # describes basic information about a service, such as the name and the title, + # and delegates other aspects to sub-sections. Each sub-section is either a + # proto message or a repeated proto message that configures a specific aspect, + # such as auth. See each proto message definition for details. Example: type: + # google.api.Service config_version: 3 name: calendar.googleapis.com title: + # Google Calendar API apis: - name: google.calendar.v3.Calendar authentication: + # providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/ + # oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" + # requirements: provider_id: google_calendar_auth class Service include Google::Apis::Core::Hashable - # A list of API interfaces exported by this service. Only the `name` field - # of the google.protobuf.Api needs to be provided by the configuration - # author, as the remaining fields will be derived from the IDL during the - # normalization process. It is an error to specify an API interface here - # which cannot be resolved against the associated IDL files. + # A list of API interfaces exported by this service. Only the `name` field of + # the google.protobuf.Api needs to be provided by the configuration author, as + # the remaining fields will be derived from the IDL during the normalization + # process. It is an error to specify an API interface here which cannot be + # resolved against the associated IDL files. # Corresponds to the JSON property `apis` # @return [Array] attr_accessor :apis - # `Authentication` defines the authentication configuration for an API. - # Example for an API targeted for external use: - # name: calendar.googleapis.com - # authentication: - # providers: - # - id: google_calendar_auth - # jwks_uri: https://www.googleapis.com/oauth2/v1/certs - # issuer: https://securetoken.google.com - # rules: - # - selector: "*" - # requirements: - # provider_id: google_calendar_auth + # `Authentication` defines the authentication configuration for an API. Example + # for an API targeted for external use: name: calendar.googleapis.com + # authentication: providers: - id: google_calendar_auth jwks_uri: https://www. + # googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - + # selector: "*" requirements: provider_id: google_calendar_auth # Corresponds to the JSON property `authentication` # @return [Google::Apis::ServicenetworkingV1beta::Authentication] attr_accessor :authentication @@ -3241,211 +2787,136 @@ module Google # @return [Google::Apis::ServicenetworkingV1beta::Backend] attr_accessor :backend - # Billing related configuration of the service. - # The following example shows how to configure monitored resources and metrics - # for billing, `consumer_destinations` is the only supported destination and - # the monitored resources need at least one label key - # `cloud.googleapis.com/location` to indicate the location of the billing - # usage, using different monitored resources between monitoring and billing is - # recommended so they can be evolved independently: - # monitored_resources: - # - type: library.googleapis.com/billing_branch - # labels: - # - key: cloud.googleapis.com/location - # description: | - # Predefined label to support billing location restriction. - # - key: city - # description: | - # Custom label to define the city where the library branch is located - # in. - # - key: name - # description: Custom label to define the name of the library branch. - # metrics: - # - name: library.googleapis.com/book/borrowed_count - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # billing: - # consumer_destinations: - # - monitored_resource: library.googleapis.com/billing_branch - # metrics: - # - library.googleapis.com/book/borrowed_count + # Billing related configuration of the service. The following example shows how + # to configure monitored resources and metrics for billing, ` + # consumer_destinations` is the only supported destination and the monitored + # resources need at least one label key `cloud.googleapis.com/location` to + # indicate the location of the billing usage, using different monitored + # resources between monitoring and billing is recommended so they can be evolved + # independently: monitored_resources: - type: library.googleapis.com/ + # billing_branch labels: - key: cloud.googleapis.com/location description: | + # Predefined label to support billing location restriction. - key: city + # description: | Custom label to define the city where the library branch is + # located in. - key: name description: Custom label to define the name of the + # library branch. metrics: - name: library.googleapis.com/book/borrowed_count + # metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: + # - monitored_resource: library.googleapis.com/billing_branch metrics: - library. + # googleapis.com/book/borrowed_count # Corresponds to the JSON property `billing` # @return [Google::Apis::ServicenetworkingV1beta::Billing] attr_accessor :billing - # The semantic version of the service configuration. The config version - # affects the interpretation of the service configuration. For example, - # certain features are enabled by default for certain config versions. - # The latest config version is `3`. + # The semantic version of the service configuration. The config version affects + # the interpretation of the service configuration. For example, certain features + # are enabled by default for certain config versions. The latest config version + # is `3`. # Corresponds to the JSON property `configVersion` # @return [Fixnum] attr_accessor :config_version - # `Context` defines which contexts an API requests. - # Example: - # context: - # rules: - # - selector: "*" - # requested: - # - google.rpc.context.ProjectContext - # - google.rpc.context.OriginContext - # The above specifies that all methods in the API request - # `google.rpc.context.ProjectContext` and - # `google.rpc.context.OriginContext`. - # Available context types are defined in package - # `google.rpc.context`. - # This also provides mechanism to whitelist any protobuf message extension that - # can be sent in grpc metadata using “x-goog-ext--bin” and - # “x-goog-ext--jspb” format. For example, list any service - # specific protobuf types that can appear in grpc metadata as follows in your - # yaml file: - # Example: - # context: - # rules: - # - selector: "google.example.library.v1.LibraryService.CreateBook" - # allowed_request_extensions: - # - google.foo.v1.NewExtension - # allowed_response_extensions: - # - google.foo.v1.NewExtension - # You can also specify extension ID instead of fully qualified extension name - # here. + # `Context` defines which contexts an API requests. Example: context: rules: - + # selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc. + # context.OriginContext The above specifies that all methods in the API request ` + # google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. + # Available context types are defined in package `google.rpc.context`. This also + # provides mechanism to whitelist any protobuf message extension that can be + # sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. + # For example, list any service specific protobuf types that can appear in grpc + # metadata as follows in your yaml file: Example: context: rules: - selector: " + # google.example.library.v1.LibraryService.CreateBook" + # allowed_request_extensions: - google.foo.v1.NewExtension + # allowed_response_extensions: - google.foo.v1.NewExtension You can also specify + # extension ID instead of fully qualified extension name here. # Corresponds to the JSON property `context` # @return [Google::Apis::ServicenetworkingV1beta::Context] attr_accessor :context - # Selects and configures the service controller used by the service. The - # service controller handles features like abuse, quota, billing, logging, - # monitoring, etc. + # Selects and configures the service controller used by the service. The service + # controller handles features like abuse, quota, billing, logging, monitoring, + # etc. # Corresponds to the JSON property `control` # @return [Google::Apis::ServicenetworkingV1beta::Control] attr_accessor :control - # Customize service error responses. For example, list any service - # specific protobuf types that can appear in error detail lists of - # error responses. - # Example: - # custom_error: - # types: - # - google.foo.v1.CustomError - # - google.foo.v1.AnotherError + # Customize service error responses. For example, list any service specific + # protobuf types that can appear in error detail lists of error responses. + # Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1. + # AnotherError # Corresponds to the JSON property `customError` # @return [Google::Apis::ServicenetworkingV1beta::CustomError] attr_accessor :custom_error - # `Documentation` provides the information for describing a service. - # Example: - # 
documentation:
-        # summary: >
-        # The Google Calendar API gives access
-        # to most calendar features.
-        # pages:
-        # - name: Overview
-        # content: (== include google/foo/overview.md ==)
-        # - name: Tutorial
-        # content: (== include google/foo/tutorial.md ==)
-        # subpages;
-        # - name: Java
-        # content: (== include google/foo/tutorial_java.md ==)
-        # rules:
-        # - selector: google.calendar.Calendar.Get
-        # description: >
-        # ...
-        # - selector: google.calendar.Calendar.Put
-        # description: >
-        # ...
-        #
- # Documentation is provided in markdown syntax. In addition to - # standard markdown features, definition lists, tables and fenced - # code blocks are supported. Section headers can be provided and are - # interpreted relative to the section nesting of the context where - # a documentation fragment is embedded. - # Documentation from the IDL is merged with documentation defined - # via the config at normalization time, where documentation provided - # by config rules overrides IDL provided. - # A number of constructs specific to the API platform are supported - # in documentation text. - # In order to reference a proto element, the following - # notation can be used: - # 
[fully.qualified.proto.name][]
- # To override the display text used for the link, this can be used: - # 
[display text][fully.qualified.proto.name]
- # Text can be excluded from doc using the following notation: - # 
(-- internal comment --)
- # A few directives are available in documentation. Note that - # directives must appear on a single line to be properly - # identified. The `include` directive includes a markdown file from - # an external source: - # 
(== include path/to/file ==)
- # The `resource_for` directive marks a message to be the resource of - # a collection in REST view. If it is not specified, tools attempt - # to infer the resource from the operations in a collection: - # 
(== resource_for v1.shelves.books ==)
- # The directive `suppress_warning` does not directly affect documentation - # and is documented together with service config validation. + # `Documentation` provides the information for describing a service. Example: + # documentation: summary: > The Google Calendar API gives access to most + # calendar features. pages: - name: Overview content: (== include google/foo/ + # overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md == + # ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==) + # rules: - selector: google.calendar.Calendar.Get description: > ... - selector: + # google.calendar.Calendar.Put description: > ... Documentation is provided in + # markdown syntax. In addition to standard markdown features, definition lists, + # tables and fenced code blocks are supported. Section headers can be provided + # and are interpreted relative to the section nesting of the context where a + # documentation fragment is embedded. Documentation from the IDL is merged with + # documentation defined via the config at normalization time, where + # documentation provided by config rules overrides IDL provided. A number of + # constructs specific to the API platform are supported in documentation text. + # In order to reference a proto element, the following notation can be used: [ + # fully.qualified.proto.name][] To override the display text used for the link, + # this can be used: [display text][fully.qualified.proto.name] Text can be + # excluded from doc using the following notation: (-- internal comment --) A few + # directives are available in documentation. Note that directives must appear on + # a single line to be properly identified. The `include` directive includes a + # markdown file from an external source: (== include path/to/file ==) The ` + # resource_for` directive marks a message to be the resource of a collection in + # REST view. If it is not specified, tools attempt to infer the resource from + # the operations in a collection: (== resource_for v1.shelves.books ==) The + # directive `suppress_warning` does not directly affect documentation and is + # documented together with service config validation. # Corresponds to the JSON property `documentation` # @return [Google::Apis::ServicenetworkingV1beta::Documentation] attr_accessor :documentation - # Configuration for network endpoints. If this is empty, then an endpoint - # with the same name as the service is automatically generated to service all - # defined APIs. + # Configuration for network endpoints. If this is empty, then an endpoint with + # the same name as the service is automatically generated to service all defined + # APIs. # Corresponds to the JSON property `endpoints` # @return [Array] attr_accessor :endpoints - # A list of all enum types included in this API service. Enums - # referenced directly or indirectly by the `apis` are automatically - # included. Enums which are not referenced but shall be included - # should be listed here by name. Example: - # enums: - # - name: google.someapi.v1.SomeEnum + # A list of all enum types included in this API service. Enums referenced + # directly or indirectly by the `apis` are automatically included. Enums which + # are not referenced but shall be included should be listed here by name. + # Example: enums: - name: google.someapi.v1.SomeEnum # Corresponds to the JSON property `enums` # @return [Array] attr_accessor :enums # Defines the HTTP configuration for an API service. It contains a list of - # HttpRule, each specifying the mapping of an RPC method - # to one or more HTTP REST API methods. + # HttpRule, each specifying the mapping of an RPC method to one or more HTTP + # REST API methods. # Corresponds to the JSON property `http` # @return [Google::Apis::ServicenetworkingV1beta::Http] attr_accessor :http - # A unique ID for a specific instance of this message, typically assigned - # by the client for tracking purpose. Must be no longer than 63 characters - # and only lower case letters, digits, '.', '_' and '-' are allowed. If - # empty, the server may choose to generate one instead. + # A unique ID for a specific instance of this message, typically assigned by the + # client for tracking purpose. Must be no longer than 63 characters and only + # lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server + # may choose to generate one instead. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Logging configuration of the service. - # The following example shows how to configure logs to be sent to the - # producer and consumer projects. In the example, the `activity_history` - # log is sent to both the producer and consumer projects, whereas the - # `purchase_history` log is only sent to the producer project. - # monitored_resources: - # - type: library.googleapis.com/branch - # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. - # logs: - # - name: activity_history - # labels: - # - key: /customer_id - # - name: purchase_history - # logging: - # producer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history - # - purchase_history - # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history + # Logging configuration of the service. The following example shows how to + # configure logs to be sent to the producer and consumer projects. In the + # example, the `activity_history` log is sent to both the producer and consumer + # projects, whereas the `purchase_history` log is only sent to the producer + # project. monitored_resources: - type: library.googleapis.com/branch labels: - + # key: /city description: The city where the library branch is located in. - key: + # /name description: The name of the branch. logs: - name: activity_history + # labels: - key: /customer_id - name: purchase_history logging: + # producer_destinations: - monitored_resource: library.googleapis.com/branch + # logs: - activity_history - purchase_history consumer_destinations: - + # monitored_resource: library.googleapis.com/branch logs: - activity_history # Corresponds to the JSON property `logging` # @return [Google::Apis::ServicenetworkingV1beta::Logging] attr_accessor :logging @@ -3460,70 +2931,41 @@ module Google # @return [Array] attr_accessor :metrics - # Defines the monitored resources used by this service. This is required - # by the Service.monitoring and Service.logging configurations. + # Defines the monitored resources used by this service. This is required by the + # Service.monitoring and Service.logging configurations. # Corresponds to the JSON property `monitoredResources` # @return [Array] attr_accessor :monitored_resources - # Monitoring configuration of the service. - # The example below shows how to configure monitored resources and metrics - # for monitoring. In the example, a monitored resource and two metrics are - # defined. The `library.googleapis.com/book/returned_count` metric is sent - # to both producer and consumer projects, whereas the - # `library.googleapis.com/book/num_overdue` metric is only sent to the - # consumer project. - # monitored_resources: - # - type: library.googleapis.com/Branch - # display_name: "Library Branch" - # description: "A branch of a library." - # launch_stage: GA - # labels: - # - key: resource_container - # description: "The Cloud container (ie. project id) for the Branch." - # - key: location - # description: "The location of the library branch." - # - key: branch_id - # description: "The id of the branch." - # metrics: - # - name: library.googleapis.com/book/returned_count - # display_name: "Books Returned" - # description: "The count of books that have been returned." - # launch_stage: GA - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # - name: library.googleapis.com/book/num_overdue - # display_name: "Books Overdue" - # description: "The current number of overdue books." - # launch_stage: GA - # metric_kind: GAUGE - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # monitoring: - # producer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # consumer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # - library.googleapis.com/book/num_overdue + # Monitoring configuration of the service. The example below shows how to + # configure monitored resources and metrics for monitoring. In the example, a + # monitored resource and two metrics are defined. The `library.googleapis.com/ + # book/returned_count` metric is sent to both producer and consumer projects, + # whereas the `library.googleapis.com/book/num_overdue` metric is only sent to + # the consumer project. monitored_resources: - type: library.googleapis.com/ + # Branch display_name: "Library Branch" description: "A branch of a library." + # launch_stage: GA labels: - key: resource_container description: "The Cloud + # container (ie. project id) for the Branch." - key: location description: "The + # location of the library branch." - key: branch_id description: "The id of the + # branch." metrics: - name: library.googleapis.com/book/returned_count + # display_name: "Books Returned" description: "The count of books that have been + # returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" + # labels: - key: customer_id description: "The id of the customer." - name: + # library.googleapis.com/book/num_overdue display_name: "Books Overdue" + # description: "The current number of overdue books." launch_stage: GA + # metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id + # description: "The id of the customer." monitoring: producer_destinations: - + # monitored_resource: library.googleapis.com/Branch metrics: - library. + # googleapis.com/book/returned_count consumer_destinations: - monitored_resource: + # library.googleapis.com/Branch metrics: - library.googleapis.com/book/ + # returned_count - library.googleapis.com/book/num_overdue # Corresponds to the JSON property `monitoring` # @return [Google::Apis::ServicenetworkingV1beta::Monitoring] attr_accessor :monitoring - # The service name, which is a DNS-like logical identifier for the - # service, such as `calendar.googleapis.com`. The service name - # typically goes through DNS verification to make sure the owner - # of the service also owns the DNS name. + # The service name, which is a DNS-like logical identifier for the service, such + # as `calendar.googleapis.com`. The service name typically goes through DNS + # verification to make sure the owner of the service also owns the DNS name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3533,46 +2975,25 @@ module Google # @return [String] attr_accessor :producer_project_id - # Quota configuration helps to achieve fairness and budgeting in service - # usage. - # The metric based quota configuration works this way: - # - The service configuration defines a set of metrics. - # - For API calls, the quota.metric_rules maps methods to metrics with - # corresponding costs. - # - The quota.limits defines limits on the metrics, which will be used for - # quota checks at runtime. - # An example quota configuration in yaml format: - # quota: - # limits: - # - name: apiWriteQpsPerProject - # metric: library.googleapis.com/write_calls - # unit: "1/min/`project`" # rate limit for consumer projects - # values: - # STANDARD: 10000 - # # The metric rules bind all methods to the read_calls metric, - # # except for the UpdateBook and DeleteBook methods. These two methods - # # are mapped to the write_calls metric, with the UpdateBook method - # # consuming at twice rate as the DeleteBook method. - # metric_rules: - # - selector: "*" - # metric_costs: - # library.googleapis.com/read_calls: 1 - # - selector: google.example.library.v1.LibraryService.UpdateBook - # metric_costs: - # library.googleapis.com/write_calls: 2 - # - selector: google.example.library.v1.LibraryService.DeleteBook - # metric_costs: - # library.googleapis.com/write_calls: 1 - # Corresponding Metric definition: - # metrics: - # - name: library.googleapis.com/read_calls - # display_name: Read requests - # metric_kind: DELTA - # value_type: INT64 - # - name: library.googleapis.com/write_calls - # display_name: Write requests - # metric_kind: DELTA - # value_type: INT64 + # Quota configuration helps to achieve fairness and budgeting in service usage. + # The metric based quota configuration works this way: - The service + # configuration defines a set of metrics. - For API calls, the quota. + # metric_rules maps methods to metrics with corresponding costs. - The quota. + # limits defines limits on the metrics, which will be used for quota checks at + # runtime. An example quota configuration in yaml format: quota: limits: - name: + # apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/` + # project`" # rate limit for consumer projects values: STANDARD: 10000 # The + # metric rules bind all methods to the read_calls metric, # except for the + # UpdateBook and DeleteBook methods. These two methods # are mapped to the + # write_calls metric, with the UpdateBook method # consuming at twice rate as + # the DeleteBook method. metric_rules: - selector: "*" metric_costs: library. + # googleapis.com/read_calls: 1 - selector: google.example.library.v1. + # LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - + # selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: + # library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: + # - name: library.googleapis.com/read_calls display_name: Read requests + # metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/ + # write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 # Corresponds to the JSON property `quota` # @return [Google::Apis::ServicenetworkingV1beta::Quota] attr_accessor :quota @@ -3582,20 +3003,18 @@ module Google # @return [Google::Apis::ServicenetworkingV1beta::SourceInfo] attr_accessor :source_info - # ### System parameter configuration - # A system parameter is a special kind of parameter defined by the API - # system, not by an individual API. It is typically mapped to an HTTP header - # and/or a URL query parameter. This configuration specifies which methods - # change the names of the system parameters. + # ### System parameter configuration A system parameter is a special kind of + # parameter defined by the API system, not by an individual API. It is typically + # mapped to an HTTP header and/or a URL query parameter. This configuration + # specifies which methods change the names of the system parameters. # Corresponds to the JSON property `systemParameters` # @return [Google::Apis::ServicenetworkingV1beta::SystemParameters] attr_accessor :system_parameters - # A list of all proto message types included in this API service. - # It serves similar purpose as [google.api.Service.types], except that - # these types are not needed by user-defined APIs. Therefore, they will not - # show up in the generated discovery doc. This field should only be used - # to define system APIs in ESF. + # A list of all proto message types included in this API service. It serves + # similar purpose as [google.api.Service.types], except that these types are not + # needed by user-defined APIs. Therefore, they will not show up in the generated + # discovery doc. This field should only be used to define system APIs in ESF. # Corresponds to the JSON property `systemTypes` # @return [Array] attr_accessor :system_types @@ -3605,12 +3024,10 @@ module Google # @return [String] attr_accessor :title - # A list of all proto message types included in this API service. - # Types referenced directly or indirectly by the `apis` are - # automatically included. Messages which are not referenced but - # shall be included, such as types used by the `google.protobuf.Any` type, - # should be listed here by name. Example: - # types: + # A list of all proto message types included in this API service. Types + # referenced directly or indirectly by the `apis` are automatically included. + # Messages which are not referenced but shall be included, such as types used by + # the `google.protobuf.Any` type, should be listed here by name. Example: types: # - name: google.protobuf.Int32 # Corresponds to the JSON property `types` # @return [Array] @@ -3657,32 +3074,28 @@ module Google end end - # The per-product per-project service identity for a service. - # Use this field to configure per-product per-project service identity. - # Example of a service identity configuration. - # usage: - # service_identity: - # - service_account_parent: "projects/123456789" - # display_name: "Cloud XXX Service Agent" - # description: "Used as the identity of Cloud XXX to access resources" + # The per-product per-project service identity for a service. Use this field to + # configure per-product per-project service identity. Example of a service + # identity configuration. usage: service_identity: - service_account_parent: " + # projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used + # as the identity of Cloud XXX to access resources" class ServiceIdentity include Google::Apis::Core::Hashable - # Optional. A user-specified opaque description of the service account. - # Must be less than or equal to 256 UTF-8 bytes. + # Optional. A user-specified opaque description of the service account. Must be + # less than or equal to 256 UTF-8 bytes. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Optional. A user-specified name for the service account. - # Must be less than or equal to 100 UTF-8 bytes. + # Optional. A user-specified name for the service account. Must be less than or + # equal to 100 UTF-8 bytes. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # A service account project that hosts the service accounts. - # An example name would be: - # `projects/123456789` + # A service account project that hosts the service accounts. An example name + # would be: `projects/123456789` # Corresponds to the JSON property `serviceAccountParent` # @return [String] attr_accessor :service_account_parent @@ -3699,13 +3112,13 @@ module Google end end - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. class SourceContext include Google::Apis::Core::Hashable # The path-qualified name of the .proto file that contained the associated - # protobuf element. For example: `"google/protobuf/source_context.proto"`. + # protobuf element. For example: `"google/protobuf/source_context.proto"`. # Corresponds to the JSON property `fileName` # @return [String] attr_accessor :file_name @@ -3739,12 +3152,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 @@ -3753,15 +3166,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 @@ -3788,21 +3201,19 @@ module Google # @return [String] attr_accessor :ip_cidr_range - # Subnetwork name. - # See https://cloud.google.com/compute/docs/vpc/ + # Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # In the Shared VPC host project, the VPC network that's peered with the - # consumer network. For example: - # `projects/1234321/global/networks/host-network` + # consumer network. For example: `projects/1234321/global/networks/host-network` # Corresponds to the JSON property `network` # @return [String] attr_accessor :network - # This is a discovered subnet that is not within the current consumer - # allocated ranges. + # This is a discovered subnet that is not within the current consumer allocated + # ranges. # Corresponds to the JSON property `outsideAllocation` # @return [Boolean] attr_accessor :outside_allocation @@ -3827,8 +3238,7 @@ module Google class SystemParameter include Google::Apis::Core::Hashable - # Define the HTTP header name to use for the parameter. It is case - # insensitive. + # Define the HTTP header name to use for the parameter. It is case insensitive. # Corresponds to the JSON property `httpHeader` # @return [String] attr_accessor :http_header @@ -3856,23 +3266,20 @@ module Google end end - # Define a system parameter rule mapping system parameter definitions to - # methods. + # Define a system parameter rule mapping system parameter definitions to methods. class SystemParameterRule include Google::Apis::Core::Hashable - # Define parameters. Multiple names may be defined for a parameter. - # For a given method call, only one of them should be used. If multiple - # names are used the behavior is implementation-dependent. - # If none of the specified names are present the behavior is - # parameter-dependent. + # Define parameters. Multiple names may be defined for a parameter. For a given + # method call, only one of them should be used. If multiple names are used the + # behavior is implementation-dependent. If none of the specified names are + # present the behavior is parameter-dependent. # Corresponds to the JSON property `parameters` # @return [Array] attr_accessor :parameters # Selects the methods to which this rule applies. Use '*' to indicate all - # methods in all APIs. - # Refer to selector for syntax details. + # methods in all APIs. Refer to selector for syntax details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -3888,36 +3295,23 @@ module Google end end - # ### System parameter configuration - # A system parameter is a special kind of parameter defined by the API - # system, not by an individual API. It is typically mapped to an HTTP header - # and/or a URL query parameter. This configuration specifies which methods - # change the names of the system parameters. + # ### System parameter configuration A system parameter is a special kind of + # parameter defined by the API system, not by an individual API. It is typically + # mapped to an HTTP header and/or a URL query parameter. This configuration + # specifies which methods change the names of the system parameters. class SystemParameters include Google::Apis::Core::Hashable - # Define system parameters. - # The parameters defined here will override the default parameters - # implemented by the system. If this field is missing from the service - # config, default system parameters will be used. Default system parameters - # and names is implementation-dependent. - # Example: define api key for all methods - # system_parameters - # rules: - # - selector: "*" - # parameters: - # - name: api_key - # url_query_parameter: api_key - # Example: define 2 api key names for a specific method. - # system_parameters - # rules: - # - selector: "/ListShelves" - # parameters: - # - name: api_key - # http_header: Api-Key1 - # - name: api_key - # http_header: Api-Key2 - # **NOTE:** All service configuration rules follow "last one wins" order. + # Define system parameters. The parameters defined here will override the + # default parameters implemented by the system. If this field is missing from + # the service config, default system parameters will be used. Default system + # parameters and names is implementation-dependent. Example: define api key for + # all methods system_parameters rules: - selector: "*" parameters: - name: + # api_key url_query_parameter: api_key Example: define 2 api key names for a + # specific method. system_parameters rules: - selector: "/ListShelves" + # parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: + # Api-Key2 **NOTE:** All service configuration rules follow "last one wins" + # order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -3956,8 +3350,8 @@ module Google # @return [Array] attr_accessor :options - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. # Corresponds to the JSON property `sourceContext` # @return [Google::Apis::ServicenetworkingV1beta::SourceContext] attr_accessor :source_context @@ -4001,37 +3395,33 @@ module Google include Google::Apis::Core::Hashable # The full resource name of a channel used for sending notifications to the - # service producer. - # Google Service Management currently only supports - # [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification - # channel. To use Google Cloud Pub/Sub as the channel, this must be the name - # of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format - # documented in https://cloud.google.com/pubsub/docs/overview. + # service producer. Google Service Management currently only supports [Google + # Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To + # use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/ + # Sub topic that uses the Cloud Pub/Sub topic name format documented in https:// + # cloud.google.com/pubsub/docs/overview. # Corresponds to the JSON property `producerNotificationChannel` # @return [String] attr_accessor :producer_notification_channel # Requirements that must be satisfied before a consumer project can use the - # service. Each requirement is of the form /; - # for example 'serviceusage.googleapis.com/billing-enabled'. + # service. Each requirement is of the form /; for example 'serviceusage. + # googleapis.com/billing-enabled'. # Corresponds to the JSON property `requirements` # @return [Array] attr_accessor :requirements - # A list of usage rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of usage rules that apply to individual API methods. **NOTE:** All + # service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules - # The per-product per-project service identity for a service. - # Use this field to configure per-product per-project service identity. - # Example of a service identity configuration. - # usage: - # service_identity: - # - service_account_parent: "projects/123456789" - # display_name: "Cloud XXX Service Agent" - # description: "Used as the identity of Cloud XXX to access resources" + # The per-product per-project service identity for a service. Use this field to + # configure per-product per-project service identity. Example of a service + # identity configuration. usage: service_identity: - service_account_parent: " + # projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used + # as the identity of Cloud XXX to access resources" # Corresponds to the JSON property `serviceIdentity` # @return [Google::Apis::ServicenetworkingV1beta::ServiceIdentity] attr_accessor :service_identity @@ -4049,45 +3439,36 @@ module Google end end - # Usage configuration rules for the service. - # NOTE: Under development. - # Use this rule to configure unregistered calls for the service. Unregistered - # calls are calls that do not contain consumer project identity. - # (Example: calls that do not contain an API key). - # By default, API methods do not allow unregistered calls, and each method call - # must be identified by a consumer project identity. Use this rule to - # allow/disallow unregistered calls. - # Example of an API that wants to allow unregistered calls for entire service. - # usage: - # rules: - # - selector: "*" - # allow_unregistered_calls: true - # Example of a method that wants to allow unregistered calls. - # usage: - # rules: - # - selector: "google.example.library.v1.LibraryService.CreateBook" - # allow_unregistered_calls: true + # Usage configuration rules for the service. NOTE: Under development. Use this + # rule to configure unregistered calls for the service. Unregistered calls are + # calls that do not contain consumer project identity. (Example: calls that do + # not contain an API key). By default, API methods do not allow unregistered + # calls, and each method call must be identified by a consumer project identity. + # Use this rule to allow/disallow unregistered calls. Example of an API that + # wants to allow unregistered calls for entire service. usage: rules: - selector: + # "*" allow_unregistered_calls: true Example of a method that wants to allow + # unregistered calls. usage: rules: - selector: "google.example.library.v1. + # LibraryService.CreateBook" allow_unregistered_calls: true class UsageRule include Google::Apis::Core::Hashable - # If true, the selected method allows unregistered calls, e.g. calls - # that don't identify any user or application. + # If true, the selected method allows unregistered calls, e.g. calls that don't + # identify any user or application. # Corresponds to the JSON property `allowUnregisteredCalls` # @return [Boolean] attr_accessor :allow_unregistered_calls alias_method :allow_unregistered_calls?, :allow_unregistered_calls # Selects the methods to which this rule applies. Use '*' to indicate all - # methods in all APIs. - # Refer to selector for syntax details. + # methods in all APIs. Refer to selector for syntax details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector - # If true, the selected method should skip service control and the control - # plane features, such as quota and billing, will not be available. - # This flag is used by Google Cloud Endpoints to bypass checks for internal - # methods, such as service health check methods. + # If true, the selected method should skip service control and the control plane + # features, such as quota and billing, will not be available. This flag is used + # by Google Cloud Endpoints to bypass checks for internal methods, such as + # service health check methods. # Corresponds to the JSON property `skipServiceControl` # @return [Boolean] attr_accessor :skip_service_control diff --git a/generated/google/apis/servicenetworking_v1beta/service.rb b/generated/google/apis/servicenetworking_v1beta/service.rb index 1a739203c..43dd3e339 100644 --- a/generated/google/apis/servicenetworking_v1beta/service.rb +++ b/generated/google/apis/servicenetworking_v1beta/service.rb @@ -48,9 +48,8 @@ module Google @batch_path = 'batch' 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 @@ -80,23 +79,22 @@ module Google execute_or_queue_command(command, &block) end - # For service producers, provisions a new subnet in a - # peered service's shared VPC network in the requested region and with the - # requested size that's expressed as a CIDR range (number of leading bits of - # ipV4 network mask). The method checks against the assigned allocated ranges - # to find a non-conflicting IP address range. The method will reuse a subnet - # if subsequent calls contain the same subnet name, region, and prefix - # length. This method will make producer's tenant project to be a shared VPC - # service project as needed. The response from the `get` operation will be of - # type `Subnetwork` if the operation successfully completes. + # For service producers, provisions a new subnet in a peered service's shared + # VPC network in the requested region and with the requested size that's + # expressed as a CIDR range (number of leading bits of ipV4 network mask). The + # method checks against the assigned allocated ranges to find a non-conflicting + # IP address range. The method will reuse a subnet if subsequent calls contain + # the same subnet name, region, and prefix length. This method will make + # producer's tenant project to be a shared VPC service project as needed. The + # response from the `get` operation will be of type `Subnetwork` if the + # operation successfully completes. # @param [String] parent # Required. A tenant project in the service producer organization, in the - # following format: services/`service`/`collection-id`/`resource-id`. - # `collection-id` is the cloud resource collection type that represents the - # tenant project. Only `projects` are supported. - # `resource-id` is the tenant project numeric id, such as - # `123456`. `service` the name of the peering service, such as - # `service-peering.example.com`. This service must already be + # following format: services/`service`/`collection-id`/`resource-id`. ` + # collection-id` is the cloud resource collection type that represents the + # tenant project. Only `projects` are supported. `resource-id` is the tenant + # project numeric id, such as `123456`. `service` the name of the peering + # service, such as `service-peering.example.com`. This service must already be # enabled in the service consumer's project. # @param [Google::Apis::ServicenetworkingV1beta::AddSubnetworkRequest] add_subnetwork_request_object # @param [String] fields @@ -128,18 +126,14 @@ module Google execute_or_queue_command(command, &block) end - # Service producers can use this method to find a currently unused range - # within consumer allocated ranges. This returned range is not reserved, - # and not guaranteed to remain unused. - # It will validate previously provided allocated ranges, find - # non-conflicting sub-range of requested size (expressed in - # number of leading bits of ipv4 network mask, as in CIDR range - # notation). - # Operation + # Service producers can use this method to find a currently unused range within + # consumer allocated ranges. This returned range is not reserved, and not + # guaranteed to remain unused. It will validate previously provided allocated + # ranges, find non-conflicting sub-range of requested size (expressed in number + # of leading bits of ipv4 network mask, as in CIDR range notation). Operation # @param [String] parent - # Required. This is in a form services/`service`. - # `service` the name of the private access management service, for example - # 'service-peering.example.com'. + # Required. This is in a form services/`service`. `service` the name of the + # private access management service, for example 'service-peering.example.com'. # @param [Google::Apis::ServicenetworkingV1beta::SearchRangeRequest] search_range_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -170,21 +164,20 @@ module Google execute_or_queue_command(command, &block) end - # Updates the allocated ranges that are assigned to a connection. - # The response from the `get` operation will be of type `Connection` if the - # operation successfully completes. + # Updates the allocated ranges that are assigned to a connection. The response + # from the `get` operation will be of type `Connection` if the operation + # successfully completes. # @param [String] name - # The service producer peering service that is managing peering connectivity - # for a service producer organization. - # For Google services that support this functionality, this is - # `services/servicenetworking.googleapis.com`. + # The service producer peering service that is managing peering connectivity for + # a service producer organization. For Google services that support this + # functionality, this is `services/servicenetworking.googleapis.com`. # @param [Google::Apis::ServicenetworkingV1beta::Connection] connection_object # @param [Boolean] force - # If a previously defined allocated range is removed, force flag must be - # set to true. + # If a previously defined allocated range is removed, force flag must be set to + # true. # @param [String] update_mask - # The update mask. If this is omitted, it defaults to "*". You can only - # update the listed peering ranges. + # The update mask. If this is omitted, it defaults to "*". You can only update + # the listed peering ranges. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -216,19 +209,18 @@ module Google execute_or_queue_command(command, &block) end - # Creates a private connection that establishes a VPC Network Peering - # connection to a VPC network in the service producer's organization. - # The administrator of the service consumer's VPC network invokes this - # method. The administrator must assign one or more allocated IP ranges for - # provisioning subnetworks in the service producer's VPC network. This - # connection is used for all supported services in the service producer's - # organization, so it only needs to be invoked once. The response from the - # `get` operation will be of type `Connection` if the operation successfully - # completes. + # Creates a private connection that establishes a VPC Network Peering connection + # to a VPC network in the service producer's organization. The administrator of + # the service consumer's VPC network invokes this method. The administrator must + # assign one or more allocated IP ranges for provisioning subnetworks in the + # service producer's VPC network. This connection is used for all supported + # services in the service producer's organization, so it only needs to be + # invoked once. The response from the `get` operation will be of type ` + # Connection` if the operation successfully completes. # @param [String] parent # The service that is managing peering connectivity for a service producer's - # organization. For Google services that support this functionality, this - # value is `services/servicenetworking.googleapis.com`. + # organization. For Google services that support this functionality, this value + # is `services/servicenetworking.googleapis.com`. # @param [Google::Apis::ServicenetworkingV1beta::Connection] connection_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -259,22 +251,19 @@ module Google execute_or_queue_command(command, &block) end - # List the private connections that are configured in a service consumer's - # VPC network. + # List the private connections that are configured in a service consumer's VPC + # network. # @param [String] parent # The service that is managing peering connectivity for a service producer's - # organization. For Google services that support this functionality, this - # value is `services/servicenetworking.googleapis.com`. - # If you specify `-` as the parameter value, all configured public peering - # services are listed. + # organization. For Google services that support this functionality, this value + # is `services/servicenetworking.googleapis.com`. If you specify `-` as the + # parameter value, all configured public peering services are listed. # @param [String] network # The name of service consumer's VPC network that's connected with service - # producer network through a private connection. The network name must be in - # the following format: - # `projects/`project`/global/networks/`network``. `project` is a - # project number, such as in `12345` that includes the VPC service - # consumer's VPC network. `network` is the name of the service consumer's VPC - # network. + # producer network through a private connection. The network name must be in the + # following format: `projects/`project`/global/networks/`network``. `project` is + # a project number, such as in `12345` that includes the VPC service consumer's + # VPC network. `network` is the name of the service consumer's VPC network. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/serviceusage_v1.rb b/generated/google/apis/serviceusage_v1.rb index 030279aca..7c713c1dd 100644 --- a/generated/google/apis/serviceusage_v1.rb +++ b/generated/google/apis/serviceusage_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/service-usage/ module ServiceusageV1 VERSION = 'V1' - REVISION = '20200721' + REVISION = '20200801' # 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/serviceusage_v1/classes.rb b/generated/google/apis/serviceusage_v1/classes.rb index f739ff2e0..577ef5a00 100644 --- a/generated/google/apis/serviceusage_v1/classes.rb +++ b/generated/google/apis/serviceusage_v1/classes.rb @@ -26,53 +26,48 @@ module Google class AdminQuotaPolicy include Google::Apis::Core::Hashable - # The cloud resource container at which the quota policy is created. The - # format is `container_type`/`container_number` + # The cloud resource container at which the quota policy is created. The format + # is `container_type`/`container_number` # Corresponds to the JSON property `container` # @return [String] attr_accessor :container - # If this map is nonempty, then this policy applies only to specific values - # for dimensions defined in the limit unit. - # For example, an policy on a limit with the unit 1/`project`/`region` - # could contain an entry with the key "region" and the value "us-east-1"; - # the policy is only applied to quota consumed in that region. - # This map has the following restrictions: - # * If "region" appears as a key, its value must be a valid Cloud region. - # * If "zone" appears as a key, its value must be a valid Cloud zone. - # * Keys other than "region" or "zone" are not valid. + # If this map is nonempty, then this policy applies only to specific values for + # dimensions defined in the limit unit. For example, an policy on a limit with + # the unit 1/`project`/`region` could contain an entry with the key "region" and + # the value "us-east-1"; the policy is only applied to quota consumed in that + # region. This map has the following restrictions: * If "region" appears as a + # key, its value must be a valid Cloud region. * If "zone" appears as a key, its + # value must be a valid Cloud zone. * Keys other than "region" or "zone" are not + # valid. # Corresponds to the JSON property `dimensions` # @return [Hash] attr_accessor :dimensions - # The name of the metric to which this policy applies. - # An example name would be: + # The name of the metric to which this policy applies. An example name would be: # `compute.googleapis.com/cpus` # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric - # The resource name of the policy. - # This name is generated by the server when the policy is created. - # Example names would be: - # `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/ - # compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/ - # 4a3f2c1d` + # The resource name of the policy. This name is generated by the server when the + # policy is created. Example names would be: `organizations/123/services/compute. + # googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/% + # 2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The quota policy value. - # Can be any nonnegative integer, or -1 (unlimited quota). + # The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota) + # . # Corresponds to the JSON property `policyValue` # @return [Fixnum] attr_accessor :policy_value - # The limit unit of the limit to which this policy applies. - # An example unit would be: - # `1/`project`/`region`` - # Note that ``project`` and ``region`` are not placeholders in this example; - # the literal characters ``` and ``` occur in the string. + # The limit unit of the limit to which this policy applies. An example unit + # would be: `1/`project`/`region`` Note that ``project`` and ``region`` are not + # placeholders in this example; the literal characters ``` and ``` occur in the + # string. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit @@ -92,14 +87,13 @@ module Google end end - # Api is a light-weight descriptor for an API Interface. - # Interfaces are also described as "protocol buffer services" in some contexts, - # such as by the "service" keyword in a .proto file, but they are different - # from API Services, which represent a concrete implementation of an interface - # as opposed to simply a description of methods and bindings. They are also - # sometimes simply referred to as "APIs" in other contexts, such as the name of - # this message itself. See https://cloud.google.com/apis/design/glossary for - # detailed terminology. + # Api is a light-weight descriptor for an API Interface. Interfaces are also + # described as "protocol buffer services" in some contexts, such as by the " + # service" keyword in a .proto file, but they are different from API Services, + # which represent a concrete implementation of an interface as opposed to simply + # a description of methods and bindings. They are also sometimes simply referred + # to as "APIs" in other contexts, such as the name of this message itself. See + # https://cloud.google.com/apis/design/glossary for detailed terminology. class Api include Google::Apis::Core::Hashable @@ -113,8 +107,8 @@ module Google # @return [Array] attr_accessor :mixins - # The fully qualified name of this interface, including package name - # followed by the interface's simple name. + # The fully qualified name of this interface, including package name followed by + # the interface's simple name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -124,8 +118,8 @@ module Google # @return [Array] attr_accessor :options - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. # Corresponds to the JSON property `sourceContext` # @return [Google::Apis::ServiceusageV1::SourceContext] attr_accessor :source_context @@ -135,23 +129,19 @@ module Google # @return [String] attr_accessor :syntax - # A version string for this interface. If specified, must have the form - # `major-version.minor-version`, as in `1.10`. If the minor version is - # omitted, it defaults to zero. If the entire version field is empty, the - # major version is derived from the package name, as outlined below. If the - # field is not empty, the version in the package name will be verified to be - # consistent with what is provided here. - # The versioning schema uses [semantic - # versioning](http://semver.org) where the major version number - # indicates a breaking change and the minor version an additive, - # non-breaking change. Both version numbers are signals to users - # what to expect from different versions, and should be carefully - # chosen based on the product plan. - # The major version is also reflected in the package name of the - # interface, which must end in `v`, as in - # `google.feature.v1`. For major versions 0 and 1, the suffix can - # be omitted. Zero major versions must only be used for - # experimental, non-GA interfaces. + # A version string for this interface. If specified, must have the form `major- + # version.minor-version`, as in `1.10`. If the minor version is omitted, it + # defaults to zero. If the entire version field is empty, the major version is + # derived from the package name, as outlined below. If the field is not empty, + # the version in the package name will be verified to be consistent with what is + # provided here. The versioning schema uses [semantic versioning](http://semver. + # org) where the major version number indicates a breaking change and the minor + # version an additive, non-breaking change. Both version numbers are signals to + # users what to expect from different versions, and should be carefully chosen + # based on the product plan. The major version is also reflected in the package + # name of the interface, which must end in `v`, as in `google.feature.v1`. For + # major versions 0 and 1, the suffix can be omitted. Zero major versions must + # only be used for experimental, non-GA interfaces. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -172,85 +162,63 @@ module Google end end - # Configuration for an authentication provider, including support for - # [JSON Web Token - # (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + # Configuration for an authentication provider, including support for [JSON Web + # Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). class AuthProvider include Google::Apis::Core::Hashable - # The list of JWT - # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32# - # section-4.1.3). - # that are allowed to access. A JWT containing any of these audiences will - # be accepted. When this setting is absent, JWTs with audiences: - # - "https://[service.name]/[google.protobuf.Api.name]" - # - "https://[service.name]/" - # will be accepted. - # For example, if no audiences are in the setting, LibraryService API will - # accept JWTs with the following audiences: - # - + # The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json- + # web-token-32#section-4.1.3). that are allowed to access. A JWT containing any + # of these audiences will be accepted. When this setting is absent, JWTs with + # audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[ + # service.name]/" will be accepted. For example, if no audiences are in the + # setting, LibraryService API will accept JWTs with the following audiences: - # https://library-example.googleapis.com/google.example.library.v1. - # LibraryService - # - https://library-example.googleapis.com/ - # Example: - # audiences: bookstore_android.apps.googleusercontent.com, - # bookstore_web.apps.googleusercontent.com + # LibraryService - https://library-example.googleapis.com/ Example: audiences: + # bookstore_android.apps.googleusercontent.com, bookstore_web.apps. + # googleusercontent.com # Corresponds to the JSON property `audiences` # @return [String] attr_accessor :audiences - # Redirect URL if JWT token is required but not present or is expired. - # Implement authorizationUrl of securityDefinitions in OpenAPI spec. + # Redirect URL if JWT token is required but not present or is expired. Implement + # authorizationUrl of securityDefinitions in OpenAPI spec. # Corresponds to the JSON property `authorizationUrl` # @return [String] attr_accessor :authorization_url - # The unique identifier of the auth provider. It will be referred to by - # `AuthRequirement.provider_id`. - # Example: "bookstore_auth". + # The unique identifier of the auth provider. It will be referred to by ` + # AuthRequirement.provider_id`. Example: "bookstore_auth". # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Identifies the principal that issued the JWT. See - # https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - # Usually a URL or an email address. - # Example: https://securetoken.google.com - # Example: 1234567-compute@developer.gserviceaccount.com + # Identifies the principal that issued the JWT. See https://tools.ietf.org/html/ + # draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email + # address. Example: https://securetoken.google.com Example: 1234567-compute@ + # developer.gserviceaccount.com # Corresponds to the JSON property `issuer` # @return [String] attr_accessor :issuer - # URL of the provider's public key set to validate signature of the JWT. See - # [OpenID - # Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html# - # ProviderMetadata). - # Optional if the key set document: - # - can be retrieved from - # [OpenID - # Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of - # the issuer. - # - can be inferred from the email domain of the issuer (e.g. a Google - # service account). - # Example: https://www.googleapis.com/oauth2/v1/certs + # URL of the provider's public key set to validate signature of the JWT. See [ + # OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html# + # ProviderMetadata). Optional if the key set document: - can be retrieved from [ + # OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html + # of the issuer. - can be inferred from the email domain of the issuer (e.g. a + # Google service account). Example: https://www.googleapis.com/oauth2/v1/certs # Corresponds to the JSON property `jwksUri` # @return [String] attr_accessor :jwks_uri - # Defines the locations to extract the JWT. - # JWT locations can be either from HTTP headers or URL query parameters. - # The rule is that the first match wins. The checking order is: checking - # all headers first, then URL query parameters. - # If not specified, default to use following 3 locations: - # 1) Authorization: Bearer - # 2) x-goog-iap-jwt-assertion - # 3) access_token query parameter - # Default locations can be specified as followings: - # jwt_locations: - # - header: Authorization - # value_prefix: "Bearer " - # - header: x-goog-iap-jwt-assertion - # - query: access_token + # Defines the locations to extract the JWT. JWT locations can be either from + # HTTP headers or URL query parameters. The rule is that the first match wins. + # The checking order is: checking all headers first, then URL query parameters. + # If not specified, default to use following 3 locations: 1) Authorization: + # Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default + # locations can be specified as followings: jwt_locations: - header: + # Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - + # query: access_token # Corresponds to the JSON property `jwtLocations` # @return [Array] attr_accessor :jwt_locations @@ -270,34 +238,26 @@ module Google end end - # User-defined authentication requirements, including support for - # [JSON Web Token - # (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + # User-defined authentication requirements, including support for [JSON Web + # Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). class AuthRequirement include Google::Apis::Core::Hashable - # NOTE: This will be deprecated soon, once AuthProvider.audiences is - # implemented and accepted in all the runtime components. - # The list of JWT - # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32# - # section-4.1.3). - # that are allowed to access. A JWT containing any of these audiences will - # be accepted. When this setting is absent, only JWTs with audience - # "https://Service_name/API_name" - # will be accepted. For example, if no audiences are in the setting, - # LibraryService API will only accept JWTs with the following audience - # "https://library-example.googleapis.com/google.example.library.v1. - # LibraryService". - # Example: - # audiences: bookstore_android.apps.googleusercontent.com, - # bookstore_web.apps.googleusercontent.com + # NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented + # and accepted in all the runtime components. The list of JWT [audiences](https:/ + # /tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that + # are allowed to access. A JWT containing any of these audiences will be + # accepted. When this setting is absent, only JWTs with audience "https:// + # Service_name/API_name" will be accepted. For example, if no audiences are in + # the setting, LibraryService API will only accept JWTs with the following + # audience "https://library-example.googleapis.com/google.example.library.v1. + # LibraryService". Example: audiences: bookstore_android.apps.googleusercontent. + # com, bookstore_web.apps.googleusercontent.com # Corresponds to the JSON property `audiences` # @return [String] attr_accessor :audiences - # id from authentication provider. - # Example: - # provider_id: bookstore_auth + # id from authentication provider. Example: provider_id: bookstore_auth # Corresponds to the JSON property `providerId` # @return [String] attr_accessor :provider_id @@ -313,18 +273,11 @@ module Google end end - # `Authentication` defines the authentication configuration for an API. - # Example for an API targeted for external use: - # name: calendar.googleapis.com - # authentication: - # providers: - # - id: google_calendar_auth - # jwks_uri: https://www.googleapis.com/oauth2/v1/certs - # issuer: https://securetoken.google.com - # rules: - # - selector: "*" - # requirements: - # provider_id: google_calendar_auth + # `Authentication` defines the authentication configuration for an API. Example + # for an API targeted for external use: name: calendar.googleapis.com + # authentication: providers: - id: google_calendar_auth jwks_uri: https://www. + # googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - + # selector: "*" requirements: provider_id: google_calendar_auth class Authentication include Google::Apis::Core::Hashable @@ -333,8 +286,8 @@ module Google # @return [Array] attr_accessor :providers - # A list of authentication rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of authentication rules that apply to individual API methods. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -350,13 +303,11 @@ module Google end end - # Authentication rules for the service. - # By default, if a method has any authentication requirements, every request - # must include a valid credential matching one of the requirements. - # It's an error to include more than one kind of credential in a single - # request. - # If a method doesn't have any auth requirements, request credentials will be - # ignored. + # Authentication rules for the service. By default, if a method has any + # authentication requirements, every request must include a valid credential + # matching one of the requirements. It's an error to include more than one kind + # of credential in a single request. If a method doesn't have any auth + # requirements, request credentials will be ignored. class AuthenticationRule include Google::Apis::Core::Hashable @@ -367,19 +318,18 @@ module Google alias_method :allow_without_credential?, :allow_without_credential # OAuth scopes are a way to define data and permissions on data. For example, - # there are scopes defined for "Read-only access to Google Calendar" and - # "Access to Cloud Platform". Users can consent to a scope for an application, - # giving it permission to access that data on their behalf. - # OAuth scope specifications should be fairly coarse grained; a user will need - # to see and understand the text description of what your scope means. - # In most cases: use one or at most two OAuth scopes for an entire family of - # products. If your product has multiple APIs, you should probably be sharing - # the OAuth scope across all of those APIs. - # When you need finer grained OAuth consent screens: talk with your product - # management about how developers will use them in practice. - # Please note that even though each of the canonical scopes is enough for a - # request to be accepted and passed to the backend, a request can still fail - # due to the backend requiring additional scopes or permissions. + # there are scopes defined for "Read-only access to Google Calendar" and "Access + # to Cloud Platform". Users can consent to a scope for an application, giving it + # permission to access that data on their behalf. OAuth scope specifications + # should be fairly coarse grained; a user will need to see and understand the + # text description of what your scope means. In most cases: use one or at most + # two OAuth scopes for an entire family of products. If your product has + # multiple APIs, you should probably be sharing the OAuth scope across all of + # those APIs. When you need finer grained OAuth consent screens: talk with your + # product management about how developers will use them in practice. Please note + # that even though each of the canonical scopes is enough for a request to be + # accepted and passed to the backend, a request can still fail due to the + # backend requiring additional scopes or permissions. # Corresponds to the JSON property `oauth` # @return [Google::Apis::ServiceusageV1::OAuthRequirements] attr_accessor :oauth @@ -389,8 +339,8 @@ module Google # @return [Array] attr_accessor :requirements - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -412,8 +362,8 @@ module Google class Backend include Google::Apis::Core::Hashable - # A list of API backend rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of API backend rules that apply to individual API methods. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -432,21 +382,13 @@ module Google class BackendRule include Google::Apis::Core::Hashable - # The address of the API backend. - # The scheme is used to determine the backend protocol and security. - # The following schemes are accepted: - # SCHEME PROTOCOL SECURITY - # http:// HTTP None - # https:// HTTP TLS - # grpc:// gRPC None - # grpcs:// gRPC TLS - # It is recommended to explicitly include a scheme. Leaving out the scheme - # may cause constrasting behaviors across platforms. - # If the port is unspecified, the default is: - # - 80 for schemes without TLS - # - 443 for schemes with TLS - # For HTTP backends, use protocol - # to specify the protocol version. + # The address of the API backend. The scheme is used to determine the backend + # protocol and security. The following schemes are accepted: SCHEME PROTOCOL + # SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC + # TLS It is recommended to explicitly include a scheme. Leaving out the scheme + # may cause constrasting behaviors across platforms. If the port is unspecified, + # the default is: - 80 for schemes without TLS - 443 for schemes with TLS For + # HTTP backends, use protocol to specify the protocol version. # Corresponds to the JSON property `address` # @return [String] attr_accessor :address @@ -457,18 +399,18 @@ module Google # @return [Float] attr_accessor :deadline - # When disable_auth is true, a JWT ID token won't be generated and the - # original "Authorization" HTTP header will be preserved. If the header is - # used to carry the original token and is expected by the backend, this - # field must be set to true to preserve the header. + # When disable_auth is true, a JWT ID token won't be generated and the original " + # Authorization" HTTP header will be preserved. If the header is used to carry + # the original token and is expected by the backend, this field must be set to + # true to preserve the header. # Corresponds to the JSON property `disableAuth` # @return [Boolean] attr_accessor :disable_auth alias_method :disable_auth?, :disable_auth - # The JWT audience is used when generating a JWT ID token for the backend. - # This ID token will be added in the HTTP "authorization" header, and sent - # to the backend. + # The JWT audience is used when generating a JWT ID token for the backend. This + # ID token will be added in the HTTP "authorization" header, and sent to the + # backend. # Corresponds to the JSON property `jwtAudience` # @return [String] attr_accessor :jwt_audience @@ -479,8 +421,8 @@ module Google # @return [Float] attr_accessor :min_deadline - # The number of seconds to wait for the completion of a long running - # operation. The default is no deadline. + # The number of seconds to wait for the completion of a long running operation. + # The default is no deadline. # Corresponds to the JSON property `operationDeadline` # @return [Float] attr_accessor :operation_deadline @@ -490,29 +432,21 @@ module Google # @return [String] attr_accessor :path_translation - # The protocol used for sending a request to the backend. - # The supported values are "http/1.1" and "h2". - # The default value is inferred from the scheme in the - # address field: - # SCHEME PROTOCOL - # http:// http/1.1 - # https:// http/1.1 - # grpc:// h2 - # grpcs:// h2 - # For secure HTTP backends (https://) that support HTTP/2, set this field - # to "h2" for improved performance. - # Configuring this field to non-default values is only supported for secure - # HTTP backends. This field will be ignored for all other backends. - # See - # https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype- - # values.xhtml#alpn-protocol-ids - # for more details on the supported values. + # The protocol used for sending a request to the backend. The supported values + # are "http/1.1" and "h2". The default value is inferred from the scheme in the + # address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 + # grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this + # field to "h2" for improved performance. Configuring this field to non-default + # values is only supported for secure HTTP backends. This field will be ignored + # for all other backends. See https://www.iana.org/assignments/tls-extensiontype- + # values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on + # the supported values. # Corresponds to the JSON property `protocol` # @return [String] attr_accessor :protocol - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -577,14 +511,11 @@ module Google class BatchEnableServicesRequest include Google::Apis::Core::Hashable - # The identifiers of the services to enable on the project. - # A valid identifier would be: - # serviceusage.googleapis.com - # Enabling services requires that each service is public or is shared with - # the user enabling the service. - # A single request can enable a maximum of 20 services at a time. If more - # than 20 services are specified, the request will fail, and no state changes - # will occur. + # The identifiers of the services to enable on the project. A valid identifier + # would be: serviceusage.googleapis.com Enabling services requires that each + # service is public or is shared with the user enabling the service. A single + # request can enable a maximum of 20 services at a time. If more than 20 + # services are specified, the request will fail, and no state changes will occur. # Corresponds to the JSON property `serviceIds` # @return [Array] attr_accessor :service_ids @@ -599,9 +530,9 @@ module Google end end - # Response message for the `BatchEnableServices` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `BatchEnableServices` method. This response message + # is assigned to the `response` field of the returned Operation when that + # operation is done. class BatchEnableServicesResponse include Google::Apis::Core::Hashable @@ -646,42 +577,28 @@ module Google end end - # Billing related configuration of the service. - # The following example shows how to configure monitored resources and metrics - # for billing, `consumer_destinations` is the only supported destination and - # the monitored resources need at least one label key - # `cloud.googleapis.com/location` to indicate the location of the billing - # usage, using different monitored resources between monitoring and billing is - # recommended so they can be evolved independently: - # monitored_resources: - # - type: library.googleapis.com/billing_branch - # labels: - # - key: cloud.googleapis.com/location - # description: | - # Predefined label to support billing location restriction. - # - key: city - # description: | - # Custom label to define the city where the library branch is located - # in. - # - key: name - # description: Custom label to define the name of the library branch. - # metrics: - # - name: library.googleapis.com/book/borrowed_count - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # billing: - # consumer_destinations: - # - monitored_resource: library.googleapis.com/billing_branch - # metrics: - # - library.googleapis.com/book/borrowed_count + # Billing related configuration of the service. The following example shows how + # to configure monitored resources and metrics for billing, ` + # consumer_destinations` is the only supported destination and the monitored + # resources need at least one label key `cloud.googleapis.com/location` to + # indicate the location of the billing usage, using different monitored + # resources between monitoring and billing is recommended so they can be evolved + # independently: monitored_resources: - type: library.googleapis.com/ + # billing_branch labels: - key: cloud.googleapis.com/location description: | + # Predefined label to support billing location restriction. - key: city + # description: | Custom label to define the city where the library branch is + # located in. - key: name description: Custom label to define the name of the + # library branch. metrics: - name: library.googleapis.com/book/borrowed_count + # metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: + # - monitored_resource: library.googleapis.com/billing_branch metrics: - library. + # googleapis.com/book/borrowed_count class Billing include Google::Apis::Core::Hashable - # Billing configurations for sending metrics to the consumer project. - # There can be multiple consumer destinations per service, each one must have - # a different monitored resource type. A metric can be used in at most - # one consumer destination. + # Billing configurations for sending metrics to the consumer project. There can + # be multiple consumer destinations per service, each one must have a different + # monitored resource type. A metric can be used in at most one consumer + # destination. # Corresponds to the JSON property `consumerDestinations` # @return [Array] attr_accessor :consumer_destinations @@ -696,19 +613,19 @@ module Google end end - # Configuration of a specific billing destination (Currently only support - # bill against consumer project). + # Configuration of a specific billing destination (Currently only support bill + # against consumer project). class BillingDestination include Google::Apis::Core::Hashable - # Names of the metrics to report to this billing destination. - # Each name must be defined in Service.metrics section. + # Names of the metrics to report to this billing destination. Each name must be + # defined in Service.metrics section. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics - # The monitored resource type. The type must be defined in - # Service.monitored_resources section. + # The monitored resource type. The type must be defined in Service. + # monitored_resources section. # Corresponds to the JSON property `monitoredResource` # @return [String] attr_accessor :monitored_resource @@ -737,39 +654,24 @@ module Google end end - # `Context` defines which contexts an API requests. - # Example: - # context: - # rules: - # - selector: "*" - # requested: - # - google.rpc.context.ProjectContext - # - google.rpc.context.OriginContext - # The above specifies that all methods in the API request - # `google.rpc.context.ProjectContext` and - # `google.rpc.context.OriginContext`. - # Available context types are defined in package - # `google.rpc.context`. - # This also provides mechanism to whitelist any protobuf message extension that - # can be sent in grpc metadata using “x-goog-ext--bin” and - # “x-goog-ext--jspb” format. For example, list any service - # specific protobuf types that can appear in grpc metadata as follows in your - # yaml file: - # Example: - # context: - # rules: - # - selector: "google.example.library.v1.LibraryService.CreateBook" - # allowed_request_extensions: - # - google.foo.v1.NewExtension - # allowed_response_extensions: - # - google.foo.v1.NewExtension - # You can also specify extension ID instead of fully qualified extension name - # here. + # `Context` defines which contexts an API requests. Example: context: rules: - + # selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc. + # context.OriginContext The above specifies that all methods in the API request ` + # google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. + # Available context types are defined in package `google.rpc.context`. This also + # provides mechanism to whitelist any protobuf message extension that can be + # sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. + # For example, list any service specific protobuf types that can appear in grpc + # metadata as follows in your yaml file: Example: context: rules: - selector: " + # google.example.library.v1.LibraryService.CreateBook" + # allowed_request_extensions: - google.foo.v1.NewExtension + # allowed_response_extensions: - google.foo.v1.NewExtension You can also specify + # extension ID instead of fully qualified extension name here. class Context include Google::Apis::Core::Hashable - # A list of RPC context rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of RPC context rules that apply to individual API methods. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -789,14 +691,14 @@ module Google class ContextRule include Google::Apis::Core::Hashable - # A list of full type names or extension IDs of extensions allowed in grpc - # side channel from client to backend. + # A list of full type names or extension IDs of extensions allowed in grpc side + # channel from client to backend. # Corresponds to the JSON property `allowedRequestExtensions` # @return [Array] attr_accessor :allowed_request_extensions - # A list of full type names or extension IDs of extensions allowed in grpc - # side channel from backend to client. + # A list of full type names or extension IDs of extensions allowed in grpc side + # channel from backend to client. # Corresponds to the JSON property `allowedResponseExtensions` # @return [Array] attr_accessor :allowed_response_extensions @@ -811,8 +713,8 @@ module Google # @return [Array] attr_accessor :requested - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -831,14 +733,14 @@ module Google end end - # Selects and configures the service controller used by the service. The - # service controller handles features like abuse, quota, billing, logging, - # monitoring, etc. + # Selects and configures the service controller used by the service. The service + # controller handles features like abuse, quota, billing, logging, monitoring, + # etc. class Control include Google::Apis::Core::Hashable - # The service control environment to use. If empty, no control plane - # feature (like quota and billing) will be enabled. + # The service control environment to use. If empty, no control plane feature ( + # like quota and billing) will be enabled. # Corresponds to the JSON property `environment` # @return [String] attr_accessor :environment @@ -853,19 +755,15 @@ module Google end end - # Customize service error responses. For example, list any service - # specific protobuf types that can appear in error detail lists of - # error responses. - # Example: - # custom_error: - # types: - # - google.foo.v1.CustomError - # - google.foo.v1.AnotherError + # Customize service error responses. For example, list any service specific + # protobuf types that can appear in error detail lists of error responses. + # Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1. + # AnotherError class CustomError include Google::Apis::Core::Hashable - # The list of custom error rules that apply to individual API messages. - # **NOTE:** All service configuration rules follow "last one wins" order. + # The list of custom error rules that apply to individual API messages. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -890,15 +788,15 @@ module Google class CustomErrorRule include Google::Apis::Core::Hashable - # Mark this message as possible payload in error response. Otherwise, - # objects of this type will be filtered when they appear in error payload. + # Mark this message as possible payload in error response. Otherwise, objects of + # this type will be filtered when they appear in error payload. # Corresponds to the JSON property `isErrorType` # @return [Boolean] attr_accessor :is_error_type alias_method :is_error_type?, :is_error_type - # Selects messages to which this rule applies. - # Refer to selector for syntax details. + # Selects messages to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -948,11 +846,10 @@ module Google # @return [String] attr_accessor :check_if_service_has_usage - # Indicates if services that are enabled and which depend on this service - # should also be disabled. If not set, an error will be generated if any - # enabled services depend on the service to be disabled. When set, the - # service, and any enabled services that depend on it, will be disabled - # together. + # Indicates if services that are enabled and which depend on this service should + # also be disabled. If not set, an error will be generated if any enabled + # services depend on the service to be disabled. When set, the service, and any + # enabled services that depend on it, will be disabled together. # Corresponds to the JSON property `disableDependentServices` # @return [Boolean] attr_accessor :disable_dependent_services @@ -969,9 +866,9 @@ module Google end end - # Response message for the `DisableService` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `DisableService` method. This response message is + # assigned to the `response` field of the returned Operation when that operation + # is done. class DisableServiceResponse include Google::Apis::Core::Hashable @@ -990,56 +887,32 @@ module Google end end - # `Documentation` provides the information for describing a service. - # Example: - # 
documentation:
-      # summary: >
-      # The Google Calendar API gives access
-      # to most calendar features.
-      # pages:
-      # - name: Overview
-      # content: (== include google/foo/overview.md ==)
-      # - name: Tutorial
-      # content: (== include google/foo/tutorial.md ==)
-      # subpages;
-      # - name: Java
-      # content: (== include google/foo/tutorial_java.md ==)
-      # rules:
-      # - selector: google.calendar.Calendar.Get
-      # description: >
-      # ...
-      # - selector: google.calendar.Calendar.Put
-      # description: >
-      # ...
-      #
- # Documentation is provided in markdown syntax. In addition to - # standard markdown features, definition lists, tables and fenced - # code blocks are supported. Section headers can be provided and are - # interpreted relative to the section nesting of the context where - # a documentation fragment is embedded. - # Documentation from the IDL is merged with documentation defined - # via the config at normalization time, where documentation provided - # by config rules overrides IDL provided. - # A number of constructs specific to the API platform are supported - # in documentation text. - # In order to reference a proto element, the following - # notation can be used: - # 
[fully.qualified.proto.name][]
- # To override the display text used for the link, this can be used: - # 
[display text][fully.qualified.proto.name]
- # Text can be excluded from doc using the following notation: - # 
(-- internal comment --)
- # A few directives are available in documentation. Note that - # directives must appear on a single line to be properly - # identified. The `include` directive includes a markdown file from - # an external source: - # 
(== include path/to/file ==)
- # The `resource_for` directive marks a message to be the resource of - # a collection in REST view. If it is not specified, tools attempt - # to infer the resource from the operations in a collection: - # 
(== resource_for v1.shelves.books ==)
- # The directive `suppress_warning` does not directly affect documentation - # and is documented together with service config validation. + # `Documentation` provides the information for describing a service. Example: + # documentation: summary: > The Google Calendar API gives access to most + # calendar features. pages: - name: Overview content: (== include google/foo/ + # overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md == + # ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==) + # rules: - selector: google.calendar.Calendar.Get description: > ... - selector: + # google.calendar.Calendar.Put description: > ... Documentation is provided in + # markdown syntax. In addition to standard markdown features, definition lists, + # tables and fenced code blocks are supported. Section headers can be provided + # and are interpreted relative to the section nesting of the context where a + # documentation fragment is embedded. Documentation from the IDL is merged with + # documentation defined via the config at normalization time, where + # documentation provided by config rules overrides IDL provided. A number of + # constructs specific to the API platform are supported in documentation text. + # In order to reference a proto element, the following notation can be used: [ + # fully.qualified.proto.name][] To override the display text used for the link, + # this can be used: [display text][fully.qualified.proto.name] Text can be + # excluded from doc using the following notation: (-- internal comment --) A few + # directives are available in documentation. Note that directives must appear on + # a single line to be properly identified. The `include` directive includes a + # markdown file from an external source: (== include path/to/file ==) The ` + # resource_for` directive marks a message to be the resource of a collection in + # REST view. If it is not specified, tools attempt to infer the resource from + # the operations in a collection: (== resource_for v1.shelves.books ==) The + # directive `suppress_warning` does not directly affect documentation and is + # documented together with service config validation. class Documentation include Google::Apis::Core::Hashable @@ -1048,19 +921,11 @@ module Google # @return [String] attr_accessor :documentation_root_url - # Declares a single overview page. For example: - # 
documentation:
-        # summary: ...
-        # overview: (== include overview.md ==)
-        #
- # This is a shortcut for the following declaration (using pages style): - # 
documentation:
-        # summary: ...
-        # pages:
-        # - name: Overview
-        # content: (== include overview.md ==)
-        #
- # Note: you cannot specify both `overview` field and `pages` field. + # Declares a single overview page. For example: documentation: summary: ... + # overview: (== include overview.md ==) This is a shortcut for the following + # declaration (using pages style): documentation: summary: ... pages: - name: + # Overview content: (== include overview.md ==) Note: you cannot specify both ` + # overview` field and `pages` field. # Corresponds to the JSON property `overview` # @return [String] attr_accessor :overview @@ -1070,22 +935,20 @@ module Google # @return [Array] attr_accessor :pages - # A list of documentation rules that apply to individual API elements. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of documentation rules that apply to individual API elements. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules - # Specifies the service root url if the default one (the service name - # from the yaml file) is not suitable. This can be seen in any fully - # specified service urls as well as sections that show a base that other - # urls are relative to. + # Specifies the service root url if the default one (the service name from the + # yaml file) is not suitable. This can be seen in any fully specified service + # urls as well as sections that show a base that other urls are relative to. # Corresponds to the JSON property `serviceRootUrl` # @return [String] attr_accessor :service_root_url - # A short summary of what the service does. Can only be provided by - # plain text. + # A short summary of what the service does. Can only be provided by plain text. # Corresponds to the JSON property `summary` # @return [String] attr_accessor :summary @@ -1109,8 +972,8 @@ module Google class DocumentationRule include Google::Apis::Core::Hashable - # Deprecation description of the selected element(s). It can be provided if - # an element is marked as `deprecated`. + # Deprecation description of the selected element(s). It can be provided if an + # element is marked as `deprecated`. # Corresponds to the JSON property `deprecationDescription` # @return [String] attr_accessor :deprecation_description @@ -1142,13 +1005,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 @@ -1199,9 +1060,9 @@ module Google end end - # Response message for the `EnableService` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `EnableService` method. This response message is + # assigned to the `response` field of the returned Operation when that operation + # is done. class EnableServiceResponse include Google::Apis::Core::Hashable @@ -1220,35 +1081,28 @@ module Google end end - # `Endpoint` describes a network endpoint that serves a set of APIs. - # A service may expose any number of endpoints, and all endpoints share the - # same service configuration, such as quota configuration and monitoring - # configuration. - # Example service configuration: - # name: library-example.googleapis.com - # endpoints: - # # Below entry makes 'google.example.library.v1.Library' - # # API be served from endpoint address library-example.googleapis.com. - # # It also allows HTTP OPTIONS calls to be passed to the backend, for - # # it to decide whether the subsequent cross-origin request is - # # allowed to proceed. - # - name: library-example.googleapis.com - # allow_cors: true + # `Endpoint` describes a network endpoint that serves a set of APIs. A service + # may expose any number of endpoints, and all endpoints share the same service + # configuration, such as quota configuration and monitoring configuration. + # Example service configuration: name: library-example.googleapis.com endpoints: + # # Below entry makes 'google.example.library.v1.Library' # API be served from + # endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS + # calls to be passed to the backend, for # it to decide whether the subsequent + # cross-origin request is # allowed to proceed. - name: library-example. + # googleapis.com allow_cors: true class Endpoint include Google::Apis::Core::Hashable # DEPRECATED: This field is no longer supported. Instead of using aliases, - # please specify multiple google.api.Endpoint for each of the intended - # aliases. + # please specify multiple google.api.Endpoint for each of the intended aliases. # Additional names that this endpoint will be hosted on. # Corresponds to the JSON property `aliases` # @return [Array] attr_accessor :aliases - # Allowing - # [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka - # cross-domain traffic, would allow the backends served from this endpoint to - # receive and respond to HTTP OPTIONS requests. The response will be used by + # Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), + # aka cross-domain traffic, would allow the backends served from this endpoint + # to receive and respond to HTTP OPTIONS requests. The response will be used by # the browser to determine whether the subsequent cross-origin request is # allowed to proceed. # Corresponds to the JSON property `allowCors` @@ -1262,10 +1116,9 @@ module Google attr_accessor :name # The specification of an Internet routable address of API frontend that will - # handle requests to this [API - # Endpoint](https://cloud.google.com/apis/design/glossary). It should be - # either a valid IPv4 address or a fully-qualified domain name. For example, - # "8.8.8.8" or "myservice.appspot.com". + # handle requests to this [API Endpoint](https://cloud.google.com/apis/design/ + # glossary). It should be either a valid IPv4 address or a fully-qualified + # domain name. For example, "8.8.8.8" or "myservice.appspot.com". # Corresponds to the JSON property `target` # @return [String] attr_accessor :target @@ -1302,8 +1155,8 @@ module Google # @return [Array] attr_accessor :options - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. # Corresponds to the JSON property `sourceContext` # @return [Google::Apis::ServiceusageV1::SourceContext] attr_accessor :source_context @@ -1392,8 +1245,8 @@ module Google # @return [Fixnum] attr_accessor :number - # The index of the field type in `Type.oneofs`, for message or enumeration - # types. The first type has index 1; zero means the type is not in the list. + # The index of the field type in `Type.oneofs`, for message or enumeration types. + # The first type has index 1; zero means the type is not in the list. # Corresponds to the JSON property `oneofIndex` # @return [Fixnum] attr_accessor :oneof_index @@ -1409,8 +1262,8 @@ module Google attr_accessor :packed alias_method :packed?, :packed - # The field type URL, without the scheme, for message or enumeration - # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + # The field type URL, without the scheme, for message or enumeration types. + # Example: `"type.googleapis.com/google.protobuf.Timestamp"`. # Corresponds to the JSON property `typeUrl` # @return [String] attr_accessor :type_url @@ -1461,50 +1314,32 @@ module Google end # `Service` is the root object of Google service configuration schema. It - # describes basic information about a service, such as the name and the - # title, and delegates other aspects to sub-sections. Each sub-section is - # either a proto message or a repeated proto message that configures a - # specific aspect, such as auth. See each proto message definition for details. - # Example: - # type: google.api.Service - # config_version: 3 - # name: calendar.googleapis.com - # title: Google Calendar API - # apis: - # - name: google.calendar.v3.Calendar - # authentication: - # providers: - # - id: google_calendar_auth - # jwks_uri: https://www.googleapis.com/oauth2/v1/certs - # issuer: https://securetoken.google.com - # rules: - # - selector: "*" - # requirements: - # provider_id: google_calendar_auth + # describes basic information about a service, such as the name and the title, + # and delegates other aspects to sub-sections. Each sub-section is either a + # proto message or a repeated proto message that configures a specific aspect, + # such as auth. See each proto message definition for details. Example: type: + # google.api.Service config_version: 3 name: calendar.googleapis.com title: + # Google Calendar API apis: - name: google.calendar.v3.Calendar authentication: + # providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/ + # oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" + # requirements: provider_id: google_calendar_auth class GoogleApiService include Google::Apis::Core::Hashable - # A list of API interfaces exported by this service. Only the `name` field - # of the google.protobuf.Api needs to be provided by the configuration - # author, as the remaining fields will be derived from the IDL during the - # normalization process. It is an error to specify an API interface here - # which cannot be resolved against the associated IDL files. + # A list of API interfaces exported by this service. Only the `name` field of + # the google.protobuf.Api needs to be provided by the configuration author, as + # the remaining fields will be derived from the IDL during the normalization + # process. It is an error to specify an API interface here which cannot be + # resolved against the associated IDL files. # Corresponds to the JSON property `apis` # @return [Array] attr_accessor :apis - # `Authentication` defines the authentication configuration for an API. - # Example for an API targeted for external use: - # name: calendar.googleapis.com - # authentication: - # providers: - # - id: google_calendar_auth - # jwks_uri: https://www.googleapis.com/oauth2/v1/certs - # issuer: https://securetoken.google.com - # rules: - # - selector: "*" - # requirements: - # provider_id: google_calendar_auth + # `Authentication` defines the authentication configuration for an API. Example + # for an API targeted for external use: name: calendar.googleapis.com + # authentication: providers: - id: google_calendar_auth jwks_uri: https://www. + # googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - + # selector: "*" requirements: provider_id: google_calendar_auth # Corresponds to the JSON property `authentication` # @return [Google::Apis::ServiceusageV1::Authentication] attr_accessor :authentication @@ -1514,211 +1349,136 @@ module Google # @return [Google::Apis::ServiceusageV1::Backend] attr_accessor :backend - # Billing related configuration of the service. - # The following example shows how to configure monitored resources and metrics - # for billing, `consumer_destinations` is the only supported destination and - # the monitored resources need at least one label key - # `cloud.googleapis.com/location` to indicate the location of the billing - # usage, using different monitored resources between monitoring and billing is - # recommended so they can be evolved independently: - # monitored_resources: - # - type: library.googleapis.com/billing_branch - # labels: - # - key: cloud.googleapis.com/location - # description: | - # Predefined label to support billing location restriction. - # - key: city - # description: | - # Custom label to define the city where the library branch is located - # in. - # - key: name - # description: Custom label to define the name of the library branch. - # metrics: - # - name: library.googleapis.com/book/borrowed_count - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # billing: - # consumer_destinations: - # - monitored_resource: library.googleapis.com/billing_branch - # metrics: - # - library.googleapis.com/book/borrowed_count + # Billing related configuration of the service. The following example shows how + # to configure monitored resources and metrics for billing, ` + # consumer_destinations` is the only supported destination and the monitored + # resources need at least one label key `cloud.googleapis.com/location` to + # indicate the location of the billing usage, using different monitored + # resources between monitoring and billing is recommended so they can be evolved + # independently: monitored_resources: - type: library.googleapis.com/ + # billing_branch labels: - key: cloud.googleapis.com/location description: | + # Predefined label to support billing location restriction. - key: city + # description: | Custom label to define the city where the library branch is + # located in. - key: name description: Custom label to define the name of the + # library branch. metrics: - name: library.googleapis.com/book/borrowed_count + # metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: + # - monitored_resource: library.googleapis.com/billing_branch metrics: - library. + # googleapis.com/book/borrowed_count # Corresponds to the JSON property `billing` # @return [Google::Apis::ServiceusageV1::Billing] attr_accessor :billing - # The semantic version of the service configuration. The config version - # affects the interpretation of the service configuration. For example, - # certain features are enabled by default for certain config versions. - # The latest config version is `3`. + # The semantic version of the service configuration. The config version affects + # the interpretation of the service configuration. For example, certain features + # are enabled by default for certain config versions. The latest config version + # is `3`. # Corresponds to the JSON property `configVersion` # @return [Fixnum] attr_accessor :config_version - # `Context` defines which contexts an API requests. - # Example: - # context: - # rules: - # - selector: "*" - # requested: - # - google.rpc.context.ProjectContext - # - google.rpc.context.OriginContext - # The above specifies that all methods in the API request - # `google.rpc.context.ProjectContext` and - # `google.rpc.context.OriginContext`. - # Available context types are defined in package - # `google.rpc.context`. - # This also provides mechanism to whitelist any protobuf message extension that - # can be sent in grpc metadata using “x-goog-ext--bin” and - # “x-goog-ext--jspb” format. For example, list any service - # specific protobuf types that can appear in grpc metadata as follows in your - # yaml file: - # Example: - # context: - # rules: - # - selector: "google.example.library.v1.LibraryService.CreateBook" - # allowed_request_extensions: - # - google.foo.v1.NewExtension - # allowed_response_extensions: - # - google.foo.v1.NewExtension - # You can also specify extension ID instead of fully qualified extension name - # here. + # `Context` defines which contexts an API requests. Example: context: rules: - + # selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc. + # context.OriginContext The above specifies that all methods in the API request ` + # google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. + # Available context types are defined in package `google.rpc.context`. This also + # provides mechanism to whitelist any protobuf message extension that can be + # sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. + # For example, list any service specific protobuf types that can appear in grpc + # metadata as follows in your yaml file: Example: context: rules: - selector: " + # google.example.library.v1.LibraryService.CreateBook" + # allowed_request_extensions: - google.foo.v1.NewExtension + # allowed_response_extensions: - google.foo.v1.NewExtension You can also specify + # extension ID instead of fully qualified extension name here. # Corresponds to the JSON property `context` # @return [Google::Apis::ServiceusageV1::Context] attr_accessor :context - # Selects and configures the service controller used by the service. The - # service controller handles features like abuse, quota, billing, logging, - # monitoring, etc. + # Selects and configures the service controller used by the service. The service + # controller handles features like abuse, quota, billing, logging, monitoring, + # etc. # Corresponds to the JSON property `control` # @return [Google::Apis::ServiceusageV1::Control] attr_accessor :control - # Customize service error responses. For example, list any service - # specific protobuf types that can appear in error detail lists of - # error responses. - # Example: - # custom_error: - # types: - # - google.foo.v1.CustomError - # - google.foo.v1.AnotherError + # Customize service error responses. For example, list any service specific + # protobuf types that can appear in error detail lists of error responses. + # Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1. + # AnotherError # Corresponds to the JSON property `customError` # @return [Google::Apis::ServiceusageV1::CustomError] attr_accessor :custom_error - # `Documentation` provides the information for describing a service. - # Example: - # 
documentation:
-        # summary: >
-        # The Google Calendar API gives access
-        # to most calendar features.
-        # pages:
-        # - name: Overview
-        # content: (== include google/foo/overview.md ==)
-        # - name: Tutorial
-        # content: (== include google/foo/tutorial.md ==)
-        # subpages;
-        # - name: Java
-        # content: (== include google/foo/tutorial_java.md ==)
-        # rules:
-        # - selector: google.calendar.Calendar.Get
-        # description: >
-        # ...
-        # - selector: google.calendar.Calendar.Put
-        # description: >
-        # ...
-        #
- # Documentation is provided in markdown syntax. In addition to - # standard markdown features, definition lists, tables and fenced - # code blocks are supported. Section headers can be provided and are - # interpreted relative to the section nesting of the context where - # a documentation fragment is embedded. - # Documentation from the IDL is merged with documentation defined - # via the config at normalization time, where documentation provided - # by config rules overrides IDL provided. - # A number of constructs specific to the API platform are supported - # in documentation text. - # In order to reference a proto element, the following - # notation can be used: - # 
[fully.qualified.proto.name][]
- # To override the display text used for the link, this can be used: - # 
[display text][fully.qualified.proto.name]
- # Text can be excluded from doc using the following notation: - # 
(-- internal comment --)
- # A few directives are available in documentation. Note that - # directives must appear on a single line to be properly - # identified. The `include` directive includes a markdown file from - # an external source: - # 
(== include path/to/file ==)
- # The `resource_for` directive marks a message to be the resource of - # a collection in REST view. If it is not specified, tools attempt - # to infer the resource from the operations in a collection: - # 
(== resource_for v1.shelves.books ==)
- # The directive `suppress_warning` does not directly affect documentation - # and is documented together with service config validation. + # `Documentation` provides the information for describing a service. Example: + # documentation: summary: > The Google Calendar API gives access to most + # calendar features. pages: - name: Overview content: (== include google/foo/ + # overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md == + # ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==) + # rules: - selector: google.calendar.Calendar.Get description: > ... - selector: + # google.calendar.Calendar.Put description: > ... Documentation is provided in + # markdown syntax. In addition to standard markdown features, definition lists, + # tables and fenced code blocks are supported. Section headers can be provided + # and are interpreted relative to the section nesting of the context where a + # documentation fragment is embedded. Documentation from the IDL is merged with + # documentation defined via the config at normalization time, where + # documentation provided by config rules overrides IDL provided. A number of + # constructs specific to the API platform are supported in documentation text. + # In order to reference a proto element, the following notation can be used: [ + # fully.qualified.proto.name][] To override the display text used for the link, + # this can be used: [display text][fully.qualified.proto.name] Text can be + # excluded from doc using the following notation: (-- internal comment --) A few + # directives are available in documentation. Note that directives must appear on + # a single line to be properly identified. The `include` directive includes a + # markdown file from an external source: (== include path/to/file ==) The ` + # resource_for` directive marks a message to be the resource of a collection in + # REST view. If it is not specified, tools attempt to infer the resource from + # the operations in a collection: (== resource_for v1.shelves.books ==) The + # directive `suppress_warning` does not directly affect documentation and is + # documented together with service config validation. # Corresponds to the JSON property `documentation` # @return [Google::Apis::ServiceusageV1::Documentation] attr_accessor :documentation - # Configuration for network endpoints. If this is empty, then an endpoint - # with the same name as the service is automatically generated to service all - # defined APIs. + # Configuration for network endpoints. If this is empty, then an endpoint with + # the same name as the service is automatically generated to service all defined + # APIs. # Corresponds to the JSON property `endpoints` # @return [Array] attr_accessor :endpoints - # A list of all enum types included in this API service. Enums - # referenced directly or indirectly by the `apis` are automatically - # included. Enums which are not referenced but shall be included - # should be listed here by name. Example: - # enums: - # - name: google.someapi.v1.SomeEnum + # A list of all enum types included in this API service. Enums referenced + # directly or indirectly by the `apis` are automatically included. Enums which + # are not referenced but shall be included should be listed here by name. + # Example: enums: - name: google.someapi.v1.SomeEnum # Corresponds to the JSON property `enums` # @return [Array] attr_accessor :enums # Defines the HTTP configuration for an API service. It contains a list of - # HttpRule, each specifying the mapping of an RPC method - # to one or more HTTP REST API methods. + # HttpRule, each specifying the mapping of an RPC method to one or more HTTP + # REST API methods. # Corresponds to the JSON property `http` # @return [Google::Apis::ServiceusageV1::Http] attr_accessor :http - # A unique ID for a specific instance of this message, typically assigned - # by the client for tracking purpose. Must be no longer than 63 characters - # and only lower case letters, digits, '.', '_' and '-' are allowed. If - # empty, the server may choose to generate one instead. + # A unique ID for a specific instance of this message, typically assigned by the + # client for tracking purpose. Must be no longer than 63 characters and only + # lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server + # may choose to generate one instead. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Logging configuration of the service. - # The following example shows how to configure logs to be sent to the - # producer and consumer projects. In the example, the `activity_history` - # log is sent to both the producer and consumer projects, whereas the - # `purchase_history` log is only sent to the producer project. - # monitored_resources: - # - type: library.googleapis.com/branch - # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. - # logs: - # - name: activity_history - # labels: - # - key: /customer_id - # - name: purchase_history - # logging: - # producer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history - # - purchase_history - # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history + # Logging configuration of the service. The following example shows how to + # configure logs to be sent to the producer and consumer projects. In the + # example, the `activity_history` log is sent to both the producer and consumer + # projects, whereas the `purchase_history` log is only sent to the producer + # project. monitored_resources: - type: library.googleapis.com/branch labels: - + # key: /city description: The city where the library branch is located in. - key: + # /name description: The name of the branch. logs: - name: activity_history + # labels: - key: /customer_id - name: purchase_history logging: + # producer_destinations: - monitored_resource: library.googleapis.com/branch + # logs: - activity_history - purchase_history consumer_destinations: - + # monitored_resource: library.googleapis.com/branch logs: - activity_history # Corresponds to the JSON property `logging` # @return [Google::Apis::ServiceusageV1::Logging] attr_accessor :logging @@ -1733,70 +1493,41 @@ module Google # @return [Array] attr_accessor :metrics - # Defines the monitored resources used by this service. This is required - # by the Service.monitoring and Service.logging configurations. + # Defines the monitored resources used by this service. This is required by the + # Service.monitoring and Service.logging configurations. # Corresponds to the JSON property `monitoredResources` # @return [Array] attr_accessor :monitored_resources - # Monitoring configuration of the service. - # The example below shows how to configure monitored resources and metrics - # for monitoring. In the example, a monitored resource and two metrics are - # defined. The `library.googleapis.com/book/returned_count` metric is sent - # to both producer and consumer projects, whereas the - # `library.googleapis.com/book/num_overdue` metric is only sent to the - # consumer project. - # monitored_resources: - # - type: library.googleapis.com/Branch - # display_name: "Library Branch" - # description: "A branch of a library." - # launch_stage: GA - # labels: - # - key: resource_container - # description: "The Cloud container (ie. project id) for the Branch." - # - key: location - # description: "The location of the library branch." - # - key: branch_id - # description: "The id of the branch." - # metrics: - # - name: library.googleapis.com/book/returned_count - # display_name: "Books Returned" - # description: "The count of books that have been returned." - # launch_stage: GA - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # - name: library.googleapis.com/book/num_overdue - # display_name: "Books Overdue" - # description: "The current number of overdue books." - # launch_stage: GA - # metric_kind: GAUGE - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # monitoring: - # producer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # consumer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # - library.googleapis.com/book/num_overdue + # Monitoring configuration of the service. The example below shows how to + # configure monitored resources and metrics for monitoring. In the example, a + # monitored resource and two metrics are defined. The `library.googleapis.com/ + # book/returned_count` metric is sent to both producer and consumer projects, + # whereas the `library.googleapis.com/book/num_overdue` metric is only sent to + # the consumer project. monitored_resources: - type: library.googleapis.com/ + # Branch display_name: "Library Branch" description: "A branch of a library." + # launch_stage: GA labels: - key: resource_container description: "The Cloud + # container (ie. project id) for the Branch." - key: location description: "The + # location of the library branch." - key: branch_id description: "The id of the + # branch." metrics: - name: library.googleapis.com/book/returned_count + # display_name: "Books Returned" description: "The count of books that have been + # returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" + # labels: - key: customer_id description: "The id of the customer." - name: + # library.googleapis.com/book/num_overdue display_name: "Books Overdue" + # description: "The current number of overdue books." launch_stage: GA + # metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id + # description: "The id of the customer." monitoring: producer_destinations: - + # monitored_resource: library.googleapis.com/Branch metrics: - library. + # googleapis.com/book/returned_count consumer_destinations: - monitored_resource: + # library.googleapis.com/Branch metrics: - library.googleapis.com/book/ + # returned_count - library.googleapis.com/book/num_overdue # Corresponds to the JSON property `monitoring` # @return [Google::Apis::ServiceusageV1::Monitoring] attr_accessor :monitoring - # The service name, which is a DNS-like logical identifier for the - # service, such as `calendar.googleapis.com`. The service name - # typically goes through DNS verification to make sure the owner - # of the service also owns the DNS name. + # The service name, which is a DNS-like logical identifier for the service, such + # as `calendar.googleapis.com`. The service name typically goes through DNS + # verification to make sure the owner of the service also owns the DNS name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1806,46 +1537,25 @@ module Google # @return [String] attr_accessor :producer_project_id - # Quota configuration helps to achieve fairness and budgeting in service - # usage. - # The metric based quota configuration works this way: - # - The service configuration defines a set of metrics. - # - For API calls, the quota.metric_rules maps methods to metrics with - # corresponding costs. - # - The quota.limits defines limits on the metrics, which will be used for - # quota checks at runtime. - # An example quota configuration in yaml format: - # quota: - # limits: - # - name: apiWriteQpsPerProject - # metric: library.googleapis.com/write_calls - # unit: "1/min/`project`" # rate limit for consumer projects - # values: - # STANDARD: 10000 - # # The metric rules bind all methods to the read_calls metric, - # # except for the UpdateBook and DeleteBook methods. These two methods - # # are mapped to the write_calls metric, with the UpdateBook method - # # consuming at twice rate as the DeleteBook method. - # metric_rules: - # - selector: "*" - # metric_costs: - # library.googleapis.com/read_calls: 1 - # - selector: google.example.library.v1.LibraryService.UpdateBook - # metric_costs: - # library.googleapis.com/write_calls: 2 - # - selector: google.example.library.v1.LibraryService.DeleteBook - # metric_costs: - # library.googleapis.com/write_calls: 1 - # Corresponding Metric definition: - # metrics: - # - name: library.googleapis.com/read_calls - # display_name: Read requests - # metric_kind: DELTA - # value_type: INT64 - # - name: library.googleapis.com/write_calls - # display_name: Write requests - # metric_kind: DELTA - # value_type: INT64 + # Quota configuration helps to achieve fairness and budgeting in service usage. + # The metric based quota configuration works this way: - The service + # configuration defines a set of metrics. - For API calls, the quota. + # metric_rules maps methods to metrics with corresponding costs. - The quota. + # limits defines limits on the metrics, which will be used for quota checks at + # runtime. An example quota configuration in yaml format: quota: limits: - name: + # apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/` + # project`" # rate limit for consumer projects values: STANDARD: 10000 # The + # metric rules bind all methods to the read_calls metric, # except for the + # UpdateBook and DeleteBook methods. These two methods # are mapped to the + # write_calls metric, with the UpdateBook method # consuming at twice rate as + # the DeleteBook method. metric_rules: - selector: "*" metric_costs: library. + # googleapis.com/read_calls: 1 - selector: google.example.library.v1. + # LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - + # selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: + # library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: + # - name: library.googleapis.com/read_calls display_name: Read requests + # metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/ + # write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 # Corresponds to the JSON property `quota` # @return [Google::Apis::ServiceusageV1::Quota] attr_accessor :quota @@ -1855,20 +1565,18 @@ module Google # @return [Google::Apis::ServiceusageV1::SourceInfo] attr_accessor :source_info - # ### System parameter configuration - # A system parameter is a special kind of parameter defined by the API - # system, not by an individual API. It is typically mapped to an HTTP header - # and/or a URL query parameter. This configuration specifies which methods - # change the names of the system parameters. + # ### System parameter configuration A system parameter is a special kind of + # parameter defined by the API system, not by an individual API. It is typically + # mapped to an HTTP header and/or a URL query parameter. This configuration + # specifies which methods change the names of the system parameters. # Corresponds to the JSON property `systemParameters` # @return [Google::Apis::ServiceusageV1::SystemParameters] attr_accessor :system_parameters - # A list of all proto message types included in this API service. - # It serves similar purpose as [google.api.Service.types], except that - # these types are not needed by user-defined APIs. Therefore, they will not - # show up in the generated discovery doc. This field should only be used - # to define system APIs in ESF. + # A list of all proto message types included in this API service. It serves + # similar purpose as [google.api.Service.types], except that these types are not + # needed by user-defined APIs. Therefore, they will not show up in the generated + # discovery doc. This field should only be used to define system APIs in ESF. # Corresponds to the JSON property `systemTypes` # @return [Array] attr_accessor :system_types @@ -1878,12 +1586,10 @@ module Google # @return [String] attr_accessor :title - # A list of all proto message types included in this API service. - # Types referenced directly or indirectly by the `apis` are - # automatically included. Messages which are not referenced but - # shall be included, such as types used by the `google.protobuf.Any` type, - # should be listed here by name. Example: - # types: + # A list of all proto message types included in this API service. Types + # referenced directly or indirectly by the `apis` are automatically included. + # Messages which are not referenced but shall be included, such as types used by + # the `google.protobuf.Any` type, should be listed here by name. Example: types: # - name: google.protobuf.Int32 # Corresponds to the JSON property `types` # @return [Array] @@ -1930,32 +1636,28 @@ module Google end end - # The per-product per-project service identity for a service. - # Use this field to configure per-product per-project service identity. - # Example of a service identity configuration. - # usage: - # service_identity: - # - service_account_parent: "projects/123456789" - # display_name: "Cloud XXX Service Agent" - # description: "Used as the identity of Cloud XXX to access resources" + # The per-product per-project service identity for a service. Use this field to + # configure per-product per-project service identity. Example of a service + # identity configuration. usage: service_identity: - service_account_parent: " + # projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used + # as the identity of Cloud XXX to access resources" class GoogleApiServiceIdentity include Google::Apis::Core::Hashable - # Optional. A user-specified opaque description of the service account. - # Must be less than or equal to 256 UTF-8 bytes. + # Optional. A user-specified opaque description of the service account. Must be + # less than or equal to 256 UTF-8 bytes. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Optional. A user-specified name for the service account. - # Must be less than or equal to 100 UTF-8 bytes. + # Optional. A user-specified name for the service account. Must be less than or + # equal to 100 UTF-8 bytes. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # A service account project that hosts the service accounts. - # An example name would be: - # `projects/123456789` + # A service account project that hosts the service accounts. An example name + # would be: `projects/123456789` # Corresponds to the JSON property `serviceAccountParent` # @return [String] attr_accessor :service_account_parent @@ -1976,8 +1678,7 @@ module Google class GoogleApiServiceusageV1OperationMetadata include Google::Apis::Core::Hashable - # The full name of the resources that this operation is directly - # associated with. + # The full name of the resources that this operation is directly associated with. # Corresponds to the JSON property `resourceNames` # @return [Array] attr_accessor :resource_names @@ -2001,16 +1702,13 @@ module Google # @return [Google::Apis::ServiceusageV1::GoogleApiServiceusageV1ServiceConfig] attr_accessor :config - # The resource name of the consumer and service. - # A valid name would be: - # - projects/123/services/serviceusage.googleapis.com + # The resource name of the consumer and service. A valid name would be: - + # projects/123/services/serviceusage.googleapis.com # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The resource name of the consumer. - # A valid name would be: - # - projects/123 + # The resource name of the consumer. A valid name would be: - projects/123 # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -2043,129 +1741,76 @@ module Google # @return [Array] attr_accessor :apis - # `Authentication` defines the authentication configuration for an API. - # Example for an API targeted for external use: - # name: calendar.googleapis.com - # authentication: - # providers: - # - id: google_calendar_auth - # jwks_uri: https://www.googleapis.com/oauth2/v1/certs - # issuer: https://securetoken.google.com - # rules: - # - selector: "*" - # requirements: - # provider_id: google_calendar_auth + # `Authentication` defines the authentication configuration for an API. Example + # for an API targeted for external use: name: calendar.googleapis.com + # authentication: providers: - id: google_calendar_auth jwks_uri: https://www. + # googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - + # selector: "*" requirements: provider_id: google_calendar_auth # Corresponds to the JSON property `authentication` # @return [Google::Apis::ServiceusageV1::Authentication] attr_accessor :authentication - # `Documentation` provides the information for describing a service. - # Example: - # 
documentation:
-        # summary: >
-        # The Google Calendar API gives access
-        # to most calendar features.
-        # pages:
-        # - name: Overview
-        # content: (== include google/foo/overview.md ==)
-        # - name: Tutorial
-        # content: (== include google/foo/tutorial.md ==)
-        # subpages;
-        # - name: Java
-        # content: (== include google/foo/tutorial_java.md ==)
-        # rules:
-        # - selector: google.calendar.Calendar.Get
-        # description: >
-        # ...
-        # - selector: google.calendar.Calendar.Put
-        # description: >
-        # ...
-        #
- # Documentation is provided in markdown syntax. In addition to - # standard markdown features, definition lists, tables and fenced - # code blocks are supported. Section headers can be provided and are - # interpreted relative to the section nesting of the context where - # a documentation fragment is embedded. - # Documentation from the IDL is merged with documentation defined - # via the config at normalization time, where documentation provided - # by config rules overrides IDL provided. - # A number of constructs specific to the API platform are supported - # in documentation text. - # In order to reference a proto element, the following - # notation can be used: - # 
[fully.qualified.proto.name][]
- # To override the display text used for the link, this can be used: - # 
[display text][fully.qualified.proto.name]
- # Text can be excluded from doc using the following notation: - # 
(-- internal comment --)
- # A few directives are available in documentation. Note that - # directives must appear on a single line to be properly - # identified. The `include` directive includes a markdown file from - # an external source: - # 
(== include path/to/file ==)
- # The `resource_for` directive marks a message to be the resource of - # a collection in REST view. If it is not specified, tools attempt - # to infer the resource from the operations in a collection: - # 
(== resource_for v1.shelves.books ==)
- # The directive `suppress_warning` does not directly affect documentation - # and is documented together with service config validation. + # `Documentation` provides the information for describing a service. Example: + # documentation: summary: > The Google Calendar API gives access to most + # calendar features. pages: - name: Overview content: (== include google/foo/ + # overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md == + # ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==) + # rules: - selector: google.calendar.Calendar.Get description: > ... - selector: + # google.calendar.Calendar.Put description: > ... Documentation is provided in + # markdown syntax. In addition to standard markdown features, definition lists, + # tables and fenced code blocks are supported. Section headers can be provided + # and are interpreted relative to the section nesting of the context where a + # documentation fragment is embedded. Documentation from the IDL is merged with + # documentation defined via the config at normalization time, where + # documentation provided by config rules overrides IDL provided. A number of + # constructs specific to the API platform are supported in documentation text. + # In order to reference a proto element, the following notation can be used: [ + # fully.qualified.proto.name][] To override the display text used for the link, + # this can be used: [display text][fully.qualified.proto.name] Text can be + # excluded from doc using the following notation: (-- internal comment --) A few + # directives are available in documentation. Note that directives must appear on + # a single line to be properly identified. The `include` directive includes a + # markdown file from an external source: (== include path/to/file ==) The ` + # resource_for` directive marks a message to be the resource of a collection in + # REST view. If it is not specified, tools attempt to infer the resource from + # the operations in a collection: (== resource_for v1.shelves.books ==) The + # directive `suppress_warning` does not directly affect documentation and is + # documented together with service config validation. # Corresponds to the JSON property `documentation` # @return [Google::Apis::ServiceusageV1::Documentation] attr_accessor :documentation - # Configuration for network endpoints. Contains only the names and aliases - # of the endpoints. + # Configuration for network endpoints. Contains only the names and aliases of + # the endpoints. # Corresponds to the JSON property `endpoints` # @return [Array] attr_accessor :endpoints - # The DNS address at which this service is available. - # An example DNS address would be: - # `calendar.googleapis.com`. + # The DNS address at which this service is available. An example DNS address + # would be: `calendar.googleapis.com`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Quota configuration helps to achieve fairness and budgeting in service - # usage. - # The metric based quota configuration works this way: - # - The service configuration defines a set of metrics. - # - For API calls, the quota.metric_rules maps methods to metrics with - # corresponding costs. - # - The quota.limits defines limits on the metrics, which will be used for - # quota checks at runtime. - # An example quota configuration in yaml format: - # quota: - # limits: - # - name: apiWriteQpsPerProject - # metric: library.googleapis.com/write_calls - # unit: "1/min/`project`" # rate limit for consumer projects - # values: - # STANDARD: 10000 - # # The metric rules bind all methods to the read_calls metric, - # # except for the UpdateBook and DeleteBook methods. These two methods - # # are mapped to the write_calls metric, with the UpdateBook method - # # consuming at twice rate as the DeleteBook method. - # metric_rules: - # - selector: "*" - # metric_costs: - # library.googleapis.com/read_calls: 1 - # - selector: google.example.library.v1.LibraryService.UpdateBook - # metric_costs: - # library.googleapis.com/write_calls: 2 - # - selector: google.example.library.v1.LibraryService.DeleteBook - # metric_costs: - # library.googleapis.com/write_calls: 1 - # Corresponding Metric definition: - # metrics: - # - name: library.googleapis.com/read_calls - # display_name: Read requests - # metric_kind: DELTA - # value_type: INT64 - # - name: library.googleapis.com/write_calls - # display_name: Write requests - # metric_kind: DELTA - # value_type: INT64 + # Quota configuration helps to achieve fairness and budgeting in service usage. + # The metric based quota configuration works this way: - The service + # configuration defines a set of metrics. - For API calls, the quota. + # metric_rules maps methods to metrics with corresponding costs. - The quota. + # limits defines limits on the metrics, which will be used for quota checks at + # runtime. An example quota configuration in yaml format: quota: limits: - name: + # apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/` + # project`" # rate limit for consumer projects values: STANDARD: 10000 # The + # metric rules bind all methods to the read_calls metric, # except for the + # UpdateBook and DeleteBook methods. These two methods # are mapped to the + # write_calls metric, with the UpdateBook method # consuming at twice rate as + # the DeleteBook method. metric_rules: - selector: "*" metric_costs: library. + # googleapis.com/read_calls: 1 - selector: google.example.library.v1. + # LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - + # selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: + # library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: + # - name: library.googleapis.com/read_calls display_name: Read requests + # metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/ + # write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 # Corresponds to the JSON property `quota` # @return [Google::Apis::ServiceusageV1::Quota] attr_accessor :quota @@ -2228,15 +1873,14 @@ module Google class GoogleApiServiceusageV1beta1ServiceIdentity include Google::Apis::Core::Hashable - # The email address of the service account that a service producer would use - # to access consumer resources. + # The email address of the service account that a service producer would use to + # access consumer resources. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email - # The unique and stable id of the service account. - # https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts# - # ServiceAccount + # The unique and stable id of the service account. https://cloud.google.com/iam/ + # reference/rest/v1/projects.serviceAccounts#ServiceAccount # Corresponds to the JSON property `uniqueId` # @return [String] attr_accessor :unique_id @@ -2253,23 +1897,22 @@ module Google end # Defines the HTTP configuration for an API service. It contains a list of - # HttpRule, each specifying the mapping of an RPC method - # to one or more HTTP REST API methods. + # HttpRule, each specifying the mapping of an RPC method to one or more HTTP + # REST API methods. class Http include Google::Apis::Core::Hashable # When set to true, URL path parameters will be fully URI-decoded except in # cases of single segment matches in reserved expansion, where "%2F" will be - # left encoded. - # The default behavior is to not decode RFC 6570 reserved characters in multi - # segment matches. + # left encoded. The default behavior is to not decode RFC 6570 reserved + # characters in multi segment matches. # Corresponds to the JSON property `fullyDecodeReservedExpansion` # @return [Boolean] attr_accessor :fully_decode_reserved_expansion alias_method :fully_decode_reserved_expansion?, :fully_decode_reserved_expansion - # A list of HTTP configuration rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of HTTP configuration rules that apply to individual API methods. ** + # NOTE:** All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -2285,251 +1928,156 @@ module Google end end - # # gRPC Transcoding - # gRPC Transcoding is a feature for mapping between a gRPC method and one or - # more HTTP REST endpoints. It allows developers to build a single API service - # that supports both gRPC APIs and REST APIs. Many systems, including [Google - # APIs](https://github.com/googleapis/googleapis), - # [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC - # Gateway](https://github.com/grpc-ecosystem/grpc-gateway), - # and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature - # and use it for large scale production services. - # `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies - # how different portions of the gRPC request message are mapped to the URL - # path, URL query parameters, and HTTP request body. It also controls how the - # gRPC response message is mapped to the HTTP response body. `HttpRule` is + # # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC + # method and one or more HTTP REST endpoints. It allows developers to build a + # single API service that supports both gRPC APIs and REST APIs. Many systems, + # including [Google APIs](https://github.com/googleapis/googleapis), [Cloud + # Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github. + # com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/ + # envoy) proxy support this feature and use it for large scale production + # services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping + # specifies how different portions of the gRPC request message are mapped to the + # URL path, URL query parameters, and HTTP request body. It also controls how + # the gRPC response message is mapped to the HTTP response body. `HttpRule` is # typically specified as an `google.api.http` annotation on the gRPC method. # Each mapping specifies a URL path template and an HTTP method. The path # template may refer to one or more fields in the gRPC request message, as long - # as each field is a non-repeated field with a primitive (non-message) type. - # The path template controls how fields of the request message are mapped to - # the URL path. - # Example: - # service Messaging ` - # rpc GetMessage(GetMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # get: "/v1/`name=messages/*`" - # `; - # ` - # ` - # message GetMessageRequest ` - # string name = 1; // Mapped to URL path. - # ` - # message Message ` - # string text = 1; // The resource content. - # ` - # This enables an HTTP REST to gRPC mapping as below: - # HTTP | gRPC - # -----|----- - # `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` - # Any fields in the request message which are not bound by the path template - # automatically become HTTP query parameters if there is no HTTP request body. - # For example: - # service Messaging ` - # rpc GetMessage(GetMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # get:"/v1/messages/`message_id`" - # `; - # ` - # ` - # message GetMessageRequest ` - # message SubMessage ` - # string subfield = 1; - # ` - # string message_id = 1; // Mapped to URL path. - # int64 revision = 2; // Mapped to URL query parameter `revision`. - # SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. - # ` - # This enables a HTTP JSON to RPC mapping as below: - # HTTP | gRPC - # -----|----- - # `GET /v1/messages/123456?revision=2&sub.subfield=foo` | - # `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: - # "foo"))` - # Note that fields which are mapped to URL query parameters must have a - # primitive type or a repeated primitive type or a non-repeated message type. - # In the case of a repeated type, the parameter can be repeated in the URL - # as `...?param=A¶m=B`. In the case of a message type, each field of the - # message is mapped to a separate parameter, such as - # `...?foo.a=A&foo.b=B&foo.c=C`. - # For HTTP methods that allow a request body, the `body` field - # specifies the mapping. Consider a REST update method on the - # message resource collection: - # service Messaging ` - # rpc UpdateMessage(UpdateMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # patch: "/v1/messages/`message_id`" - # body: "message" - # `; - # ` - # ` - # message UpdateMessageRequest ` - # string message_id = 1; // mapped to the URL - # Message message = 2; // mapped to the body - # ` - # The following HTTP JSON to RPC mapping is enabled, where the - # representation of the JSON in the request body is determined by - # protos JSON encoding: - # HTTP | gRPC - # -----|----- - # `PATCH /v1/messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: - # "123456" message ` text: "Hi!" `)` - # The special name `*` can be used in the body mapping to define that - # every field not bound by the path template should be mapped to the - # request body. This enables the following alternative definition of - # the update method: - # service Messaging ` - # rpc UpdateMessage(Message) returns (Message) ` - # option (google.api.http) = ` - # patch: "/v1/messages/`message_id`" - # body: "*" - # `; - # ` - # ` - # message Message ` - # string message_id = 1; - # string text = 2; - # ` - # The following HTTP JSON to RPC mapping is enabled: - # HTTP | gRPC - # -----|----- - # `PATCH /v1/messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: - # "123456" text: "Hi!")` - # Note that when using `*` in the body mapping, it is not possible to - # have HTTP parameters, as all fields not bound by the path end in - # the body. This makes this option more rarely used in practice when - # defining REST APIs. The common usage of `*` is in custom methods - # which don't use the URL at all for transferring data. - # It is possible to define multiple HTTP methods for one RPC by using - # the `additional_bindings` option. Example: - # service Messaging ` - # rpc GetMessage(GetMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # get: "/v1/messages/`message_id`" - # additional_bindings ` - # get: "/v1/users/`user_id`/messages/`message_id`" - # ` - # `; - # ` - # ` - # message GetMessageRequest ` - # string message_id = 1; - # string user_id = 2; - # ` - # This enables the following two alternative HTTP JSON to RPC mappings: - # HTTP | gRPC - # -----|----- - # `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` - # `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: - # "123456")` - # ## Rules for HTTP mapping - # 1. Leaf request fields (recursive expansion nested messages in the request - # message) are classified into three categories: - # - Fields referred by the path template. They are passed via the URL path. - # - Fields referred by the HttpRule.body. They are passed via the HTTP - # request body. - # - All other fields are passed via the URL query parameters, and the - # parameter name is the field path in the request message. A repeated - # field can be represented as multiple query parameters under the same - # name. - # 2. If HttpRule.body is "*", there is no URL query parameter, all fields - # are passed via URL path and HTTP request body. - # 3. If HttpRule.body is omitted, there is no HTTP request body, all - # fields are passed via URL path and URL query parameters. - # ### Path template syntax - # Template = "/" Segments [ Verb ] ; - # Segments = Segment ` "/" Segment ` ; - # Segment = "*" | "**" | LITERAL | Variable ; - # Variable = "`" FieldPath [ "=" Segments ] "`" ; - # FieldPath = IDENT ` "." IDENT ` ; - # Verb = ":" LITERAL ; - # The syntax `*` matches a single URL path segment. The syntax `**` matches - # zero or more URL path segments, which must be the last part of the URL path - # except the `Verb`. - # The syntax `Variable` matches part of the URL path as specified by its - # template. A variable template must not contain other variables. If a variable - # matches a single path segment, its template may be omitted, e.g. ``var`` - # is equivalent to ``var=*``. - # The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` - # contains any reserved character, such characters should be percent-encoded - # before the matching. - # If a variable contains exactly one path segment, such as `"`var`"` or - # `"`var=*`"`, when such a variable is expanded into a URL path on the client - # side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The - # server side does the reverse decoding. Such variables show up in the - # [Discovery - # Document](https://developers.google.com/discovery/v1/reference/apis) as - # ``var``. - # If a variable contains multiple path segments, such as `"`var=foo/*`"` - # or `"`var=**`"`, when such a variable is expanded into a URL path on the - # client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. - # The server side does the reverse decoding, except "%2F" and "%2f" are left - # unchanged. Such variables show up in the - # [Discovery - # Document](https://developers.google.com/discovery/v1/reference/apis) as - # ``+var``. - # ## Using gRPC API Service Configuration - # gRPC API Service Configuration (service config) is a configuration language - # for configuring a gRPC service to become a user-facing product. The - # service config is simply the YAML representation of the `google.api.Service` - # proto message. + # as each field is a non-repeated field with a primitive (non-message) type. The + # path template controls how fields of the request message are mapped to the URL + # path. Example: service Messaging ` rpc GetMessage(GetMessageRequest) returns ( + # Message) ` option (google.api.http) = ` get: "/v1/`name=messages/*`" `; ` ` + # message GetMessageRequest ` string name = 1; // Mapped to URL path. ` message + # Message ` string text = 1; // The resource content. ` This enables an HTTP + # REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/ + # 123456` | `GetMessage(name: "messages/123456")` Any fields in the request + # message which are not bound by the path template automatically become HTTP + # query parameters if there is no HTTP request body. For example: service + # Messaging ` rpc GetMessage(GetMessageRequest) returns (Message) ` option ( + # google.api.http) = ` get:"/v1/messages/`message_id`" `; ` ` message + # GetMessageRequest ` message SubMessage ` string subfield = 1; ` string + # message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL + # query parameter `revision`. SubMessage sub = 3; // Mapped to URL query + # parameter `sub.subfield`. ` This enables a HTTP JSON to RPC mapping as below: + # HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | + # `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo")) + # ` Note that fields which are mapped to URL query parameters must have a + # primitive type or a repeated primitive type or a non-repeated message type. In + # the case of a repeated type, the parameter can be repeated in the URL as `...? + # param=A¶m=B`. In the case of a message type, each field of the message is + # mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For + # HTTP methods that allow a request body, the `body` field specifies the mapping. + # Consider a REST update method on the message resource collection: service + # Messaging ` rpc UpdateMessage(UpdateMessageRequest) returns (Message) ` option + # (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "message" `; ` ` + # message UpdateMessageRequest ` string message_id = 1; // mapped to the URL + # Message message = 2; // mapped to the body ` The following HTTP JSON to RPC + # mapping is enabled, where the representation of the JSON in the request body + # is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/ + # messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456" + # message ` text: "Hi!" `)` The special name `*` can be used in the body mapping + # to define that every field not bound by the path template should be mapped to + # the request body. This enables the following alternative definition of the + # update method: service Messaging ` rpc UpdateMessage(Message) returns (Message) + # ` option (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "*" `; + # ` ` message Message ` string message_id = 1; string text = 2; ` The following + # HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/ + # messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456" text: + # "Hi!")` Note that when using `*` in the body mapping, it is not possible to + # have HTTP parameters, as all fields not bound by the path end in the body. + # This makes this option more rarely used in practice when defining REST APIs. + # The common usage of `*` is in custom methods which don't use the URL at all + # for transferring data. It is possible to define multiple HTTP methods for one + # RPC by using the `additional_bindings` option. Example: service Messaging ` + # rpc GetMessage(GetMessageRequest) returns (Message) ` option (google.api.http) + # = ` get: "/v1/messages/`message_id`" additional_bindings ` get: "/v1/users/` + # user_id`/messages/`message_id`" ` `; ` ` message GetMessageRequest ` string + # message_id = 1; string user_id = 2; ` This enables the following two + # alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/ + # messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/ + # messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules + # for HTTP mapping 1. Leaf request fields (recursive expansion nested messages + # in the request message) are classified into three categories: - Fields + # referred by the path template. They are passed via the URL path. - Fields + # referred by the HttpRule.body. They are passed via the HTTP request body. - + # All other fields are passed via the URL query parameters, and the parameter + # name is the field path in the request message. A repeated field can be + # represented as multiple query parameters under the same name. 2. If HttpRule. + # body is "*", there is no URL query parameter, all fields are passed via URL + # path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP + # request body, all fields are passed via URL path and URL query parameters. ### + # Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment ` "/ + # " Segment ` ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "`" + # FieldPath [ "=" Segments ] "`" ; FieldPath = IDENT ` "." IDENT ` ; Verb = ":" + # LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` + # matches zero or more URL path segments, which must be the last part of the URL + # path except the `Verb`. The syntax `Variable` matches part of the URL path as + # specified by its template. A variable template must not contain other + # variables. If a variable matches a single path segment, its template may be + # omitted, e.g. ``var`` is equivalent to ``var=*``. The syntax `LITERAL` matches + # literal text in the URL path. If the `LITERAL` contains any reserved character, + # such characters should be percent-encoded before the matching. If a variable + # contains exactly one path segment, such as `"`var`"` or `"`var=*`"`, when such + # a variable is expanded into a URL path on the client side, all characters + # except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse + # decoding. Such variables show up in the [Discovery Document](https:// + # developers.google.com/discovery/v1/reference/apis) as ``var``. If a variable + # contains multiple path segments, such as `"`var=foo/*`"` or `"`var=**`"`, when + # such a variable is expanded into a URL path on the client side, all characters + # except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the + # reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables + # show up in the [Discovery Document](https://developers.google.com/discovery/v1/ + # reference/apis) as ``+var``. ## Using gRPC API Service Configuration gRPC API + # Service Configuration (service config) is a configuration language for + # configuring a gRPC service to become a user-facing product. The service config + # is simply the YAML representation of the `google.api.Service` proto message. # As an alternative to annotating your proto file, you can configure gRPC - # transcoding in your service config YAML files. You do this by specifying a - # `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same - # effect as the proto annotation. This can be particularly useful if you - # have a proto that is reused in multiple services. Note that any transcoding - # specified in the service config will override any matching transcoding - # configuration in the proto. - # Example: - # http: - # rules: - # # Selects a gRPC method and applies HttpRule to it. - # - selector: example.v1.Messaging.GetMessage - # get: /v1/messages/`message_id`/`sub.subfield` - # ## Special notes - # When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the - # proto to JSON conversion must follow the [proto3 - # specification](https://developers.google.com/protocol-buffers/docs/proto3#json) - # . - # While the single segment variable follows the semantics of - # [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String - # Expansion, the multi segment variable **does not** follow RFC 6570 Section - # 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion - # does not expand special characters like `?` and `#`, which would lead - # to invalid URLs. As the result, gRPC Transcoding uses a custom encoding - # for multi segment variables. - # The path variables **must not** refer to any repeated or mapped field, - # because client libraries are not capable of handling such variable expansion. - # The path variables **must not** capture the leading "/" character. The reason - # is that the most common use case "`var`" does not capture the leading "/" - # character. For consistency, all path variables must share the same behavior. - # Repeated message fields must not be mapped to URL query parameters, because - # no client library can support such complicated mapping. - # If an API needs to use a JSON array for request or response body, it can map - # the request or response body to a repeated field. However, some gRPC - # Transcoding implementations may not support this feature. + # transcoding in your service config YAML files. You do this by specifying a ` + # HttpRule` that maps the gRPC method to a REST endpoint, achieving the same + # effect as the proto annotation. This can be particularly useful if you have a + # proto that is reused in multiple services. Note that any transcoding specified + # in the service config will override any matching transcoding configuration in + # the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule + # to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/` + # message_id`/`sub.subfield` ## Special notes When gRPC Transcoding is used to + # map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow + # the [proto3 specification](https://developers.google.com/protocol-buffers/docs/ + # proto3#json). While the single segment variable follows the semantics of [RFC + # 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String + # Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2. + # 3 Reserved Expansion. The reason is that the Reserved Expansion does not + # expand special characters like `?` and `#`, which would lead to invalid URLs. + # As the result, gRPC Transcoding uses a custom encoding for multi segment + # variables. The path variables **must not** refer to any repeated or mapped + # field, because client libraries are not capable of handling such variable + # expansion. The path variables **must not** capture the leading "/" character. + # The reason is that the most common use case "`var`" does not capture the + # leading "/" character. For consistency, all path variables must share the same + # behavior. Repeated message fields must not be mapped to URL query parameters, + # because no client library can support such complicated mapping. If an API + # needs to use a JSON array for request or response body, it can map the request + # or response body to a repeated field. However, some gRPC Transcoding + # implementations may not support this feature. class HttpRule include Google::Apis::Core::Hashable - # Additional HTTP bindings for the selector. Nested bindings must - # not contain an `additional_bindings` field themselves (that is, - # the nesting may only be one level deep). + # Additional HTTP bindings for the selector. Nested bindings must not contain an + # `additional_bindings` field themselves (that is, the nesting may only be one + # level deep). # Corresponds to the JSON property `additionalBindings` # @return [Array] attr_accessor :additional_bindings - # When this flag is set to true, HTTP requests will be allowed to invoke a - # half-duplex streaming method. + # When this flag is set to true, HTTP requests will be allowed to invoke a half- + # duplex streaming method. # Corresponds to the JSON property `allowHalfDuplex` # @return [Boolean] attr_accessor :allow_half_duplex alias_method :allow_half_duplex?, :allow_half_duplex - # The name of the request field whose value is mapped to the HTTP request - # body, or `*` for mapping all request fields not captured by the path - # pattern to the HTTP body, or omitted for not having any HTTP request body. - # NOTE: the referred field must be present at the top-level of the request - # message type. + # The name of the request field whose value is mapped to the HTTP request body, + # or `*` for mapping all request fields not captured by the path pattern to the + # HTTP body, or omitted for not having any HTTP request body. NOTE: the referred + # field must be present at the top-level of the request message type. # Corresponds to the JSON property `body` # @return [String] attr_accessor :body @@ -2544,8 +2092,7 @@ module Google # @return [String] attr_accessor :delete - # Maps to HTTP GET. Used for listing and getting information about - # resources. + # Maps to HTTP GET. Used for listing and getting information about resources. # Corresponds to the JSON property `get` # @return [String] attr_accessor :get @@ -2566,16 +2113,15 @@ module Google attr_accessor :put # Optional. The name of the response field whose value is mapped to the HTTP - # response body. When omitted, the entire response message will be used - # as the HTTP response body. - # NOTE: The referred field must be present at the top-level of the response - # message type. + # response body. When omitted, the entire response message will be used as the + # HTTP response body. NOTE: The referred field must be present at the top-level + # of the response message type. # Corresponds to the JSON property `responseBody` # @return [String] attr_accessor :response_body - # Selects a method to which this rule applies. - # Refer to selector for syntax details. + # Selects a method to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -2671,13 +2217,12 @@ module Google # @return [String] attr_accessor :query - # The value prefix. The value format is "value_prefix`token`" - # Only applies to "in" header type. Must be empty for "in" query type. - # If not empty, the header value has to match (case sensitive) this prefix. - # If not matched, JWT will not be extracted. If matched, JWT will be - # extracted after the prefix is removed. - # For example, for "Authorization: Bearer `JWT`", - # value_prefix="Bearer " with a space at the end. + # The value prefix. The value format is "value_prefix`token`" Only applies to " + # in" header type. Must be empty for "in" query type. If not empty, the header + # value has to match (case sensitive) this prefix. If not matched, JWT will not + # be extracted. If matched, JWT will be extracted after the prefix is removed. + # For example, for "Authorization: Bearer `JWT`", value_prefix="Bearer " with a + # space at the end. # Corresponds to the JSON property `valuePrefix` # @return [String] attr_accessor :value_prefix @@ -2754,8 +2299,7 @@ module Google class ListServicesResponse include Google::Apis::Core::Hashable - # Token that can be passed to `ListServices` to resume a paginated - # query. + # Token that can be passed to `ListServices` to resume a paginated query. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2776,39 +2320,35 @@ module Google end end - # A description of a log type. Example in YAML format: - # - name: library.googleapis.com/activity_history - # description: The history of borrowing and returning library items. - # display_name: Activity - # labels: - # - key: /customer_id + # A description of a log type. Example in YAML format: - name: library. + # googleapis.com/activity_history description: The history of borrowing and + # returning library items. display_name: Activity labels: - key: /customer_id # description: Identifier of a library customer class LogDescriptor include Google::Apis::Core::Hashable - # A human-readable description of this log. This information appears in - # the documentation and can contain details. + # A human-readable description of this log. This information appears in the + # documentation and can contain details. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # The human-readable name for this log. This information appears on - # the user interface and should be concise. + # The human-readable name for this log. This information appears on the user + # interface and should be concise. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # The set of labels that are available to describe a specific log entry. - # Runtime requests that contain labels not specified here are - # considered invalid. + # The set of labels that are available to describe a specific log entry. Runtime + # requests that contain labels not specified here are considered invalid. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels - # The name of the log. It must be less than 512 characters long and can - # include the following characters: upper- and lower-case alphanumeric - # characters [A-Za-z0-9], and punctuation characters including - # slash, underscore, hyphen, period [/_-.]. + # The name of the log. It must be less than 512 characters long and can include + # the following characters: upper- and lower-case alphanumeric characters [A-Za- + # z0-9], and punctuation characters including slash, underscore, hyphen, period [ + # /_-.]. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2826,48 +2366,30 @@ module Google end end - # Logging configuration of the service. - # The following example shows how to configure logs to be sent to the - # producer and consumer projects. In the example, the `activity_history` - # log is sent to both the producer and consumer projects, whereas the - # `purchase_history` log is only sent to the producer project. - # monitored_resources: - # - type: library.googleapis.com/branch - # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. - # logs: - # - name: activity_history - # labels: - # - key: /customer_id - # - name: purchase_history - # logging: - # producer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history - # - purchase_history - # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history + # Logging configuration of the service. The following example shows how to + # configure logs to be sent to the producer and consumer projects. In the + # example, the `activity_history` log is sent to both the producer and consumer + # projects, whereas the `purchase_history` log is only sent to the producer + # project. monitored_resources: - type: library.googleapis.com/branch labels: - + # key: /city description: The city where the library branch is located in. - key: + # /name description: The name of the branch. logs: - name: activity_history + # labels: - key: /customer_id - name: purchase_history logging: + # producer_destinations: - monitored_resource: library.googleapis.com/branch + # logs: - activity_history - purchase_history consumer_destinations: - + # monitored_resource: library.googleapis.com/branch logs: - activity_history class Logging include Google::Apis::Core::Hashable - # Logging configurations for sending logs to the consumer project. - # There can be multiple consumer destinations, each one must have a - # different monitored resource type. A log can be used in at most - # one consumer destination. + # Logging configurations for sending logs to the consumer project. There can be + # multiple consumer destinations, each one must have a different monitored + # resource type. A log can be used in at most one consumer destination. # Corresponds to the JSON property `consumerDestinations` # @return [Array] attr_accessor :consumer_destinations - # Logging configurations for sending logs to the producer project. - # There can be multiple producer destinations, each one must have a - # different monitored resource type. A log can be used in at most - # one producer destination. + # Logging configurations for sending logs to the producer project. There can be + # multiple producer destinations, each one must have a different monitored + # resource type. A log can be used in at most one producer destination. # Corresponds to the JSON property `producerDestinations` # @return [Array] attr_accessor :producer_destinations @@ -2883,21 +2405,20 @@ module Google end end - # Configuration of a specific logging destination (the producer project - # or the consumer project). + # Configuration of a specific logging destination (the producer project or the + # consumer project). class LoggingDestination include Google::Apis::Core::Hashable - # Names of the logs to be sent to this destination. Each name must - # be defined in the Service.logs section. If the log name is - # not a domain scoped name, it will be automatically prefixed with - # the service name followed by "/". + # Names of the logs to be sent to this destination. Each name must be defined in + # the Service.logs section. If the log name is not a domain scoped name, it will + # be automatically prefixed with the service name followed by "/". # Corresponds to the JSON property `logs` # @return [Array] attr_accessor :logs - # The monitored resource type. The type must be defined in the - # Service.monitored_resources section. + # The monitored resource type. The type must be defined in the Service. + # monitored_resources section. # Corresponds to the JSON property `monitoredResource` # @return [String] attr_accessor :monitored_resource @@ -2972,16 +2493,13 @@ module Google # Defines a metric type and its schema. Once a metric descriptor is created, # deleting or altering it stops data collection and makes the metric type's - # existing data unusable. - # The following are specific rules for service defined Monitoring metric - # descriptors: - # * `type`, `metric_kind`, `value_type` and `description` - # fields are all required. The `unit` field must be specified - # if the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. - # * Maximum of default 500 metric descriptors per service is allowed. - # * Maximum of default 10 labels per metric descriptor is allowed. - # The default maximum limit can be overridden. Please follow - # https://cloud.google.com/monitoring/quotas + # existing data unusable. The following are specific rules for service defined + # Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and ` + # description` fields are all required. The `unit` field must be specified if + # the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default + # 500 metric descriptors per service is allowed. * Maximum of default 10 labels + # per metric descriptor is allowed. The default maximum limit can be overridden. + # Please follow https://cloud.google.com/monitoring/quotas class MetricDescriptor include Google::Apis::Core::Hashable @@ -2990,26 +2508,21 @@ module Google # @return [String] attr_accessor :description - # A concise name for the metric, which can be displayed in user interfaces. - # Use sentence case without an ending period, for example "Request count". - # This field is optional but it is recommended to be set for any metrics - # associated with user-visible concepts, such as Quota. + # A concise name for the metric, which can be displayed in user interfaces. Use + # sentence case without an ending period, for example "Request count". This + # field is optional but it is recommended to be set for any metrics associated + # with user-visible concepts, such as Quota. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # The set of labels that can be used to describe a specific - # instance of this metric type. - # The label key name must follow: - # * Only upper and lower-case letters, digits and underscores (_) are - # allowed. - # * Label name must start with a letter or digit. - # * The maximum length of a label name is 100 characters. - # For example, the - # `appengine.googleapis.com/http/server/response_latencies` metric - # type has a label for the HTTP response code, `response_code`, so - # you can look at latencies for successful responses or just - # for responses that failed. + # The set of labels that can be used to describe a specific instance of this + # metric type. The label key name must follow: * Only upper and lower-case + # letters, digits and underscores (_) are allowed. * Label name must start with + # a letter or digit. * The maximum length of a label name is 100 characters. For + # example, the `appengine.googleapis.com/http/server/response_latencies` metric + # type has a label for the HTTP response code, `response_code`, so you can look + # at latencies for successful responses or just for responses that failed. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels @@ -3024,17 +2537,16 @@ module Google # @return [Google::Apis::ServiceusageV1::MetricDescriptorMetadata] attr_accessor :metadata - # Whether the metric records instantaneous values, changes to a value, etc. - # Some combinations of `metric_kind` and `value_type` might not be supported. + # Whether the metric records instantaneous values, changes to a value, etc. Some + # combinations of `metric_kind` and `value_type` might not be supported. # Corresponds to the JSON property `metricKind` # @return [String] attr_accessor :metric_kind - # Read-only. If present, then a time - # series, which is identified partially by - # a metric type and a MonitoredResourceDescriptor, that is associated - # with this metric type can only be associated with one of the monitored - # resource types listed here. + # Read-only. If present, then a time series, which is identified partially by a + # metric type and a MonitoredResourceDescriptor, that is associated with this + # metric type can only be associated with one of the monitored resource types + # listed here. # Corresponds to the JSON property `monitoredResourceTypes` # @return [Array] attr_accessor :monitored_resource_types @@ -3044,116 +2556,73 @@ module Google # @return [String] attr_accessor :name - # The metric type, including its DNS name prefix. The type is not - # URL-encoded. + # The metric type, including its DNS name prefix. The type is not URL-encoded. # All service defined metrics must be prefixed with the service name, in the - # format of ``service name`/`relative metric name``, such as - # `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric - # name must follow: + # format of ``service name`/`relative metric name``, such as `cloudsql. + # googleapis.com/database/cpu/utilization`. The relative metric name must follow: # * Only upper and lower-case letters, digits, '/' and underscores '_' are - # allowed. - # * The maximum number of characters allowed for the relative_metric_name is - # 100. - # All user-defined metric types have the DNS name - # `custom.googleapis.com`, `external.googleapis.com`, or - # `logging.googleapis.com/user/`. - # Metric types should use a natural hierarchical grouping. For example: - # "custom.googleapis.com/invoice/paid/amount" - # "external.googleapis.com/prometheus/up" - # "appengine.googleapis.com/http/server/response_latencies" + # allowed. * The maximum number of characters allowed for the + # relative_metric_name is 100. All user-defined metric types have the DNS name ` + # custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/ + # user/`. Metric types should use a natural hierarchical grouping. For example: " + # custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/ + # up" "appengine.googleapis.com/http/server/response_latencies" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # The units in which the metric value is reported. It is only applicable - # if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` - # defines the representation of the stored metric values. - # Different systems may scale the values to be more easily displayed (so a - # value of `0.02KBy` _might_ be displayed as `20By`, and a value of - # `3523KBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is - # `KBy`, then the value of the metric is always in thousands of bytes, no - # matter how it may be displayed.. - # If you want a custom metric to record the exact number of CPU-seconds used - # by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is - # `s`CPU`` (or equivalently `1s`CPU`` or just `s`). If the job uses 12,005 - # CPU-seconds, then the value is written as `12005`. - # Alternatively, if you want a custom metric to record data in a more - # granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is - # `ks`CPU``, and then write the value `12.005` (which is `12005/1000`), - # or use `Kis`CPU`` and write `11.723` (which is `12005/1024`). - # The supported units are a subset of [The Unified Code for Units of - # Measure](http://unitsofmeasure.org/ucum.html) standard: - # **Basic units (UNIT)** - # * `bit` bit - # * `By` byte - # * `s` second - # * `min` minute - # * `h` hour - # * `d` day - # * `1` dimensionless - # **Prefixes (PREFIX)** - # * `k` kilo (10^3) - # * `M` mega (10^6) - # * `G` giga (10^9) - # * `T` tera (10^12) - # * `P` peta (10^15) - # * `E` exa (10^18) - # * `Z` zetta (10^21) - # * `Y` yotta (10^24) - # * `m` milli (10^-3) - # * `u` micro (10^-6) - # * `n` nano (10^-9) - # * `p` pico (10^-12) - # * `f` femto (10^-15) - # * `a` atto (10^-18) - # * `z` zepto (10^-21) - # * `y` yocto (10^-24) - # * `Ki` kibi (2^10) - # * `Mi` mebi (2^20) - # * `Gi` gibi (2^30) - # * `Ti` tebi (2^40) - # * `Pi` pebi (2^50) - # **Grammar** - # The grammar also includes these connectors: - # * `/` division or ratio (as an infix operator). For examples, - # `kBy/`email`` or `MiBy/10ms` (although you should almost never - # have `/s` in a metric `unit`; rates should always be computed at - # query time from the underlying cumulative or delta value). - # * `.` multiplication or composition (as an infix operator). For - # examples, `GBy.d` or `k`watt`.h`. - # The grammar for a unit is as follows: - # Expression = Component ` "." Component ` ` "/" Component ` ; - # Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] - # | Annotation - # | "1" - # ; - # Annotation = "`" NAME "`" ; - # Notes: - # * `Annotation` is just a comment if it follows a `UNIT`. If the annotation - # is used alone, then the unit is equivalent to `1`. For examples, - # ``request`/s == 1/s`, `By`transmitted`/s == By/s`. - # * `NAME` is a sequence of non-blank printable ASCII characters not - # containing ``` or ```. - # * `1` represents a unitary [dimensionless - # unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such - # as in `1/s`. It is typically used when none of the basic units are - # appropriate. For example, "new users per day" can be represented as - # `1/d` or ``new-users`/d` (and a metric value `5` would mean "5 new - # users). Alternatively, "thousands of page views per day" would be - # represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric - # value of `5.3` would mean "5300 page views per day"). - # * `%` represents dimensionless value of 1/100, and annotates values giving - # a percentage (so the metric values are typically in the range of 0..100, - # and a metric value `3` means "3 percent"). - # * `10^2.%` indicates a metric contains a ratio, typically in the range - # 0..1, that will be multiplied by 100 and displayed as a percentage - # (so a metric value `0.03` means "3 percent"). + # The units in which the metric value is reported. It is only applicable if the ` + # value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the + # representation of the stored metric values. Different systems may scale the + # values to be more easily displayed (so a value of `0.02KBy` _might_ be + # displayed as `20By`, and a value of `3523KBy` _might_ be displayed as `3.5MBy`) + # . However, if the `unit` is `KBy`, then the value of the metric is always in + # thousands of bytes, no matter how it may be displayed.. If you want a custom + # metric to record the exact number of CPU-seconds used by a job, you can create + # an `INT64 CUMULATIVE` metric whose `unit` is `s`CPU`` (or equivalently `1s`CPU` + # ` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written + # as `12005`. Alternatively, if you want a custom metric to record data in a + # more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is + # `ks`CPU``, and then write the value `12.005` (which is `12005/1000`), or use ` + # Kis`CPU`` and write `11.723` (which is `12005/1024`). The supported units are + # a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ + # ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` + # second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes ( + # PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^ + # 12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^ + # 24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^- + # 12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto ( + # 10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi ( + # 2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these + # connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/ + # `email`` or `MiBy/10ms` (although you should almost never have `/s` in a + # metric `unit`; rates should always be computed at query time from the + # underlying cumulative or delta value). * `.` multiplication or composition (as + # an infix operator). For examples, `GBy.d` or `k`watt`.h`. The grammar for a + # unit is as follows: Expression = Component ` "." Component ` ` "/" Component ` + # ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; + # Annotation = "`" NAME "`" ; Notes: * `Annotation` is just a comment if it + # follows a `UNIT`. If the annotation is used alone, then the unit is equivalent + # to `1`. For examples, ``request`/s == 1/s`, `By`transmitted`/s == By/s`. * ` + # NAME` is a sequence of non-blank printable ASCII characters not containing ``` + # or ```. * `1` represents a unitary [dimensionless unit](https://en.wikipedia. + # org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used + # when none of the basic units are appropriate. For example, "new users per day" + # can be represented as `1/d` or ``new-users`/d` (and a metric value `5` would + # mean "5 new users). Alternatively, "thousands of page views per day" would be + # represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric value of ` + # 5.3` would mean "5300 page views per day"). * `%` represents dimensionless + # value of 1/100, and annotates values giving a percentage (so the metric values + # are typically in the range of 0..100, and a metric value `3` means "3 percent") + # . * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, + # that will be multiplied by 100 and displayed as a percentage (so a metric + # value `0.03` means "3 percent"). # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit - # Whether the measurement is an integer, a floating-point number, etc. - # Some combinations of `metric_kind` and `value_type` might not be supported. + # Whether the measurement is an integer, a floating-point number, etc. Some + # combinations of `metric_kind` and `value_type` might not be supported. # Corresponds to the JSON property `valueType` # @return [String] attr_accessor :value_type @@ -3182,9 +2651,9 @@ module Google class MetricDescriptorMetadata include Google::Apis::Core::Hashable - # The delay of data points caused by ingestion. Data points older than this - # age are guaranteed to be ingested and available to be read, excluding - # data loss due to errors. + # The delay of data points caused by ingestion. Data points older than this age + # are guaranteed to be ingested and available to be read, excluding data loss + # due to errors. # Corresponds to the JSON property `ingestDelay` # @return [String] attr_accessor :ingest_delay @@ -3196,8 +2665,8 @@ module Google # The sampling period of metric data points. For metrics which are written # periodically, consecutive data points are stored at this time interval, - # excluding data loss due to errors. Metrics with a higher granularity have - # a smaller sampling period. + # excluding data loss due to errors. Metrics with a higher granularity have a + # smaller sampling period. # Corresponds to the JSON property `samplePeriod` # @return [String] attr_accessor :sample_period @@ -3214,22 +2683,21 @@ module Google end end - # Bind API methods to metrics. Binding a method to a metric causes that - # metric's configured quota behaviors to apply to the method call. + # Bind API methods to metrics. Binding a method to a metric causes that metric's + # configured quota behaviors to apply to the method call. class MetricRule include Google::Apis::Core::Hashable # Metrics to update when the selected methods are called, and the associated - # cost applied to each metric. - # The key of the map is the metric name, and the values are the amount - # increased for the metric against which the quota limits are defined. - # The value must not be negative. + # cost applied to each metric. The key of the map is the metric name, and the + # values are the amount increased for the metric against which the quota limits + # are defined. The value must not be negative. # Corresponds to the JSON property `metricCosts` # @return [Hash] attr_accessor :metric_costs - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -3247,66 +2715,33 @@ module Google # Declares an API Interface to be included in this interface. The including # interface must redeclare all the methods from the included interface, but - # documentation and options are inherited as follows: - # - If after comment and whitespace stripping, the documentation - # string of the redeclared method is empty, it will be inherited - # from the original method. - # - Each annotation belonging to the service config (http, - # visibility) which is not set in the redeclared method will be - # inherited. - # - If an http annotation is inherited, the path pattern will be - # modified as follows. Any version prefix will be replaced by the - # version of the including interface plus the root path if - # specified. - # Example of a simple mixin: - # package google.acl.v1; - # service AccessControl ` - # // Get the underlying ACL object. - # rpc GetAcl(GetAclRequest) returns (Acl) ` - # option (google.api.http).get = "/v1/`resource=**`:getAcl"; - # ` - # ` - # package google.storage.v2; - # service Storage ` - # // rpc GetAcl(GetAclRequest) returns (Acl); - # // Get a data record. - # rpc GetData(GetDataRequest) returns (Data) ` - # option (google.api.http).get = "/v2/`resource=**`"; - # ` - # ` - # Example of a mixin configuration: - # apis: - # - name: google.storage.v2.Storage - # mixins: - # - name: google.acl.v1.AccessControl - # The mixin construct implies that all methods in `AccessControl` are - # also declared with same name and request/response types in - # `Storage`. A documentation generator or annotation processor will - # see the effective `Storage.GetAcl` method after inherting - # documentation and annotations as follows: - # service Storage ` - # // Get the underlying ACL object. - # rpc GetAcl(GetAclRequest) returns (Acl) ` - # option (google.api.http).get = "/v2/`resource=**`:getAcl"; - # ` - # ... - # ` - # Note how the version in the path pattern changed from `v1` to `v2`. - # If the `root` field in the mixin is specified, it should be a - # relative path under which inherited HTTP paths are placed. Example: - # apis: - # - name: google.storage.v2.Storage - # mixins: - # - name: google.acl.v1.AccessControl - # root: acls - # This implies the following inherited HTTP annotation: - # service Storage ` - # // Get the underlying ACL object. - # rpc GetAcl(GetAclRequest) returns (Acl) ` - # option (google.api.http).get = "/v2/acls/`resource=**`:getAcl"; - # ` - # ... - # ` + # documentation and options are inherited as follows: - If after comment and + # whitespace stripping, the documentation string of the redeclared method is + # empty, it will be inherited from the original method. - Each annotation + # belonging to the service config (http, visibility) which is not set in the + # redeclared method will be inherited. - If an http annotation is inherited, the + # path pattern will be modified as follows. Any version prefix will be replaced + # by the version of the including interface plus the root path if specified. + # Example of a simple mixin: package google.acl.v1; service AccessControl ` // + # Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) ` + # option (google.api.http).get = "/v1/`resource=**`:getAcl"; ` ` package google. + # storage.v2; service Storage ` // rpc GetAcl(GetAclRequest) returns (Acl); // + # Get a data record. rpc GetData(GetDataRequest) returns (Data) ` option (google. + # api.http).get = "/v2/`resource=**`"; ` ` Example of a mixin configuration: + # apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1. + # AccessControl The mixin construct implies that all methods in `AccessControl` + # are also declared with same name and request/response types in `Storage`. A + # documentation generator or annotation processor will see the effective ` + # Storage.GetAcl` method after inherting documentation and annotations as + # follows: service Storage ` // Get the underlying ACL object. rpc GetAcl( + # GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=** + # `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1` + # to `v2`. If the `root` field in the mixin is specified, it should be a + # relative path under which inherited HTTP paths are placed. Example: apis: - + # name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl + # root: acls This implies the following inherited HTTP annotation: service + # Storage ` // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns ( + # Acl) ` option (google.api.http).get = "/v2/acls/`resource=**`:getAcl"; ` ... ` class Mixin include Google::Apis::Core::Hashable @@ -3315,8 +2750,7 @@ module Google # @return [String] attr_accessor :name - # If non-empty specifies a path under which inherited HTTP paths - # are rooted. + # If non-empty specifies a path under which inherited HTTP paths are rooted. # Corresponds to the JSON property `root` # @return [String] attr_accessor :root @@ -3332,51 +2766,42 @@ module Google end end - # An object that describes the schema of a MonitoredResource object using a - # type name and a set of labels. For example, the monitored resource - # descriptor for Google Compute Engine VM instances has a type of - # `"gce_instance"` and specifies the use of the labels `"instance_id"` and - # `"zone"` to identify particular VM instances. - # Different services can support different monitored resource types. - # The following are specific rules to service defined monitored resources for - # Monitoring and Logging: - # * The `type`, `display_name`, `description`, `labels` and `launch_stage` - # fields are all required. - # * The first label of the monitored resource descriptor must be - # `resource_container`. There are legacy monitored resource descritptors - # start with `project_id`. - # * It must include a `location` label. - # * Maximum of default 5 service defined monitored resource descriptors - # is allowed per service. - # * Maximum of default 10 labels per monitored resource is allowed. - # The default maximum limit can be overridden. Please follow - # https://cloud.google.com/monitoring/quotas + # An object that describes the schema of a MonitoredResource object using a type + # name and a set of labels. For example, the monitored resource descriptor for + # Google Compute Engine VM instances has a type of `"gce_instance"` and + # specifies the use of the labels `"instance_id"` and `"zone"` to identify + # particular VM instances. Different services can support different monitored + # resource types. The following are specific rules to service defined monitored + # resources for Monitoring and Logging: * The `type`, `display_name`, ` + # description`, `labels` and `launch_stage` fields are all required. * The first + # label of the monitored resource descriptor must be `resource_container`. There + # are legacy monitored resource descritptors start with `project_id`. * It must + # include a `location` label. * Maximum of default 5 service defined monitored + # resource descriptors is allowed per service. * Maximum of default 10 labels + # per monitored resource is allowed. The default maximum limit can be overridden. + # Please follow https://cloud.google.com/monitoring/quotas class MonitoredResourceDescriptor include Google::Apis::Core::Hashable - # Optional. A detailed description of the monitored resource type that might - # be used in documentation. + # Optional. A detailed description of the monitored resource type that might be + # used in documentation. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Optional. A concise name for the monitored resource type that might be - # displayed in user interfaces. It should be a Title Cased Noun Phrase, - # without any article or other determiners. For example, - # `"Google Cloud SQL Database"`. + # displayed in user interfaces. It should be a Title Cased Noun Phrase, without + # any article or other determiners. For example, `"Google Cloud SQL Database"`. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Required. A set of labels used to describe instances of this monitored - # resource type. - # The label key name must follow: - # * Only upper and lower-case letters, digits and underscores (_) are - # allowed. - # * Label name must start with a letter or digit. - # * The maximum length of a label name is 100 characters. - # For example, an individual Google Cloud SQL database is - # identified by values for the labels `database_id` and `location`. + # resource type. The label key name must follow: * Only upper and lower-case + # letters, digits and underscores (_) are allowed. * Label name must start with + # a letter or digit. * The maximum length of a label name is 100 characters. For + # example, an individual Google Cloud SQL database is identified by values for + # the labels `database_id` and `location`. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels @@ -3386,27 +2811,25 @@ module Google # @return [String] attr_accessor :launch_stage - # Optional. The resource name of the monitored resource descriptor: - # `"projects/`project_id`/monitoredResourceDescriptors/`type`"` where - # `type` is the value of the `type` field in this object and - # `project_id` is a project ID that provides API-specific context for - # accessing the type. APIs that do not use project information can use the - # resource name format `"monitoredResourceDescriptors/`type`"`. + # Optional. The resource name of the monitored resource descriptor: `"projects/` + # project_id`/monitoredResourceDescriptors/`type`"` where `type` is the value of + # the `type` field in this object and `project_id` is a project ID that provides + # API-specific context for accessing the type. APIs that do not use project + # information can use the resource name format `"monitoredResourceDescriptors/` + # type`"`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The monitored resource type. For example, the type - # `cloudsql_database` represents databases in Google Cloud SQL. - # All service defined monitored resource types must be prefixed with the - # service name, in the format of ``service name`/`relative resource name``. - # The relative resource name must follow: - # * Only upper and lower-case letters and digits are allowed. - # * It must start with upper case character and is recommended to use Upper - # Camel Case style. - # * The maximum number of characters allowed for the relative_resource_name - # is 100. - # Note there are legacy service monitored resources not following this rule. + # Required. The monitored resource type. For example, the type ` + # cloudsql_database` represents databases in Google Cloud SQL. All service + # defined monitored resource types must be prefixed with the service name, in + # the format of ``service name`/`relative resource name``. The relative resource + # name must follow: * Only upper and lower-case letters and digits are allowed. * + # It must start with upper case character and is recommended to use Upper Camel + # Case style. * The maximum number of characters allowed for the + # relative_resource_name is 100. Note there are legacy service monitored + # resources not following this rule. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -3426,75 +2849,47 @@ module Google end end - # Monitoring configuration of the service. - # The example below shows how to configure monitored resources and metrics - # for monitoring. In the example, a monitored resource and two metrics are - # defined. The `library.googleapis.com/book/returned_count` metric is sent - # to both producer and consumer projects, whereas the - # `library.googleapis.com/book/num_overdue` metric is only sent to the - # consumer project. - # monitored_resources: - # - type: library.googleapis.com/Branch - # display_name: "Library Branch" - # description: "A branch of a library." - # launch_stage: GA - # labels: - # - key: resource_container - # description: "The Cloud container (ie. project id) for the Branch." - # - key: location - # description: "The location of the library branch." - # - key: branch_id - # description: "The id of the branch." - # metrics: - # - name: library.googleapis.com/book/returned_count - # display_name: "Books Returned" - # description: "The count of books that have been returned." - # launch_stage: GA - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # - name: library.googleapis.com/book/num_overdue - # display_name: "Books Overdue" - # description: "The current number of overdue books." - # launch_stage: GA - # metric_kind: GAUGE - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # monitoring: - # producer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # consumer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # - library.googleapis.com/book/num_overdue + # Monitoring configuration of the service. The example below shows how to + # configure monitored resources and metrics for monitoring. In the example, a + # monitored resource and two metrics are defined. The `library.googleapis.com/ + # book/returned_count` metric is sent to both producer and consumer projects, + # whereas the `library.googleapis.com/book/num_overdue` metric is only sent to + # the consumer project. monitored_resources: - type: library.googleapis.com/ + # Branch display_name: "Library Branch" description: "A branch of a library." + # launch_stage: GA labels: - key: resource_container description: "The Cloud + # container (ie. project id) for the Branch." - key: location description: "The + # location of the library branch." - key: branch_id description: "The id of the + # branch." metrics: - name: library.googleapis.com/book/returned_count + # display_name: "Books Returned" description: "The count of books that have been + # returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" + # labels: - key: customer_id description: "The id of the customer." - name: + # library.googleapis.com/book/num_overdue display_name: "Books Overdue" + # description: "The current number of overdue books." launch_stage: GA + # metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id + # description: "The id of the customer." monitoring: producer_destinations: - + # monitored_resource: library.googleapis.com/Branch metrics: - library. + # googleapis.com/book/returned_count consumer_destinations: - monitored_resource: + # library.googleapis.com/Branch metrics: - library.googleapis.com/book/ + # returned_count - library.googleapis.com/book/num_overdue class Monitoring include Google::Apis::Core::Hashable - # Monitoring configurations for sending metrics to the consumer project. - # There can be multiple consumer destinations. A monitored resource type may - # appear in multiple monitoring destinations if different aggregations are - # needed for different sets of metrics associated with that monitored - # resource type. A monitored resource and metric pair may only be used once - # in the Monitoring configuration. + # Monitoring configurations for sending metrics to the consumer project. There + # can be multiple consumer destinations. A monitored resource type may appear in + # multiple monitoring destinations if different aggregations are needed for + # different sets of metrics associated with that monitored resource type. A + # monitored resource and metric pair may only be used once in the Monitoring + # configuration. # Corresponds to the JSON property `consumerDestinations` # @return [Array] attr_accessor :consumer_destinations - # Monitoring configurations for sending metrics to the producer project. - # There can be multiple producer destinations. A monitored resource type may - # appear in multiple monitoring destinations if different aggregations are - # needed for different sets of metrics associated with that monitored - # resource type. A monitored resource and metric pair may only be used once - # in the Monitoring configuration. + # Monitoring configurations for sending metrics to the producer project. There + # can be multiple producer destinations. A monitored resource type may appear in + # multiple monitoring destinations if different aggregations are needed for + # different sets of metrics associated with that monitored resource type. A + # monitored resource and metric pair may only be used once in the Monitoring + # configuration. # Corresponds to the JSON property `producerDestinations` # @return [Array] attr_accessor :producer_destinations @@ -3510,19 +2905,19 @@ module Google end end - # Configuration of a specific monitoring destination (the producer project - # or the consumer project). + # Configuration of a specific monitoring destination (the producer project or + # the consumer project). class MonitoringDestination include Google::Apis::Core::Hashable - # Types of the metrics to report to this monitoring destination. - # Each type must be defined in Service.metrics section. + # Types of the metrics to report to this monitoring destination. Each type must + # be defined in Service.metrics section. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics - # The monitored resource type. The type must be defined in - # Service.monitored_resources section. + # The monitored resource type. The type must be defined in Service. + # monitored_resources section. # Corresponds to the JSON property `monitoredResource` # @return [String] attr_accessor :monitored_resource @@ -3539,27 +2934,25 @@ module Google end # OAuth scopes are a way to define data and permissions on data. For example, - # there are scopes defined for "Read-only access to Google Calendar" and - # "Access to Cloud Platform". Users can consent to a scope for an application, - # giving it permission to access that data on their behalf. - # OAuth scope specifications should be fairly coarse grained; a user will need - # to see and understand the text description of what your scope means. - # In most cases: use one or at most two OAuth scopes for an entire family of - # products. If your product has multiple APIs, you should probably be sharing - # the OAuth scope across all of those APIs. - # When you need finer grained OAuth consent screens: talk with your product - # management about how developers will use them in practice. - # Please note that even though each of the canonical scopes is enough for a - # request to be accepted and passed to the backend, a request can still fail - # due to the backend requiring additional scopes or permissions. + # there are scopes defined for "Read-only access to Google Calendar" and "Access + # to Cloud Platform". Users can consent to a scope for an application, giving it + # permission to access that data on their behalf. OAuth scope specifications + # should be fairly coarse grained; a user will need to see and understand the + # text description of what your scope means. In most cases: use one or at most + # two OAuth scopes for an entire family of products. If your product has + # multiple APIs, you should probably be sharing the OAuth scope across all of + # those APIs. When you need finer grained OAuth consent screens: talk with your + # product management about how developers will use them in practice. Please note + # that even though each of the canonical scopes is enough for a request to be + # accepted and passed to the backend, a request can still fail due to the + # backend requiring additional scopes or permissions. class OAuthRequirements include Google::Apis::Core::Hashable - # The list of publicly documented OAuth scopes that are allowed access. An - # OAuth token containing any of these scopes will be accepted. - # Example: - # canonical_scopes: https://www.googleapis.com/auth/calendar, - # https://www.googleapis.com/auth/calendar.read + # The list of publicly documented OAuth scopes that are allowed access. An OAuth + # token containing any of these scopes will be accepted. Example: + # canonical_scopes: https://www.googleapis.com/auth/calendar, https://www. + # googleapis.com/auth/calendar.read # Corresponds to the JSON property `canonicalScopes` # @return [String] attr_accessor :canonical_scopes @@ -3579,47 +2972,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::ServiceusageV1::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 @@ -3642,8 +3033,7 @@ module Google class OperationMetadata include Google::Apis::Core::Hashable - # The full name of the resources that this operation is directly - # associated with. + # The full name of the resources that this operation is directly associated with. # Corresponds to the JSON property `resourceNames` # @return [Array] attr_accessor :resource_names @@ -3664,17 +3054,17 @@ module Google include Google::Apis::Core::Hashable # The option's name. For protobuf built-in options (options defined in - # descriptor.proto), this is the short name. For example, `"map_entry"`. - # For custom options, it should be the fully-qualified name. For example, - # `"google.api.http"`. + # descriptor.proto), this is the short name. For example, `"map_entry"`. For + # custom options, it should be the fully-qualified name. For example, `"google. + # api.http"`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The option's value packed in an Any message. If the value is a primitive, - # the corresponding wrapper type defined in google/protobuf/wrappers.proto - # should be used. If the value is an enum, it should be stored as an int32 - # value using the google.protobuf.Int32Value type. + # The option's value packed in an Any message. If the value is a primitive, the + # corresponding wrapper type defined in google/protobuf/wrappers.proto should be + # used. If the value is an enum, it should be stored as an int32 value using the + # google.protobuf.Int32Value type. # Corresponds to the JSON property `value` # @return [Hash] attr_accessor :value @@ -3695,32 +3085,25 @@ module Google class Page include Google::Apis::Core::Hashable - # The Markdown content of the page. You can use (== include `path` - # ==) to include content from a Markdown file. + # The Markdown content of the page. You can use (== include `path` ==) to + # include content from a Markdown file. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content - # The name of the page. It will be used as an identity of the page to - # generate URI of the page, text of the link to this page in navigation, - # etc. The full page name (start from the root page name to this page - # concatenated with `.`) can be used as reference to the page in your - # documentation. For example: - # 
pages:
-        # - name: Tutorial
-        # content: (== include tutorial.md ==)
-        # subpages:
-        # - name: Java
-        # content: (== include tutorial_java.md ==)
-        #
- # You can reference `Java` page using Markdown reference link syntax: - # `Java`. + # The name of the page. It will be used as an identity of the page to generate + # URI of the page, text of the link to this page in navigation, etc. The full + # page name (start from the root page name to this page concatenated with `.`) + # can be used as reference to the page in your documentation. For example: pages: + # - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java + # content: (== include tutorial_java.md ==) You can reference `Java` page using + # Markdown reference link syntax: `Java`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Subpages of this page. The order of subpages specified here will be - # honored in the generated docset. + # Subpages of this page. The order of subpages specified here will be honored in + # the generated docset. # Corresponds to the JSON property `subpages` # @return [Array] attr_accessor :subpages @@ -3737,46 +3120,25 @@ module Google end end - # Quota configuration helps to achieve fairness and budgeting in service - # usage. - # The metric based quota configuration works this way: - # - The service configuration defines a set of metrics. - # - For API calls, the quota.metric_rules maps methods to metrics with - # corresponding costs. - # - The quota.limits defines limits on the metrics, which will be used for - # quota checks at runtime. - # An example quota configuration in yaml format: - # quota: - # limits: - # - name: apiWriteQpsPerProject - # metric: library.googleapis.com/write_calls - # unit: "1/min/`project`" # rate limit for consumer projects - # values: - # STANDARD: 10000 - # # The metric rules bind all methods to the read_calls metric, - # # except for the UpdateBook and DeleteBook methods. These two methods - # # are mapped to the write_calls metric, with the UpdateBook method - # # consuming at twice rate as the DeleteBook method. - # metric_rules: - # - selector: "*" - # metric_costs: - # library.googleapis.com/read_calls: 1 - # - selector: google.example.library.v1.LibraryService.UpdateBook - # metric_costs: - # library.googleapis.com/write_calls: 2 - # - selector: google.example.library.v1.LibraryService.DeleteBook - # metric_costs: - # library.googleapis.com/write_calls: 1 - # Corresponding Metric definition: - # metrics: - # - name: library.googleapis.com/read_calls - # display_name: Read requests - # metric_kind: DELTA - # value_type: INT64 - # - name: library.googleapis.com/write_calls - # display_name: Write requests - # metric_kind: DELTA - # value_type: INT64 + # Quota configuration helps to achieve fairness and budgeting in service usage. + # The metric based quota configuration works this way: - The service + # configuration defines a set of metrics. - For API calls, the quota. + # metric_rules maps methods to metrics with corresponding costs. - The quota. + # limits defines limits on the metrics, which will be used for quota checks at + # runtime. An example quota configuration in yaml format: quota: limits: - name: + # apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/` + # project`" # rate limit for consumer projects values: STANDARD: 10000 # The + # metric rules bind all methods to the read_calls metric, # except for the + # UpdateBook and DeleteBook methods. These two methods # are mapped to the + # write_calls metric, with the UpdateBook method # consuming at twice rate as + # the DeleteBook method. metric_rules: - selector: "*" metric_costs: library. + # googleapis.com/read_calls: 1 - selector: google.example.library.v1. + # LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - + # selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: + # library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: + # - name: library.googleapis.com/read_calls display_name: Read requests + # metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/ + # write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 class Quota include Google::Apis::Core::Hashable @@ -3785,8 +3147,8 @@ module Google # @return [Array] attr_accessor :limits - # List of `MetricRule` definitions, each one mapping a selected method to one - # or more metrics. + # List of `MetricRule` definitions, each one mapping a selected method to one or + # more metrics. # Corresponds to the JSON property `metricRules` # @return [Array] attr_accessor :metric_rules @@ -3803,95 +3165,89 @@ module Google end # `QuotaLimit` defines a specific limit that applies over a specified duration - # for a limit type. There can be at most one limit for a duration and limit - # type combination defined within a `QuotaGroup`. + # for a limit type. There can be at most one limit for a duration and limit type + # combination defined within a `QuotaGroup`. class QuotaLimit include Google::Apis::Core::Hashable - # Default number of tokens that can be consumed during the specified - # duration. This is the number of tokens assigned when a client - # application developer activates the service for his/her project. - # Specifying a value of 0 will block all requests. This can be used if you - # are provisioning quota to selected consumers and blocking others. - # Similarly, a value of -1 will indicate an unlimited quota. No other - # negative values are allowed. - # Used by group-based quotas only. + # Default number of tokens that can be consumed during the specified duration. + # This is the number of tokens assigned when a client application developer + # activates the service for his/her project. Specifying a value of 0 will block + # all requests. This can be used if you are provisioning quota to selected + # consumers and blocking others. Similarly, a value of -1 will indicate an + # unlimited quota. No other negative values are allowed. Used by group-based + # quotas only. # Corresponds to the JSON property `defaultLimit` # @return [Fixnum] attr_accessor :default_limit - # Optional. User-visible, extended description for this quota limit. - # Should be used only when more context is needed to understand this limit - # than provided by the limit's display name (see: `display_name`). + # Optional. User-visible, extended description for this quota limit. Should be + # used only when more context is needed to understand this limit than provided + # by the limit's display name (see: `display_name`). # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # User-visible display name for this limit. - # Optional. If not set, the UI will provide a default display name based on - # the quota configuration. This field can be used to override the default - # display name generated from the configuration. + # User-visible display name for this limit. Optional. If not set, the UI will + # provide a default display name based on the quota configuration. This field + # can be used to override the default display name generated from the + # configuration. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Duration of this limit in textual notation. Must be "100s" or "1d". - # Used by group-based quotas only. + # Duration of this limit in textual notation. Must be "100s" or "1d". Used by + # group-based quotas only. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration - # Free tier value displayed in the Developers Console for this limit. - # The free tier is the number of tokens that will be subtracted from the - # billed amount when billing is enabled. - # This field can only be set on a limit with duration "1d", in a billable - # group; it is invalid on any other limit. If this field is not set, it - # defaults to 0, indicating that there is no free tier for this service. - # Used by group-based quotas only. + # Free tier value displayed in the Developers Console for this limit. The free + # tier is the number of tokens that will be subtracted from the billed amount + # when billing is enabled. This field can only be set on a limit with duration " + # 1d", in a billable group; it is invalid on any other limit. If this field is + # not set, it defaults to 0, indicating that there is no free tier for this + # service. Used by group-based quotas only. # Corresponds to the JSON property `freeTier` # @return [Fixnum] attr_accessor :free_tier - # Maximum number of tokens that can be consumed during the specified - # duration. Client application developers can override the default limit up - # to this maximum. If specified, this value cannot be set to a value less - # than the default limit. If not specified, it is set to the default limit. - # To allow clients to apply overrides with no upper bound, set this to -1, - # indicating unlimited maximum quota. - # Used by group-based quotas only. + # Maximum number of tokens that can be consumed during the specified duration. + # Client application developers can override the default limit up to this + # maximum. If specified, this value cannot be set to a value less than the + # default limit. If not specified, it is set to the default limit. To allow + # clients to apply overrides with no upper bound, set this to -1, indicating + # unlimited maximum quota. Used by group-based quotas only. # Corresponds to the JSON property `maxLimit` # @return [Fixnum] attr_accessor :max_limit - # The name of the metric this quota limit applies to. The quota limits with - # the same metric will be checked together during runtime. The metric must be + # The name of the metric this quota limit applies to. The quota limits with the + # same metric will be checked together during runtime. The metric must be # defined within the service config. # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric - # Name of the quota limit. - # The name must be provided, and it must be unique within the service. The - # name can only include alphanumeric characters as well as '-'. - # The maximum length of the limit name is 64 characters. + # Name of the quota limit. The name must be provided, and it must be unique + # within the service. The name can only include alphanumeric characters as well + # as '-'. The maximum length of the limit name is 64 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Specify the unit of the quota limit. It uses the same syntax as - # Metric.unit. The supported unit kinds are determined by the quota - # backend system. - # Here are some examples: - # * "1/min/`project`" for quota per minute per project. - # Note: the order of unit components is insignificant. - # The "1" at the beginning is required to follow the metric unit syntax. + # Specify the unit of the quota limit. It uses the same syntax as Metric.unit. + # The supported unit kinds are determined by the quota backend system. Here are + # some examples: * "1/min/`project`" for quota per minute per project. Note: the + # order of unit components is insignificant. The "1" at the beginning is + # required to follow the metric unit syntax. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit # Tiered limit values. You must specify this as a key:value pair, with an - # integer value that is the maximum number of requests allowed for the - # specified unit. Currently only STANDARD is supported. + # integer value that is the maximum number of requests allowed for the specified + # unit. Currently only STANDARD is supported. # Corresponds to the JSON property `values` # @return [Hash] attr_accessor :values @@ -3919,66 +3275,58 @@ module Google class QuotaOverride include Google::Apis::Core::Hashable - # The resource name of the ancestor that requested the override. For example: - # "organizations/12345" or "folders/67890". - # Used by admin overrides only. + # The resource name of the ancestor that requested the override. For example: " + # organizations/12345" or "folders/67890". Used by admin overrides only. # Corresponds to the JSON property `adminOverrideAncestor` # @return [String] attr_accessor :admin_override_ancestor # If this map is nonempty, then this override applies only to specific values - # for dimensions defined in the limit unit. - # For example, an override on a limit with the unit 1/`project`/`region` - # could contain an entry with the key "region" and the value "us-east-1"; - # the override is only applied to quota consumed in that region. - # This map has the following restrictions: - # * Keys that are not defined in the limit's unit are not valid keys. - # Any string appearing in `brackets` in the unit (besides `project` or - # `user`) is a defined key. - # * "project" is not a valid key; the project is already specified in - # the parent resource name. - # * "user" is not a valid key; the API does not support quota overrides - # that apply only to a specific user. - # * If "region" appears as a key, its value must be a valid Cloud region. - # * If "zone" appears as a key, its value must be a valid Cloud zone. - # * If any valid key other than "region" or "zone" appears in the map, then - # all valid keys other than "region" or "zone" must also appear in the - # map. + # for dimensions defined in the limit unit. For example, an override on a limit + # with the unit 1/`project`/`region` could contain an entry with the key "region" + # and the value "us-east-1"; the override is only applied to quota consumed in + # that region. This map has the following restrictions: * Keys that are not + # defined in the limit's unit are not valid keys. Any string appearing in ` + # brackets` in the unit (besides `project` or `user`) is a defined key. * " + # project" is not a valid key; the project is already specified in the parent + # resource name. * "user" is not a valid key; the API does not support quota + # overrides that apply only to a specific user. * If "region" appears as a key, + # its value must be a valid Cloud region. * If "zone" appears as a key, its + # value must be a valid Cloud zone. * If any valid key other than "region" or " + # zone" appears in the map, then all valid keys other than "region" or "zone" + # must also appear in the map. # Corresponds to the JSON property `dimensions` # @return [Hash] attr_accessor :dimensions - # The name of the metric to which this override applies. - # An example name would be: - # `compute.googleapis.com/cpus` + # The name of the metric to which this override applies. An example name would + # be: `compute.googleapis.com/cpus` # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric - # The resource name of the override. - # This name is generated by the server when the override is created. - # Example names would be: - # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. - # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` - # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. - # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` - # The resource name is intended to be opaque and should not be parsed for - # its component strings, since its representation could change in the future. + # The resource name of the override. This name is generated by the server when + # the override is created. Example names would be: `projects/123/services/ + # compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/ + # limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` `projects/123/services/ + # compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/ + # limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` The resource name is + # intended to be opaque and should not be parsed for its component strings, + # since its representation could change in the future. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The overriding quota limit value. - # Can be any nonnegative integer, or -1 (unlimited quota). + # The overriding quota limit value. Can be any nonnegative integer, or -1 ( + # unlimited quota). # Corresponds to the JSON property `overrideValue` # @return [Fixnum] attr_accessor :override_value - # The limit unit of the limit to which this override applies. - # An example unit would be: - # `1/`project`/`region`` - # Note that ``project`` and ``region`` are not placeholders in this example; - # the literal characters ``` and ``` occur in the string. + # The limit unit of the limit to which this override applies. An example unit + # would be: `1/`project`/`region`` Note that ``project`` and ``region`` are not + # placeholders in this example; the literal characters ``` and ``` occur in the + # string. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit @@ -4003,15 +3351,14 @@ module Google class ServiceIdentity include Google::Apis::Core::Hashable - # The email address of the service account that a service producer would use - # to access consumer resources. + # The email address of the service account that a service producer would use to + # access consumer resources. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email - # The unique and stable id of the service account. - # https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts# - # ServiceAccount + # The unique and stable id of the service account. https://cloud.google.com/iam/ + # reference/rest/v1/projects.serviceAccounts#ServiceAccount # Corresponds to the JSON property `uniqueId` # @return [String] attr_accessor :unique_id @@ -4027,13 +3374,13 @@ module Google end end - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. class SourceContext include Google::Apis::Core::Hashable # The path-qualified name of the .proto file that contained the associated - # protobuf element. For example: `"google/protobuf/source_context.proto"`. + # protobuf element. For example: `"google/protobuf/source_context.proto"`. # Corresponds to the JSON property `fileName` # @return [String] attr_accessor :file_name @@ -4067,12 +3414,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 @@ -4081,15 +3428,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 @@ -4112,8 +3459,7 @@ module Google class SystemParameter include Google::Apis::Core::Hashable - # Define the HTTP header name to use for the parameter. It is case - # insensitive. + # Define the HTTP header name to use for the parameter. It is case insensitive. # Corresponds to the JSON property `httpHeader` # @return [String] attr_accessor :http_header @@ -4141,23 +3487,20 @@ module Google end end - # Define a system parameter rule mapping system parameter definitions to - # methods. + # Define a system parameter rule mapping system parameter definitions to methods. class SystemParameterRule include Google::Apis::Core::Hashable - # Define parameters. Multiple names may be defined for a parameter. - # For a given method call, only one of them should be used. If multiple - # names are used the behavior is implementation-dependent. - # If none of the specified names are present the behavior is - # parameter-dependent. + # Define parameters. Multiple names may be defined for a parameter. For a given + # method call, only one of them should be used. If multiple names are used the + # behavior is implementation-dependent. If none of the specified names are + # present the behavior is parameter-dependent. # Corresponds to the JSON property `parameters` # @return [Array] attr_accessor :parameters # Selects the methods to which this rule applies. Use '*' to indicate all - # methods in all APIs. - # Refer to selector for syntax details. + # methods in all APIs. Refer to selector for syntax details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -4173,36 +3516,23 @@ module Google end end - # ### System parameter configuration - # A system parameter is a special kind of parameter defined by the API - # system, not by an individual API. It is typically mapped to an HTTP header - # and/or a URL query parameter. This configuration specifies which methods - # change the names of the system parameters. + # ### System parameter configuration A system parameter is a special kind of + # parameter defined by the API system, not by an individual API. It is typically + # mapped to an HTTP header and/or a URL query parameter. This configuration + # specifies which methods change the names of the system parameters. class SystemParameters include Google::Apis::Core::Hashable - # Define system parameters. - # The parameters defined here will override the default parameters - # implemented by the system. If this field is missing from the service - # config, default system parameters will be used. Default system parameters - # and names is implementation-dependent. - # Example: define api key for all methods - # system_parameters - # rules: - # - selector: "*" - # parameters: - # - name: api_key - # url_query_parameter: api_key - # Example: define 2 api key names for a specific method. - # system_parameters - # rules: - # - selector: "/ListShelves" - # parameters: - # - name: api_key - # http_header: Api-Key1 - # - name: api_key - # http_header: Api-Key2 - # **NOTE:** All service configuration rules follow "last one wins" order. + # Define system parameters. The parameters defined here will override the + # default parameters implemented by the system. If this field is missing from + # the service config, default system parameters will be used. Default system + # parameters and names is implementation-dependent. Example: define api key for + # all methods system_parameters rules: - selector: "*" parameters: - name: + # api_key url_query_parameter: api_key Example: define 2 api key names for a + # specific method. system_parameters rules: - selector: "/ListShelves" + # parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: + # Api-Key2 **NOTE:** All service configuration rules follow "last one wins" + # order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -4241,8 +3571,8 @@ module Google # @return [Array] attr_accessor :options - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. # Corresponds to the JSON property `sourceContext` # @return [Google::Apis::ServiceusageV1::SourceContext] attr_accessor :source_context @@ -4272,37 +3602,33 @@ module Google include Google::Apis::Core::Hashable # The full resource name of a channel used for sending notifications to the - # service producer. - # Google Service Management currently only supports - # [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification - # channel. To use Google Cloud Pub/Sub as the channel, this must be the name - # of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format - # documented in https://cloud.google.com/pubsub/docs/overview. + # service producer. Google Service Management currently only supports [Google + # Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To + # use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/ + # Sub topic that uses the Cloud Pub/Sub topic name format documented in https:// + # cloud.google.com/pubsub/docs/overview. # Corresponds to the JSON property `producerNotificationChannel` # @return [String] attr_accessor :producer_notification_channel # Requirements that must be satisfied before a consumer project can use the - # service. Each requirement is of the form /; - # for example 'serviceusage.googleapis.com/billing-enabled'. + # service. Each requirement is of the form /; for example 'serviceusage. + # googleapis.com/billing-enabled'. # Corresponds to the JSON property `requirements` # @return [Array] attr_accessor :requirements - # A list of usage rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of usage rules that apply to individual API methods. **NOTE:** All + # service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules - # The per-product per-project service identity for a service. - # Use this field to configure per-product per-project service identity. - # Example of a service identity configuration. - # usage: - # service_identity: - # - service_account_parent: "projects/123456789" - # display_name: "Cloud XXX Service Agent" - # description: "Used as the identity of Cloud XXX to access resources" + # The per-product per-project service identity for a service. Use this field to + # configure per-product per-project service identity. Example of a service + # identity configuration. usage: service_identity: - service_account_parent: " + # projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used + # as the identity of Cloud XXX to access resources" # Corresponds to the JSON property `serviceIdentity` # @return [Google::Apis::ServiceusageV1::GoogleApiServiceIdentity] attr_accessor :service_identity @@ -4320,45 +3646,36 @@ module Google end end - # Usage configuration rules for the service. - # NOTE: Under development. - # Use this rule to configure unregistered calls for the service. Unregistered - # calls are calls that do not contain consumer project identity. - # (Example: calls that do not contain an API key). - # By default, API methods do not allow unregistered calls, and each method call - # must be identified by a consumer project identity. Use this rule to - # allow/disallow unregistered calls. - # Example of an API that wants to allow unregistered calls for entire service. - # usage: - # rules: - # - selector: "*" - # allow_unregistered_calls: true - # Example of a method that wants to allow unregistered calls. - # usage: - # rules: - # - selector: "google.example.library.v1.LibraryService.CreateBook" - # allow_unregistered_calls: true + # Usage configuration rules for the service. NOTE: Under development. Use this + # rule to configure unregistered calls for the service. Unregistered calls are + # calls that do not contain consumer project identity. (Example: calls that do + # not contain an API key). By default, API methods do not allow unregistered + # calls, and each method call must be identified by a consumer project identity. + # Use this rule to allow/disallow unregistered calls. Example of an API that + # wants to allow unregistered calls for entire service. usage: rules: - selector: + # "*" allow_unregistered_calls: true Example of a method that wants to allow + # unregistered calls. usage: rules: - selector: "google.example.library.v1. + # LibraryService.CreateBook" allow_unregistered_calls: true class UsageRule include Google::Apis::Core::Hashable - # If true, the selected method allows unregistered calls, e.g. calls - # that don't identify any user or application. + # If true, the selected method allows unregistered calls, e.g. calls that don't + # identify any user or application. # Corresponds to the JSON property `allowUnregisteredCalls` # @return [Boolean] attr_accessor :allow_unregistered_calls alias_method :allow_unregistered_calls?, :allow_unregistered_calls # Selects the methods to which this rule applies. Use '*' to indicate all - # methods in all APIs. - # Refer to selector for syntax details. + # methods in all APIs. Refer to selector for syntax details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector - # If true, the selected method should skip service control and the control - # plane features, such as quota and billing, will not be available. - # This flag is used by Google Cloud Endpoints to bypass checks for internal - # methods, such as service health check methods. + # If true, the selected method should skip service control and the control plane + # features, such as quota and billing, will not be available. This flag is used + # by Google Cloud Endpoints to bypass checks for internal methods, such as + # service health check methods. # Corresponds to the JSON property `skipServiceControl` # @return [Boolean] attr_accessor :skip_service_control diff --git a/generated/google/apis/serviceusage_v1/service.rb b/generated/google/apis/serviceusage_v1/service.rb index daa72bad8..8c9dbfdf9 100644 --- a/generated/google/apis/serviceusage_v1/service.rb +++ b/generated/google/apis/serviceusage_v1/service.rb @@ -49,15 +49,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. @@ -91,10 +89,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 @@ -124,9 +122,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 @@ -156,15 +153,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] filter # The standard list filter. # @param [String] name @@ -204,13 +200,12 @@ module Google end # Enable multiple services on a project. The operation is atomic: if enabling - # any service fails, then the entire batch fails, and no state changes occur. - # To enable a single service, use the `EnableService` method instead. + # any service fails, then the entire batch fails, and no state changes occur. To + # enable a single service, use the `EnableService` method instead. # @param [String] parent - # Parent to enable services on. - # An example name would be: - # `projects/123` where `123` is the project number. - # The `BatchEnableServices` method currently only supports projects. + # Parent to enable services on. An example name would be: `projects/123` where ` + # 123` is the project number. The `BatchEnableServices` method currently only + # supports projects. # @param [Google::Apis::ServiceusageV1::BatchEnableServicesRequest] batch_enable_services_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -244,17 +239,14 @@ module Google # Returns the service configurations and enabled states for a given list of # services. # @param [String] parent - # Parent to retrieve services from. - # If this is set, the parent of all of the services specified in `names` must - # match this field. An example name would be: `projects/123` where `123` is - # the project number. The `BatchGetServices` method currently only supports - # projects. + # Parent to retrieve services from. If this is set, the parent of all of the + # services specified in `names` must match this field. An example name would be: + # `projects/123` where `123` is the project number. The `BatchGetServices` + # method currently only supports projects. # @param [Array, String] names - # Names of the services to retrieve. - # An example name would be: - # `projects/123/services/serviceusage.googleapis.com` where `123` is the - # project number. - # A single request can get a maximum of 30 services at a time. + # Names of the services to retrieve. An example name would be: `projects/123/ + # services/serviceusage.googleapis.com` where `123` is the project number. A + # single request can get a maximum of 30 services at a time. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -283,18 +275,16 @@ module Google execute_or_queue_command(command, &block) end - # Disable a service so that it can no longer be used with a project. - # This prevents unintended usage that may cause unexpected billing - # charges or security leaks. - # It is not valid to call the disable method on a service that is not - # currently enabled. Callers will receive a `FAILED_PRECONDITION` status if - # the target service is not currently enabled. + # Disable a service so that it can no longer be used with a project. This + # prevents unintended usage that may cause unexpected billing charges or + # security leaks. It is not valid to call the disable method on a service that + # is not currently enabled. Callers will receive a `FAILED_PRECONDITION` status + # if the target service is not currently enabled. # @param [String] name - # Name of the consumer and service to disable the service on. - # The enable and disable methods currently only support projects. - # An example name would be: - # `projects/123/services/serviceusage.googleapis.com` where `123` is the - # project number. + # Name of the consumer and service to disable the service on. The enable and + # disable methods currently only support projects. An example name would be: ` + # projects/123/services/serviceusage.googleapis.com` where `123` is the project + # number. # @param [Google::Apis::ServiceusageV1::DisableServiceRequest] disable_service_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -327,14 +317,11 @@ module Google # Enable a service so that it can be used with a project. # @param [String] name - # Name of the consumer and service to enable the service on. - # The `EnableService` and `DisableService` methods currently only support - # projects. - # Enabling a service requires that the service is public or is shared with - # the user enabling the service. - # An example name would be: - # `projects/123/services/serviceusage.googleapis.com` where `123` is the - # project number. + # Name of the consumer and service to enable the service on. The `EnableService` + # and `DisableService` methods currently only support projects. Enabling a + # service requires that the service is public or is shared with the user + # enabling the service. An example name would be: `projects/123/services/ + # serviceusage.googleapis.com` where `123` is the project number. # @param [Google::Apis::ServiceusageV1::EnableServiceRequest] enable_service_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -367,10 +354,9 @@ module Google # Returns the service configuration and enabled state for a given service. # @param [String] name - # Name of the consumer and service to get the `ConsumerState` for. - # An example name would be: - # `projects/123/services/serviceusage.googleapis.com` where `123` is the - # project number. + # Name of the consumer and service to get the `ConsumerState` for. An example + # name would be: `projects/123/services/serviceusage.googleapis.com` where `123` + # is the project number. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -398,27 +384,24 @@ module Google execute_or_queue_command(command, &block) end - # List all services available to the specified project, and the current - # state of those services with respect to the project. The list includes - # all public services, all services for which the calling user has the - # `servicemanagement.services.bind` permission, and all services that have - # already been enabled on the project. The list can be filtered to - # only include services in a specific state, for example to only include - # services enabled on the project. + # List all services available to the specified project, and the current state of + # those services with respect to the project. The list includes all public + # services, all services for which the calling user has the `servicemanagement. + # services.bind` permission, and all services that have already been enabled on + # the project. The list can be filtered to only include services in a specific + # state, for example to only include services enabled on the project. # @param [String] parent - # Parent to search for services on. - # An example name would be: - # `projects/123` where `123` is the project number. + # Parent to search for services on. An example name would be: `projects/123` + # where `123` is the project number. # @param [String] filter - # Only list services that conform to the given filter. - # The allowed filter strings are `state:ENABLED` and `state:DISABLED`. + # Only list services that conform to the given filter. The allowed filter + # strings are `state:ENABLED` and `state:DISABLED`. # @param [Fixnum] page_size - # Requested size of the next page of data. - # Requested page size cannot exceed 200. + # Requested size of the next page of data. Requested page size cannot exceed 200. # If not set, the default page size is 50. # @param [String] page_token - # Token identifying which result to start with, which is returned by a - # previous list call. + # Token identifying which result to start with, which is returned by a previous + # list call. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/serviceusage_v1beta1.rb b/generated/google/apis/serviceusage_v1beta1.rb index 3e25e850c..ae155bf75 100644 --- a/generated/google/apis/serviceusage_v1beta1.rb +++ b/generated/google/apis/serviceusage_v1beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/service-usage/ module ServiceusageV1beta1 VERSION = 'V1beta1' - REVISION = '20200721' + REVISION = '20200801' # 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/serviceusage_v1beta1/classes.rb b/generated/google/apis/serviceusage_v1beta1/classes.rb index aa75d5b53..f5bb06ab0 100644 --- a/generated/google/apis/serviceusage_v1beta1/classes.rb +++ b/generated/google/apis/serviceusage_v1beta1/classes.rb @@ -26,53 +26,48 @@ module Google class AdminQuotaPolicy include Google::Apis::Core::Hashable - # The cloud resource container at which the quota policy is created. The - # format is `container_type`/`container_number` + # The cloud resource container at which the quota policy is created. The format + # is `container_type`/`container_number` # Corresponds to the JSON property `container` # @return [String] attr_accessor :container - # If this map is nonempty, then this policy applies only to specific values - # for dimensions defined in the limit unit. - # For example, an policy on a limit with the unit 1/`project`/`region` - # could contain an entry with the key "region" and the value "us-east-1"; - # the policy is only applied to quota consumed in that region. - # This map has the following restrictions: - # * If "region" appears as a key, its value must be a valid Cloud region. - # * If "zone" appears as a key, its value must be a valid Cloud zone. - # * Keys other than "region" or "zone" are not valid. + # If this map is nonempty, then this policy applies only to specific values for + # dimensions defined in the limit unit. For example, an policy on a limit with + # the unit 1/`project`/`region` could contain an entry with the key "region" and + # the value "us-east-1"; the policy is only applied to quota consumed in that + # region. This map has the following restrictions: * If "region" appears as a + # key, its value must be a valid Cloud region. * If "zone" appears as a key, its + # value must be a valid Cloud zone. * Keys other than "region" or "zone" are not + # valid. # Corresponds to the JSON property `dimensions` # @return [Hash] attr_accessor :dimensions - # The name of the metric to which this policy applies. - # An example name would be: + # The name of the metric to which this policy applies. An example name would be: # `compute.googleapis.com/cpus` # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric - # The resource name of the policy. - # This name is generated by the server when the policy is created. - # Example names would be: - # `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/ - # compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/ - # 4a3f2c1d` + # The resource name of the policy. This name is generated by the server when the + # policy is created. Example names would be: `organizations/123/services/compute. + # googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/% + # 2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The quota policy value. - # Can be any nonnegative integer, or -1 (unlimited quota). + # The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota) + # . # Corresponds to the JSON property `policyValue` # @return [Fixnum] attr_accessor :policy_value - # The limit unit of the limit to which this policy applies. - # An example unit would be: - # `1/`project`/`region`` - # Note that ``project`` and ``region`` are not placeholders in this example; - # the literal characters ``` and ``` occur in the string. + # The limit unit of the limit to which this policy applies. An example unit + # would be: `1/`project`/`region`` Note that ``project`` and ``region`` are not + # placeholders in this example; the literal characters ``` and ``` occur in the + # string. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit @@ -92,14 +87,13 @@ module Google end end - # Api is a light-weight descriptor for an API Interface. - # Interfaces are also described as "protocol buffer services" in some contexts, - # such as by the "service" keyword in a .proto file, but they are different - # from API Services, which represent a concrete implementation of an interface - # as opposed to simply a description of methods and bindings. They are also - # sometimes simply referred to as "APIs" in other contexts, such as the name of - # this message itself. See https://cloud.google.com/apis/design/glossary for - # detailed terminology. + # Api is a light-weight descriptor for an API Interface. Interfaces are also + # described as "protocol buffer services" in some contexts, such as by the " + # service" keyword in a .proto file, but they are different from API Services, + # which represent a concrete implementation of an interface as opposed to simply + # a description of methods and bindings. They are also sometimes simply referred + # to as "APIs" in other contexts, such as the name of this message itself. See + # https://cloud.google.com/apis/design/glossary for detailed terminology. class Api include Google::Apis::Core::Hashable @@ -113,8 +107,8 @@ module Google # @return [Array] attr_accessor :mixins - # The fully qualified name of this interface, including package name - # followed by the interface's simple name. + # The fully qualified name of this interface, including package name followed by + # the interface's simple name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -124,8 +118,8 @@ module Google # @return [Array] attr_accessor :options - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. # Corresponds to the JSON property `sourceContext` # @return [Google::Apis::ServiceusageV1beta1::SourceContext] attr_accessor :source_context @@ -135,23 +129,19 @@ module Google # @return [String] attr_accessor :syntax - # A version string for this interface. If specified, must have the form - # `major-version.minor-version`, as in `1.10`. If the minor version is - # omitted, it defaults to zero. If the entire version field is empty, the - # major version is derived from the package name, as outlined below. If the - # field is not empty, the version in the package name will be verified to be - # consistent with what is provided here. - # The versioning schema uses [semantic - # versioning](http://semver.org) where the major version number - # indicates a breaking change and the minor version an additive, - # non-breaking change. Both version numbers are signals to users - # what to expect from different versions, and should be carefully - # chosen based on the product plan. - # The major version is also reflected in the package name of the - # interface, which must end in `v`, as in - # `google.feature.v1`. For major versions 0 and 1, the suffix can - # be omitted. Zero major versions must only be used for - # experimental, non-GA interfaces. + # A version string for this interface. If specified, must have the form `major- + # version.minor-version`, as in `1.10`. If the minor version is omitted, it + # defaults to zero. If the entire version field is empty, the major version is + # derived from the package name, as outlined below. If the field is not empty, + # the version in the package name will be verified to be consistent with what is + # provided here. The versioning schema uses [semantic versioning](http://semver. + # org) where the major version number indicates a breaking change and the minor + # version an additive, non-breaking change. Both version numbers are signals to + # users what to expect from different versions, and should be carefully chosen + # based on the product plan. The major version is also reflected in the package + # name of the interface, which must end in `v`, as in `google.feature.v1`. For + # major versions 0 and 1, the suffix can be omitted. Zero major versions must + # only be used for experimental, non-GA interfaces. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -172,85 +162,63 @@ module Google end end - # Configuration for an authentication provider, including support for - # [JSON Web Token - # (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + # Configuration for an authentication provider, including support for [JSON Web + # Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). class AuthProvider include Google::Apis::Core::Hashable - # The list of JWT - # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32# - # section-4.1.3). - # that are allowed to access. A JWT containing any of these audiences will - # be accepted. When this setting is absent, JWTs with audiences: - # - "https://[service.name]/[google.protobuf.Api.name]" - # - "https://[service.name]/" - # will be accepted. - # For example, if no audiences are in the setting, LibraryService API will - # accept JWTs with the following audiences: - # - + # The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json- + # web-token-32#section-4.1.3). that are allowed to access. A JWT containing any + # of these audiences will be accepted. When this setting is absent, JWTs with + # audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[ + # service.name]/" will be accepted. For example, if no audiences are in the + # setting, LibraryService API will accept JWTs with the following audiences: - # https://library-example.googleapis.com/google.example.library.v1. - # LibraryService - # - https://library-example.googleapis.com/ - # Example: - # audiences: bookstore_android.apps.googleusercontent.com, - # bookstore_web.apps.googleusercontent.com + # LibraryService - https://library-example.googleapis.com/ Example: audiences: + # bookstore_android.apps.googleusercontent.com, bookstore_web.apps. + # googleusercontent.com # Corresponds to the JSON property `audiences` # @return [String] attr_accessor :audiences - # Redirect URL if JWT token is required but not present or is expired. - # Implement authorizationUrl of securityDefinitions in OpenAPI spec. + # Redirect URL if JWT token is required but not present or is expired. Implement + # authorizationUrl of securityDefinitions in OpenAPI spec. # Corresponds to the JSON property `authorizationUrl` # @return [String] attr_accessor :authorization_url - # The unique identifier of the auth provider. It will be referred to by - # `AuthRequirement.provider_id`. - # Example: "bookstore_auth". + # The unique identifier of the auth provider. It will be referred to by ` + # AuthRequirement.provider_id`. Example: "bookstore_auth". # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Identifies the principal that issued the JWT. See - # https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - # Usually a URL or an email address. - # Example: https://securetoken.google.com - # Example: 1234567-compute@developer.gserviceaccount.com + # Identifies the principal that issued the JWT. See https://tools.ietf.org/html/ + # draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email + # address. Example: https://securetoken.google.com Example: 1234567-compute@ + # developer.gserviceaccount.com # Corresponds to the JSON property `issuer` # @return [String] attr_accessor :issuer - # URL of the provider's public key set to validate signature of the JWT. See - # [OpenID - # Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html# - # ProviderMetadata). - # Optional if the key set document: - # - can be retrieved from - # [OpenID - # Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of - # the issuer. - # - can be inferred from the email domain of the issuer (e.g. a Google - # service account). - # Example: https://www.googleapis.com/oauth2/v1/certs + # URL of the provider's public key set to validate signature of the JWT. See [ + # OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html# + # ProviderMetadata). Optional if the key set document: - can be retrieved from [ + # OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html + # of the issuer. - can be inferred from the email domain of the issuer (e.g. a + # Google service account). Example: https://www.googleapis.com/oauth2/v1/certs # Corresponds to the JSON property `jwksUri` # @return [String] attr_accessor :jwks_uri - # Defines the locations to extract the JWT. - # JWT locations can be either from HTTP headers or URL query parameters. - # The rule is that the first match wins. The checking order is: checking - # all headers first, then URL query parameters. - # If not specified, default to use following 3 locations: - # 1) Authorization: Bearer - # 2) x-goog-iap-jwt-assertion - # 3) access_token query parameter - # Default locations can be specified as followings: - # jwt_locations: - # - header: Authorization - # value_prefix: "Bearer " - # - header: x-goog-iap-jwt-assertion - # - query: access_token + # Defines the locations to extract the JWT. JWT locations can be either from + # HTTP headers or URL query parameters. The rule is that the first match wins. + # The checking order is: checking all headers first, then URL query parameters. + # If not specified, default to use following 3 locations: 1) Authorization: + # Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default + # locations can be specified as followings: jwt_locations: - header: + # Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - + # query: access_token # Corresponds to the JSON property `jwtLocations` # @return [Array] attr_accessor :jwt_locations @@ -270,34 +238,26 @@ module Google end end - # User-defined authentication requirements, including support for - # [JSON Web Token - # (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + # User-defined authentication requirements, including support for [JSON Web + # Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). class AuthRequirement include Google::Apis::Core::Hashable - # NOTE: This will be deprecated soon, once AuthProvider.audiences is - # implemented and accepted in all the runtime components. - # The list of JWT - # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32# - # section-4.1.3). - # that are allowed to access. A JWT containing any of these audiences will - # be accepted. When this setting is absent, only JWTs with audience - # "https://Service_name/API_name" - # will be accepted. For example, if no audiences are in the setting, - # LibraryService API will only accept JWTs with the following audience - # "https://library-example.googleapis.com/google.example.library.v1. - # LibraryService". - # Example: - # audiences: bookstore_android.apps.googleusercontent.com, - # bookstore_web.apps.googleusercontent.com + # NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented + # and accepted in all the runtime components. The list of JWT [audiences](https:/ + # /tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that + # are allowed to access. A JWT containing any of these audiences will be + # accepted. When this setting is absent, only JWTs with audience "https:// + # Service_name/API_name" will be accepted. For example, if no audiences are in + # the setting, LibraryService API will only accept JWTs with the following + # audience "https://library-example.googleapis.com/google.example.library.v1. + # LibraryService". Example: audiences: bookstore_android.apps.googleusercontent. + # com, bookstore_web.apps.googleusercontent.com # Corresponds to the JSON property `audiences` # @return [String] attr_accessor :audiences - # id from authentication provider. - # Example: - # provider_id: bookstore_auth + # id from authentication provider. Example: provider_id: bookstore_auth # Corresponds to the JSON property `providerId` # @return [String] attr_accessor :provider_id @@ -313,18 +273,11 @@ module Google end end - # `Authentication` defines the authentication configuration for an API. - # Example for an API targeted for external use: - # name: calendar.googleapis.com - # authentication: - # providers: - # - id: google_calendar_auth - # jwks_uri: https://www.googleapis.com/oauth2/v1/certs - # issuer: https://securetoken.google.com - # rules: - # - selector: "*" - # requirements: - # provider_id: google_calendar_auth + # `Authentication` defines the authentication configuration for an API. Example + # for an API targeted for external use: name: calendar.googleapis.com + # authentication: providers: - id: google_calendar_auth jwks_uri: https://www. + # googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - + # selector: "*" requirements: provider_id: google_calendar_auth class Authentication include Google::Apis::Core::Hashable @@ -333,8 +286,8 @@ module Google # @return [Array] attr_accessor :providers - # A list of authentication rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of authentication rules that apply to individual API methods. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -350,13 +303,11 @@ module Google end end - # Authentication rules for the service. - # By default, if a method has any authentication requirements, every request - # must include a valid credential matching one of the requirements. - # It's an error to include more than one kind of credential in a single - # request. - # If a method doesn't have any auth requirements, request credentials will be - # ignored. + # Authentication rules for the service. By default, if a method has any + # authentication requirements, every request must include a valid credential + # matching one of the requirements. It's an error to include more than one kind + # of credential in a single request. If a method doesn't have any auth + # requirements, request credentials will be ignored. class AuthenticationRule include Google::Apis::Core::Hashable @@ -367,19 +318,18 @@ module Google alias_method :allow_without_credential?, :allow_without_credential # OAuth scopes are a way to define data and permissions on data. For example, - # there are scopes defined for "Read-only access to Google Calendar" and - # "Access to Cloud Platform". Users can consent to a scope for an application, - # giving it permission to access that data on their behalf. - # OAuth scope specifications should be fairly coarse grained; a user will need - # to see and understand the text description of what your scope means. - # In most cases: use one or at most two OAuth scopes for an entire family of - # products. If your product has multiple APIs, you should probably be sharing - # the OAuth scope across all of those APIs. - # When you need finer grained OAuth consent screens: talk with your product - # management about how developers will use them in practice. - # Please note that even though each of the canonical scopes is enough for a - # request to be accepted and passed to the backend, a request can still fail - # due to the backend requiring additional scopes or permissions. + # there are scopes defined for "Read-only access to Google Calendar" and "Access + # to Cloud Platform". Users can consent to a scope for an application, giving it + # permission to access that data on their behalf. OAuth scope specifications + # should be fairly coarse grained; a user will need to see and understand the + # text description of what your scope means. In most cases: use one or at most + # two OAuth scopes for an entire family of products. If your product has + # multiple APIs, you should probably be sharing the OAuth scope across all of + # those APIs. When you need finer grained OAuth consent screens: talk with your + # product management about how developers will use them in practice. Please note + # that even though each of the canonical scopes is enough for a request to be + # accepted and passed to the backend, a request can still fail due to the + # backend requiring additional scopes or permissions. # Corresponds to the JSON property `oauth` # @return [Google::Apis::ServiceusageV1beta1::OAuthRequirements] attr_accessor :oauth @@ -389,8 +339,8 @@ module Google # @return [Array] attr_accessor :requirements - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -412,8 +362,8 @@ module Google class Backend include Google::Apis::Core::Hashable - # A list of API backend rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of API backend rules that apply to individual API methods. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -432,21 +382,13 @@ module Google class BackendRule include Google::Apis::Core::Hashable - # The address of the API backend. - # The scheme is used to determine the backend protocol and security. - # The following schemes are accepted: - # SCHEME PROTOCOL SECURITY - # http:// HTTP None - # https:// HTTP TLS - # grpc:// gRPC None - # grpcs:// gRPC TLS - # It is recommended to explicitly include a scheme. Leaving out the scheme - # may cause constrasting behaviors across platforms. - # If the port is unspecified, the default is: - # - 80 for schemes without TLS - # - 443 for schemes with TLS - # For HTTP backends, use protocol - # to specify the protocol version. + # The address of the API backend. The scheme is used to determine the backend + # protocol and security. The following schemes are accepted: SCHEME PROTOCOL + # SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC + # TLS It is recommended to explicitly include a scheme. Leaving out the scheme + # may cause constrasting behaviors across platforms. If the port is unspecified, + # the default is: - 80 for schemes without TLS - 443 for schemes with TLS For + # HTTP backends, use protocol to specify the protocol version. # Corresponds to the JSON property `address` # @return [String] attr_accessor :address @@ -457,18 +399,18 @@ module Google # @return [Float] attr_accessor :deadline - # When disable_auth is true, a JWT ID token won't be generated and the - # original "Authorization" HTTP header will be preserved. If the header is - # used to carry the original token and is expected by the backend, this - # field must be set to true to preserve the header. + # When disable_auth is true, a JWT ID token won't be generated and the original " + # Authorization" HTTP header will be preserved. If the header is used to carry + # the original token and is expected by the backend, this field must be set to + # true to preserve the header. # Corresponds to the JSON property `disableAuth` # @return [Boolean] attr_accessor :disable_auth alias_method :disable_auth?, :disable_auth - # The JWT audience is used when generating a JWT ID token for the backend. - # This ID token will be added in the HTTP "authorization" header, and sent - # to the backend. + # The JWT audience is used when generating a JWT ID token for the backend. This + # ID token will be added in the HTTP "authorization" header, and sent to the + # backend. # Corresponds to the JSON property `jwtAudience` # @return [String] attr_accessor :jwt_audience @@ -479,8 +421,8 @@ module Google # @return [Float] attr_accessor :min_deadline - # The number of seconds to wait for the completion of a long running - # operation. The default is no deadline. + # The number of seconds to wait for the completion of a long running operation. + # The default is no deadline. # Corresponds to the JSON property `operationDeadline` # @return [Float] attr_accessor :operation_deadline @@ -490,29 +432,21 @@ module Google # @return [String] attr_accessor :path_translation - # The protocol used for sending a request to the backend. - # The supported values are "http/1.1" and "h2". - # The default value is inferred from the scheme in the - # address field: - # SCHEME PROTOCOL - # http:// http/1.1 - # https:// http/1.1 - # grpc:// h2 - # grpcs:// h2 - # For secure HTTP backends (https://) that support HTTP/2, set this field - # to "h2" for improved performance. - # Configuring this field to non-default values is only supported for secure - # HTTP backends. This field will be ignored for all other backends. - # See - # https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype- - # values.xhtml#alpn-protocol-ids - # for more details on the supported values. + # The protocol used for sending a request to the backend. The supported values + # are "http/1.1" and "h2". The default value is inferred from the scheme in the + # address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 + # grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this + # field to "h2" for improved performance. Configuring this field to non-default + # values is only supported for secure HTTP backends. This field will be ignored + # for all other backends. See https://www.iana.org/assignments/tls-extensiontype- + # values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on + # the supported values. # Corresponds to the JSON property `protocol` # @return [String] attr_accessor :protocol - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -577,16 +511,13 @@ module Google class BatchEnableServicesRequest include Google::Apis::Core::Hashable - # The identifiers of the services to enable on the project. - # A valid identifier would be: - # serviceusage.googleapis.com - # Enabling services requires that each service is public or is shared with - # the user enabling the service. - # Two or more services must be specified. To enable a single service, - # use the `EnableService` method instead. - # A single request can enable a maximum of 20 services at a time. If more - # than 20 services are specified, the request will fail, and no state changes - # will occur. + # The identifiers of the services to enable on the project. A valid identifier + # would be: serviceusage.googleapis.com Enabling services requires that each + # service is public or is shared with the user enabling the service. Two or more + # services must be specified. To enable a single service, use the `EnableService` + # method instead. A single request can enable a maximum of 20 services at a + # time. If more than 20 services are specified, the request will fail, and no + # state changes will occur. # Corresponds to the JSON property `serviceIds` # @return [Array] attr_accessor :service_ids @@ -601,9 +532,9 @@ module Google end end - # Response message for the `BatchEnableServices` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `BatchEnableServices` method. This response message + # is assigned to the `response` field of the returned Operation when that + # operation is done. class BatchEnableServicesResponse include Google::Apis::Core::Hashable @@ -629,42 +560,28 @@ module Google end end - # Billing related configuration of the service. - # The following example shows how to configure monitored resources and metrics - # for billing, `consumer_destinations` is the only supported destination and - # the monitored resources need at least one label key - # `cloud.googleapis.com/location` to indicate the location of the billing - # usage, using different monitored resources between monitoring and billing is - # recommended so they can be evolved independently: - # monitored_resources: - # - type: library.googleapis.com/billing_branch - # labels: - # - key: cloud.googleapis.com/location - # description: | - # Predefined label to support billing location restriction. - # - key: city - # description: | - # Custom label to define the city where the library branch is located - # in. - # - key: name - # description: Custom label to define the name of the library branch. - # metrics: - # - name: library.googleapis.com/book/borrowed_count - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # billing: - # consumer_destinations: - # - monitored_resource: library.googleapis.com/billing_branch - # metrics: - # - library.googleapis.com/book/borrowed_count + # Billing related configuration of the service. The following example shows how + # to configure monitored resources and metrics for billing, ` + # consumer_destinations` is the only supported destination and the monitored + # resources need at least one label key `cloud.googleapis.com/location` to + # indicate the location of the billing usage, using different monitored + # resources between monitoring and billing is recommended so they can be evolved + # independently: monitored_resources: - type: library.googleapis.com/ + # billing_branch labels: - key: cloud.googleapis.com/location description: | + # Predefined label to support billing location restriction. - key: city + # description: | Custom label to define the city where the library branch is + # located in. - key: name description: Custom label to define the name of the + # library branch. metrics: - name: library.googleapis.com/book/borrowed_count + # metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: + # - monitored_resource: library.googleapis.com/billing_branch metrics: - library. + # googleapis.com/book/borrowed_count class Billing include Google::Apis::Core::Hashable - # Billing configurations for sending metrics to the consumer project. - # There can be multiple consumer destinations per service, each one must have - # a different monitored resource type. A metric can be used in at most - # one consumer destination. + # Billing configurations for sending metrics to the consumer project. There can + # be multiple consumer destinations per service, each one must have a different + # monitored resource type. A metric can be used in at most one consumer + # destination. # Corresponds to the JSON property `consumerDestinations` # @return [Array] attr_accessor :consumer_destinations @@ -679,19 +596,19 @@ module Google end end - # Configuration of a specific billing destination (Currently only support - # bill against consumer project). + # Configuration of a specific billing destination (Currently only support bill + # against consumer project). class BillingDestination include Google::Apis::Core::Hashable - # Names of the metrics to report to this billing destination. - # Each name must be defined in Service.metrics section. + # Names of the metrics to report to this billing destination. Each name must be + # defined in Service.metrics section. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics - # The monitored resource type. The type must be defined in - # Service.monitored_resources section. + # The monitored resource type. The type must be defined in Service. + # monitored_resources section. # Corresponds to the JSON property `monitoredResource` # @return [String] attr_accessor :monitored_resource @@ -723,35 +640,31 @@ module Google attr_accessor :is_precise alias_method :is_precise?, :is_precise - # The name of the parent metric of this limit. - # An example name would be: - # `compute.googleapis.com/cpus` + # The name of the parent metric of this limit. An example name would be: ` + # compute.googleapis.com/cpus` # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric - # The resource name of the quota limit. - # An example name would be: - # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. - # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` - # The resource name is intended to be opaque and should not be parsed for - # its component strings, since its representation could change in the future. + # The resource name of the quota limit. An example name would be: `projects/123/ + # services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com% + # 2Fcpus/limits/%2Fproject%2Fregion` The resource name is intended to be opaque + # and should not be parsed for its component strings, since its representation + # could change in the future. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Summary of the enforced quota buckets, organized by quota dimension, - # ordered from least specific to most specific (for example, the global - # default bucket, with no quota dimensions, will always appear first). + # Summary of the enforced quota buckets, organized by quota dimension, ordered + # from least specific to most specific (for example, the global default bucket, + # with no quota dimensions, will always appear first). # Corresponds to the JSON property `quotaBuckets` # @return [Array] attr_accessor :quota_buckets - # The limit unit. - # An example unit would be - # `1/`project`/`region`` - # Note that ``project`` and ``region`` are not placeholders in this example; - # the literal characters ``` and ``` occur in the string. + # The limit unit. An example unit would be `1/`project`/`region`` Note that `` + # project`` and ``region`` are not placeholders in this example; the literal + # characters ``` and ``` occur in the string. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit @@ -780,26 +693,21 @@ module Google # @return [Array] attr_accessor :consumer_quota_limits - # The display name of the metric. - # An example name would be: - # "CPUs" + # The display name of the metric. An example name would be: "CPUs" # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # The name of the metric. - # An example name would be: - # `compute.googleapis.com/cpus` + # The name of the metric. An example name would be: `compute.googleapis.com/cpus` # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric - # The resource name of the quota settings on this metric for this consumer. - # An example name would be: - # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. - # googleapis.com%2Fcpus - # The resource name is intended to be opaque and should not be parsed for - # its component strings, since its representation could change in the future. + # The resource name of the quota settings on this metric for this consumer. An + # example name would be: `projects/123/services/compute.googleapis.com/ + # consumerQuotaMetrics/compute.googleapis.com%2Fcpus The resource name is + # intended to be opaque and should not be parsed for its component strings, + # since its representation could change in the future. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -823,39 +731,24 @@ module Google end end - # `Context` defines which contexts an API requests. - # Example: - # context: - # rules: - # - selector: "*" - # requested: - # - google.rpc.context.ProjectContext - # - google.rpc.context.OriginContext - # The above specifies that all methods in the API request - # `google.rpc.context.ProjectContext` and - # `google.rpc.context.OriginContext`. - # Available context types are defined in package - # `google.rpc.context`. - # This also provides mechanism to whitelist any protobuf message extension that - # can be sent in grpc metadata using “x-goog-ext--bin” and - # “x-goog-ext--jspb” format. For example, list any service - # specific protobuf types that can appear in grpc metadata as follows in your - # yaml file: - # Example: - # context: - # rules: - # - selector: "google.example.library.v1.LibraryService.CreateBook" - # allowed_request_extensions: - # - google.foo.v1.NewExtension - # allowed_response_extensions: - # - google.foo.v1.NewExtension - # You can also specify extension ID instead of fully qualified extension name - # here. + # `Context` defines which contexts an API requests. Example: context: rules: - + # selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc. + # context.OriginContext The above specifies that all methods in the API request ` + # google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. + # Available context types are defined in package `google.rpc.context`. This also + # provides mechanism to whitelist any protobuf message extension that can be + # sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. + # For example, list any service specific protobuf types that can appear in grpc + # metadata as follows in your yaml file: Example: context: rules: - selector: " + # google.example.library.v1.LibraryService.CreateBook" + # allowed_request_extensions: - google.foo.v1.NewExtension + # allowed_response_extensions: - google.foo.v1.NewExtension You can also specify + # extension ID instead of fully qualified extension name here. class Context include Google::Apis::Core::Hashable - # A list of RPC context rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of RPC context rules that apply to individual API methods. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -875,14 +768,14 @@ module Google class ContextRule include Google::Apis::Core::Hashable - # A list of full type names or extension IDs of extensions allowed in grpc - # side channel from client to backend. + # A list of full type names or extension IDs of extensions allowed in grpc side + # channel from client to backend. # Corresponds to the JSON property `allowedRequestExtensions` # @return [Array] attr_accessor :allowed_request_extensions - # A list of full type names or extension IDs of extensions allowed in grpc - # side channel from backend to client. + # A list of full type names or extension IDs of extensions allowed in grpc side + # channel from backend to client. # Corresponds to the JSON property `allowedResponseExtensions` # @return [Array] attr_accessor :allowed_response_extensions @@ -897,8 +790,8 @@ module Google # @return [Array] attr_accessor :requested - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -917,14 +810,14 @@ module Google end end - # Selects and configures the service controller used by the service. The - # service controller handles features like abuse, quota, billing, logging, - # monitoring, etc. + # Selects and configures the service controller used by the service. The service + # controller handles features like abuse, quota, billing, logging, monitoring, + # etc. class Control include Google::Apis::Core::Hashable - # The service control environment to use. If empty, no control plane - # feature (like quota and billing) will be enabled. + # The service control environment to use. If empty, no control plane feature ( + # like quota and billing) will be enabled. # Corresponds to the JSON property `environment` # @return [String] attr_accessor :environment @@ -939,19 +832,15 @@ module Google end end - # Customize service error responses. For example, list any service - # specific protobuf types that can appear in error detail lists of - # error responses. - # Example: - # custom_error: - # types: - # - google.foo.v1.CustomError - # - google.foo.v1.AnotherError + # Customize service error responses. For example, list any service specific + # protobuf types that can appear in error detail lists of error responses. + # Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1. + # AnotherError class CustomError include Google::Apis::Core::Hashable - # The list of custom error rules that apply to individual API messages. - # **NOTE:** All service configuration rules follow "last one wins" order. + # The list of custom error rules that apply to individual API messages. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -976,15 +865,15 @@ module Google class CustomErrorRule include Google::Apis::Core::Hashable - # Mark this message as possible payload in error response. Otherwise, - # objects of this type will be filtered when they appear in error payload. + # Mark this message as possible payload in error response. Otherwise, objects of + # this type will be filtered when they appear in error payload. # Corresponds to the JSON property `isErrorType` # @return [Boolean] attr_accessor :is_error_type alias_method :is_error_type?, :is_error_type - # Selects messages to which this rule applies. - # Refer to selector for syntax details. + # Selects messages to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -1038,9 +927,9 @@ module Google end end - # Response message for the `DisableService` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `DisableService` method. This response message is + # assigned to the `response` field of the returned Operation when that operation + # is done. class DisableServiceResponse include Google::Apis::Core::Hashable @@ -1059,56 +948,32 @@ module Google end end - # `Documentation` provides the information for describing a service. - # Example: - # 
documentation:
-      # summary: >
-      # The Google Calendar API gives access
-      # to most calendar features.
-      # pages:
-      # - name: Overview
-      # content: (== include google/foo/overview.md ==)
-      # - name: Tutorial
-      # content: (== include google/foo/tutorial.md ==)
-      # subpages;
-      # - name: Java
-      # content: (== include google/foo/tutorial_java.md ==)
-      # rules:
-      # - selector: google.calendar.Calendar.Get
-      # description: >
-      # ...
-      # - selector: google.calendar.Calendar.Put
-      # description: >
-      # ...
-      #
- # Documentation is provided in markdown syntax. In addition to - # standard markdown features, definition lists, tables and fenced - # code blocks are supported. Section headers can be provided and are - # interpreted relative to the section nesting of the context where - # a documentation fragment is embedded. - # Documentation from the IDL is merged with documentation defined - # via the config at normalization time, where documentation provided - # by config rules overrides IDL provided. - # A number of constructs specific to the API platform are supported - # in documentation text. - # In order to reference a proto element, the following - # notation can be used: - # 
[fully.qualified.proto.name][]
- # To override the display text used for the link, this can be used: - # 
[display text][fully.qualified.proto.name]
- # Text can be excluded from doc using the following notation: - # 
(-- internal comment --)
- # A few directives are available in documentation. Note that - # directives must appear on a single line to be properly - # identified. The `include` directive includes a markdown file from - # an external source: - # 
(== include path/to/file ==)
- # The `resource_for` directive marks a message to be the resource of - # a collection in REST view. If it is not specified, tools attempt - # to infer the resource from the operations in a collection: - # 
(== resource_for v1.shelves.books ==)
- # The directive `suppress_warning` does not directly affect documentation - # and is documented together with service config validation. + # `Documentation` provides the information for describing a service. Example: + # documentation: summary: > The Google Calendar API gives access to most + # calendar features. pages: - name: Overview content: (== include google/foo/ + # overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md == + # ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==) + # rules: - selector: google.calendar.Calendar.Get description: > ... - selector: + # google.calendar.Calendar.Put description: > ... Documentation is provided in + # markdown syntax. In addition to standard markdown features, definition lists, + # tables and fenced code blocks are supported. Section headers can be provided + # and are interpreted relative to the section nesting of the context where a + # documentation fragment is embedded. Documentation from the IDL is merged with + # documentation defined via the config at normalization time, where + # documentation provided by config rules overrides IDL provided. A number of + # constructs specific to the API platform are supported in documentation text. + # In order to reference a proto element, the following notation can be used: [ + # fully.qualified.proto.name][] To override the display text used for the link, + # this can be used: [display text][fully.qualified.proto.name] Text can be + # excluded from doc using the following notation: (-- internal comment --) A few + # directives are available in documentation. Note that directives must appear on + # a single line to be properly identified. The `include` directive includes a + # markdown file from an external source: (== include path/to/file ==) The ` + # resource_for` directive marks a message to be the resource of a collection in + # REST view. If it is not specified, tools attempt to infer the resource from + # the operations in a collection: (== resource_for v1.shelves.books ==) The + # directive `suppress_warning` does not directly affect documentation and is + # documented together with service config validation. class Documentation include Google::Apis::Core::Hashable @@ -1117,19 +982,11 @@ module Google # @return [String] attr_accessor :documentation_root_url - # Declares a single overview page. For example: - # 
documentation:
-        # summary: ...
-        # overview: (== include overview.md ==)
-        #
- # This is a shortcut for the following declaration (using pages style): - # 
documentation:
-        # summary: ...
-        # pages:
-        # - name: Overview
-        # content: (== include overview.md ==)
-        #
- # Note: you cannot specify both `overview` field and `pages` field. + # Declares a single overview page. For example: documentation: summary: ... + # overview: (== include overview.md ==) This is a shortcut for the following + # declaration (using pages style): documentation: summary: ... pages: - name: + # Overview content: (== include overview.md ==) Note: you cannot specify both ` + # overview` field and `pages` field. # Corresponds to the JSON property `overview` # @return [String] attr_accessor :overview @@ -1139,22 +996,20 @@ module Google # @return [Array] attr_accessor :pages - # A list of documentation rules that apply to individual API elements. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of documentation rules that apply to individual API elements. **NOTE:** + # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules - # Specifies the service root url if the default one (the service name - # from the yaml file) is not suitable. This can be seen in any fully - # specified service urls as well as sections that show a base that other - # urls are relative to. + # Specifies the service root url if the default one (the service name from the + # yaml file) is not suitable. This can be seen in any fully specified service + # urls as well as sections that show a base that other urls are relative to. # Corresponds to the JSON property `serviceRootUrl` # @return [String] attr_accessor :service_root_url - # A short summary of what the service does. Can only be provided by - # plain text. + # A short summary of what the service does. Can only be provided by plain text. # Corresponds to the JSON property `summary` # @return [String] attr_accessor :summary @@ -1178,8 +1033,8 @@ module Google class DocumentationRule include Google::Apis::Core::Hashable - # Deprecation description of the selected element(s). It can be provided if - # an element is marked as `deprecated`. + # Deprecation description of the selected element(s). It can be provided if an + # element is marked as `deprecated`. # Corresponds to the JSON property `deprecationDescription` # @return [String] attr_accessor :deprecation_description @@ -1211,13 +1066,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 @@ -1268,9 +1121,9 @@ module Google end end - # Response message for the `EnableService` method. - # This response message is assigned to the `response` field of the returned - # Operation when that operation is done. + # Response message for the `EnableService` method. This response message is + # assigned to the `response` field of the returned Operation when that operation + # is done. class EnableServiceResponse include Google::Apis::Core::Hashable @@ -1289,35 +1142,28 @@ module Google end end - # `Endpoint` describes a network endpoint that serves a set of APIs. - # A service may expose any number of endpoints, and all endpoints share the - # same service configuration, such as quota configuration and monitoring - # configuration. - # Example service configuration: - # name: library-example.googleapis.com - # endpoints: - # # Below entry makes 'google.example.library.v1.Library' - # # API be served from endpoint address library-example.googleapis.com. - # # It also allows HTTP OPTIONS calls to be passed to the backend, for - # # it to decide whether the subsequent cross-origin request is - # # allowed to proceed. - # - name: library-example.googleapis.com - # allow_cors: true + # `Endpoint` describes a network endpoint that serves a set of APIs. A service + # may expose any number of endpoints, and all endpoints share the same service + # configuration, such as quota configuration and monitoring configuration. + # Example service configuration: name: library-example.googleapis.com endpoints: + # # Below entry makes 'google.example.library.v1.Library' # API be served from + # endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS + # calls to be passed to the backend, for # it to decide whether the subsequent + # cross-origin request is # allowed to proceed. - name: library-example. + # googleapis.com allow_cors: true class Endpoint include Google::Apis::Core::Hashable # DEPRECATED: This field is no longer supported. Instead of using aliases, - # please specify multiple google.api.Endpoint for each of the intended - # aliases. + # please specify multiple google.api.Endpoint for each of the intended aliases. # Additional names that this endpoint will be hosted on. # Corresponds to the JSON property `aliases` # @return [Array] attr_accessor :aliases - # Allowing - # [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka - # cross-domain traffic, would allow the backends served from this endpoint to - # receive and respond to HTTP OPTIONS requests. The response will be used by + # Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), + # aka cross-domain traffic, would allow the backends served from this endpoint + # to receive and respond to HTTP OPTIONS requests. The response will be used by # the browser to determine whether the subsequent cross-origin request is # allowed to proceed. # Corresponds to the JSON property `allowCors` @@ -1331,10 +1177,9 @@ module Google attr_accessor :name # The specification of an Internet routable address of API frontend that will - # handle requests to this [API - # Endpoint](https://cloud.google.com/apis/design/glossary). It should be - # either a valid IPv4 address or a fully-qualified domain name. For example, - # "8.8.8.8" or "myservice.appspot.com". + # handle requests to this [API Endpoint](https://cloud.google.com/apis/design/ + # glossary). It should be either a valid IPv4 address or a fully-qualified + # domain name. For example, "8.8.8.8" or "myservice.appspot.com". # Corresponds to the JSON property `target` # @return [String] attr_accessor :target @@ -1371,8 +1216,8 @@ module Google # @return [Array] attr_accessor :options - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. # Corresponds to the JSON property `sourceContext` # @return [Google::Apis::ServiceusageV1beta1::SourceContext] attr_accessor :source_context @@ -1461,8 +1306,8 @@ module Google # @return [Fixnum] attr_accessor :number - # The index of the field type in `Type.oneofs`, for message or enumeration - # types. The first type has index 1; zero means the type is not in the list. + # The index of the field type in `Type.oneofs`, for message or enumeration types. + # The first type has index 1; zero means the type is not in the list. # Corresponds to the JSON property `oneofIndex` # @return [Fixnum] attr_accessor :oneof_index @@ -1478,8 +1323,8 @@ module Google attr_accessor :packed alias_method :packed?, :packed - # The field type URL, without the scheme, for message or enumeration - # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + # The field type URL, without the scheme, for message or enumeration types. + # Example: `"type.googleapis.com/google.protobuf.Timestamp"`. # Corresponds to the JSON property `typeUrl` # @return [String] attr_accessor :type_url @@ -1530,50 +1375,32 @@ module Google end # `Service` is the root object of Google service configuration schema. It - # describes basic information about a service, such as the name and the - # title, and delegates other aspects to sub-sections. Each sub-section is - # either a proto message or a repeated proto message that configures a - # specific aspect, such as auth. See each proto message definition for details. - # Example: - # type: google.api.Service - # config_version: 3 - # name: calendar.googleapis.com - # title: Google Calendar API - # apis: - # - name: google.calendar.v3.Calendar - # authentication: - # providers: - # - id: google_calendar_auth - # jwks_uri: https://www.googleapis.com/oauth2/v1/certs - # issuer: https://securetoken.google.com - # rules: - # - selector: "*" - # requirements: - # provider_id: google_calendar_auth + # describes basic information about a service, such as the name and the title, + # and delegates other aspects to sub-sections. Each sub-section is either a + # proto message or a repeated proto message that configures a specific aspect, + # such as auth. See each proto message definition for details. Example: type: + # google.api.Service config_version: 3 name: calendar.googleapis.com title: + # Google Calendar API apis: - name: google.calendar.v3.Calendar authentication: + # providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/ + # oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" + # requirements: provider_id: google_calendar_auth class GoogleApiService include Google::Apis::Core::Hashable - # A list of API interfaces exported by this service. Only the `name` field - # of the google.protobuf.Api needs to be provided by the configuration - # author, as the remaining fields will be derived from the IDL during the - # normalization process. It is an error to specify an API interface here - # which cannot be resolved against the associated IDL files. + # A list of API interfaces exported by this service. Only the `name` field of + # the google.protobuf.Api needs to be provided by the configuration author, as + # the remaining fields will be derived from the IDL during the normalization + # process. It is an error to specify an API interface here which cannot be + # resolved against the associated IDL files. # Corresponds to the JSON property `apis` # @return [Array] attr_accessor :apis - # `Authentication` defines the authentication configuration for an API. - # Example for an API targeted for external use: - # name: calendar.googleapis.com - # authentication: - # providers: - # - id: google_calendar_auth - # jwks_uri: https://www.googleapis.com/oauth2/v1/certs - # issuer: https://securetoken.google.com - # rules: - # - selector: "*" - # requirements: - # provider_id: google_calendar_auth + # `Authentication` defines the authentication configuration for an API. Example + # for an API targeted for external use: name: calendar.googleapis.com + # authentication: providers: - id: google_calendar_auth jwks_uri: https://www. + # googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - + # selector: "*" requirements: provider_id: google_calendar_auth # Corresponds to the JSON property `authentication` # @return [Google::Apis::ServiceusageV1beta1::Authentication] attr_accessor :authentication @@ -1583,211 +1410,136 @@ module Google # @return [Google::Apis::ServiceusageV1beta1::Backend] attr_accessor :backend - # Billing related configuration of the service. - # The following example shows how to configure monitored resources and metrics - # for billing, `consumer_destinations` is the only supported destination and - # the monitored resources need at least one label key - # `cloud.googleapis.com/location` to indicate the location of the billing - # usage, using different monitored resources between monitoring and billing is - # recommended so they can be evolved independently: - # monitored_resources: - # - type: library.googleapis.com/billing_branch - # labels: - # - key: cloud.googleapis.com/location - # description: | - # Predefined label to support billing location restriction. - # - key: city - # description: | - # Custom label to define the city where the library branch is located - # in. - # - key: name - # description: Custom label to define the name of the library branch. - # metrics: - # - name: library.googleapis.com/book/borrowed_count - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # billing: - # consumer_destinations: - # - monitored_resource: library.googleapis.com/billing_branch - # metrics: - # - library.googleapis.com/book/borrowed_count + # Billing related configuration of the service. The following example shows how + # to configure monitored resources and metrics for billing, ` + # consumer_destinations` is the only supported destination and the monitored + # resources need at least one label key `cloud.googleapis.com/location` to + # indicate the location of the billing usage, using different monitored + # resources between monitoring and billing is recommended so they can be evolved + # independently: monitored_resources: - type: library.googleapis.com/ + # billing_branch labels: - key: cloud.googleapis.com/location description: | + # Predefined label to support billing location restriction. - key: city + # description: | Custom label to define the city where the library branch is + # located in. - key: name description: Custom label to define the name of the + # library branch. metrics: - name: library.googleapis.com/book/borrowed_count + # metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: + # - monitored_resource: library.googleapis.com/billing_branch metrics: - library. + # googleapis.com/book/borrowed_count # Corresponds to the JSON property `billing` # @return [Google::Apis::ServiceusageV1beta1::Billing] attr_accessor :billing - # The semantic version of the service configuration. The config version - # affects the interpretation of the service configuration. For example, - # certain features are enabled by default for certain config versions. - # The latest config version is `3`. + # The semantic version of the service configuration. The config version affects + # the interpretation of the service configuration. For example, certain features + # are enabled by default for certain config versions. The latest config version + # is `3`. # Corresponds to the JSON property `configVersion` # @return [Fixnum] attr_accessor :config_version - # `Context` defines which contexts an API requests. - # Example: - # context: - # rules: - # - selector: "*" - # requested: - # - google.rpc.context.ProjectContext - # - google.rpc.context.OriginContext - # The above specifies that all methods in the API request - # `google.rpc.context.ProjectContext` and - # `google.rpc.context.OriginContext`. - # Available context types are defined in package - # `google.rpc.context`. - # This also provides mechanism to whitelist any protobuf message extension that - # can be sent in grpc metadata using “x-goog-ext--bin” and - # “x-goog-ext--jspb” format. For example, list any service - # specific protobuf types that can appear in grpc metadata as follows in your - # yaml file: - # Example: - # context: - # rules: - # - selector: "google.example.library.v1.LibraryService.CreateBook" - # allowed_request_extensions: - # - google.foo.v1.NewExtension - # allowed_response_extensions: - # - google.foo.v1.NewExtension - # You can also specify extension ID instead of fully qualified extension name - # here. + # `Context` defines which contexts an API requests. Example: context: rules: - + # selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc. + # context.OriginContext The above specifies that all methods in the API request ` + # google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. + # Available context types are defined in package `google.rpc.context`. This also + # provides mechanism to whitelist any protobuf message extension that can be + # sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. + # For example, list any service specific protobuf types that can appear in grpc + # metadata as follows in your yaml file: Example: context: rules: - selector: " + # google.example.library.v1.LibraryService.CreateBook" + # allowed_request_extensions: - google.foo.v1.NewExtension + # allowed_response_extensions: - google.foo.v1.NewExtension You can also specify + # extension ID instead of fully qualified extension name here. # Corresponds to the JSON property `context` # @return [Google::Apis::ServiceusageV1beta1::Context] attr_accessor :context - # Selects and configures the service controller used by the service. The - # service controller handles features like abuse, quota, billing, logging, - # monitoring, etc. + # Selects and configures the service controller used by the service. The service + # controller handles features like abuse, quota, billing, logging, monitoring, + # etc. # Corresponds to the JSON property `control` # @return [Google::Apis::ServiceusageV1beta1::Control] attr_accessor :control - # Customize service error responses. For example, list any service - # specific protobuf types that can appear in error detail lists of - # error responses. - # Example: - # custom_error: - # types: - # - google.foo.v1.CustomError - # - google.foo.v1.AnotherError + # Customize service error responses. For example, list any service specific + # protobuf types that can appear in error detail lists of error responses. + # Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1. + # AnotherError # Corresponds to the JSON property `customError` # @return [Google::Apis::ServiceusageV1beta1::CustomError] attr_accessor :custom_error - # `Documentation` provides the information for describing a service. - # Example: - # 
documentation:
-        # summary: >
-        # The Google Calendar API gives access
-        # to most calendar features.
-        # pages:
-        # - name: Overview
-        # content: (== include google/foo/overview.md ==)
-        # - name: Tutorial
-        # content: (== include google/foo/tutorial.md ==)
-        # subpages;
-        # - name: Java
-        # content: (== include google/foo/tutorial_java.md ==)
-        # rules:
-        # - selector: google.calendar.Calendar.Get
-        # description: >
-        # ...
-        # - selector: google.calendar.Calendar.Put
-        # description: >
-        # ...
-        #
- # Documentation is provided in markdown syntax. In addition to - # standard markdown features, definition lists, tables and fenced - # code blocks are supported. Section headers can be provided and are - # interpreted relative to the section nesting of the context where - # a documentation fragment is embedded. - # Documentation from the IDL is merged with documentation defined - # via the config at normalization time, where documentation provided - # by config rules overrides IDL provided. - # A number of constructs specific to the API platform are supported - # in documentation text. - # In order to reference a proto element, the following - # notation can be used: - # 
[fully.qualified.proto.name][]
- # To override the display text used for the link, this can be used: - # 
[display text][fully.qualified.proto.name]
- # Text can be excluded from doc using the following notation: - # 
(-- internal comment --)
- # A few directives are available in documentation. Note that - # directives must appear on a single line to be properly - # identified. The `include` directive includes a markdown file from - # an external source: - # 
(== include path/to/file ==)
- # The `resource_for` directive marks a message to be the resource of - # a collection in REST view. If it is not specified, tools attempt - # to infer the resource from the operations in a collection: - # 
(== resource_for v1.shelves.books ==)
- # The directive `suppress_warning` does not directly affect documentation - # and is documented together with service config validation. + # `Documentation` provides the information for describing a service. Example: + # documentation: summary: > The Google Calendar API gives access to most + # calendar features. pages: - name: Overview content: (== include google/foo/ + # overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md == + # ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==) + # rules: - selector: google.calendar.Calendar.Get description: > ... - selector: + # google.calendar.Calendar.Put description: > ... Documentation is provided in + # markdown syntax. In addition to standard markdown features, definition lists, + # tables and fenced code blocks are supported. Section headers can be provided + # and are interpreted relative to the section nesting of the context where a + # documentation fragment is embedded. Documentation from the IDL is merged with + # documentation defined via the config at normalization time, where + # documentation provided by config rules overrides IDL provided. A number of + # constructs specific to the API platform are supported in documentation text. + # In order to reference a proto element, the following notation can be used: [ + # fully.qualified.proto.name][] To override the display text used for the link, + # this can be used: [display text][fully.qualified.proto.name] Text can be + # excluded from doc using the following notation: (-- internal comment --) A few + # directives are available in documentation. Note that directives must appear on + # a single line to be properly identified. The `include` directive includes a + # markdown file from an external source: (== include path/to/file ==) The ` + # resource_for` directive marks a message to be the resource of a collection in + # REST view. If it is not specified, tools attempt to infer the resource from + # the operations in a collection: (== resource_for v1.shelves.books ==) The + # directive `suppress_warning` does not directly affect documentation and is + # documented together with service config validation. # Corresponds to the JSON property `documentation` # @return [Google::Apis::ServiceusageV1beta1::Documentation] attr_accessor :documentation - # Configuration for network endpoints. If this is empty, then an endpoint - # with the same name as the service is automatically generated to service all - # defined APIs. + # Configuration for network endpoints. If this is empty, then an endpoint with + # the same name as the service is automatically generated to service all defined + # APIs. # Corresponds to the JSON property `endpoints` # @return [Array] attr_accessor :endpoints - # A list of all enum types included in this API service. Enums - # referenced directly or indirectly by the `apis` are automatically - # included. Enums which are not referenced but shall be included - # should be listed here by name. Example: - # enums: - # - name: google.someapi.v1.SomeEnum + # A list of all enum types included in this API service. Enums referenced + # directly or indirectly by the `apis` are automatically included. Enums which + # are not referenced but shall be included should be listed here by name. + # Example: enums: - name: google.someapi.v1.SomeEnum # Corresponds to the JSON property `enums` # @return [Array] attr_accessor :enums # Defines the HTTP configuration for an API service. It contains a list of - # HttpRule, each specifying the mapping of an RPC method - # to one or more HTTP REST API methods. + # HttpRule, each specifying the mapping of an RPC method to one or more HTTP + # REST API methods. # Corresponds to the JSON property `http` # @return [Google::Apis::ServiceusageV1beta1::Http] attr_accessor :http - # A unique ID for a specific instance of this message, typically assigned - # by the client for tracking purpose. Must be no longer than 63 characters - # and only lower case letters, digits, '.', '_' and '-' are allowed. If - # empty, the server may choose to generate one instead. + # A unique ID for a specific instance of this message, typically assigned by the + # client for tracking purpose. Must be no longer than 63 characters and only + # lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server + # may choose to generate one instead. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Logging configuration of the service. - # The following example shows how to configure logs to be sent to the - # producer and consumer projects. In the example, the `activity_history` - # log is sent to both the producer and consumer projects, whereas the - # `purchase_history` log is only sent to the producer project. - # monitored_resources: - # - type: library.googleapis.com/branch - # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. - # logs: - # - name: activity_history - # labels: - # - key: /customer_id - # - name: purchase_history - # logging: - # producer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history - # - purchase_history - # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history + # Logging configuration of the service. The following example shows how to + # configure logs to be sent to the producer and consumer projects. In the + # example, the `activity_history` log is sent to both the producer and consumer + # projects, whereas the `purchase_history` log is only sent to the producer + # project. monitored_resources: - type: library.googleapis.com/branch labels: - + # key: /city description: The city where the library branch is located in. - key: + # /name description: The name of the branch. logs: - name: activity_history + # labels: - key: /customer_id - name: purchase_history logging: + # producer_destinations: - monitored_resource: library.googleapis.com/branch + # logs: - activity_history - purchase_history consumer_destinations: - + # monitored_resource: library.googleapis.com/branch logs: - activity_history # Corresponds to the JSON property `logging` # @return [Google::Apis::ServiceusageV1beta1::Logging] attr_accessor :logging @@ -1802,70 +1554,41 @@ module Google # @return [Array] attr_accessor :metrics - # Defines the monitored resources used by this service. This is required - # by the Service.monitoring and Service.logging configurations. + # Defines the monitored resources used by this service. This is required by the + # Service.monitoring and Service.logging configurations. # Corresponds to the JSON property `monitoredResources` # @return [Array] attr_accessor :monitored_resources - # Monitoring configuration of the service. - # The example below shows how to configure monitored resources and metrics - # for monitoring. In the example, a monitored resource and two metrics are - # defined. The `library.googleapis.com/book/returned_count` metric is sent - # to both producer and consumer projects, whereas the - # `library.googleapis.com/book/num_overdue` metric is only sent to the - # consumer project. - # monitored_resources: - # - type: library.googleapis.com/Branch - # display_name: "Library Branch" - # description: "A branch of a library." - # launch_stage: GA - # labels: - # - key: resource_container - # description: "The Cloud container (ie. project id) for the Branch." - # - key: location - # description: "The location of the library branch." - # - key: branch_id - # description: "The id of the branch." - # metrics: - # - name: library.googleapis.com/book/returned_count - # display_name: "Books Returned" - # description: "The count of books that have been returned." - # launch_stage: GA - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # - name: library.googleapis.com/book/num_overdue - # display_name: "Books Overdue" - # description: "The current number of overdue books." - # launch_stage: GA - # metric_kind: GAUGE - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # monitoring: - # producer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # consumer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # - library.googleapis.com/book/num_overdue + # Monitoring configuration of the service. The example below shows how to + # configure monitored resources and metrics for monitoring. In the example, a + # monitored resource and two metrics are defined. The `library.googleapis.com/ + # book/returned_count` metric is sent to both producer and consumer projects, + # whereas the `library.googleapis.com/book/num_overdue` metric is only sent to + # the consumer project. monitored_resources: - type: library.googleapis.com/ + # Branch display_name: "Library Branch" description: "A branch of a library." + # launch_stage: GA labels: - key: resource_container description: "The Cloud + # container (ie. project id) for the Branch." - key: location description: "The + # location of the library branch." - key: branch_id description: "The id of the + # branch." metrics: - name: library.googleapis.com/book/returned_count + # display_name: "Books Returned" description: "The count of books that have been + # returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" + # labels: - key: customer_id description: "The id of the customer." - name: + # library.googleapis.com/book/num_overdue display_name: "Books Overdue" + # description: "The current number of overdue books." launch_stage: GA + # metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id + # description: "The id of the customer." monitoring: producer_destinations: - + # monitored_resource: library.googleapis.com/Branch metrics: - library. + # googleapis.com/book/returned_count consumer_destinations: - monitored_resource: + # library.googleapis.com/Branch metrics: - library.googleapis.com/book/ + # returned_count - library.googleapis.com/book/num_overdue # Corresponds to the JSON property `monitoring` # @return [Google::Apis::ServiceusageV1beta1::Monitoring] attr_accessor :monitoring - # The service name, which is a DNS-like logical identifier for the - # service, such as `calendar.googleapis.com`. The service name - # typically goes through DNS verification to make sure the owner - # of the service also owns the DNS name. + # The service name, which is a DNS-like logical identifier for the service, such + # as `calendar.googleapis.com`. The service name typically goes through DNS + # verification to make sure the owner of the service also owns the DNS name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1875,46 +1598,25 @@ module Google # @return [String] attr_accessor :producer_project_id - # Quota configuration helps to achieve fairness and budgeting in service - # usage. - # The metric based quota configuration works this way: - # - The service configuration defines a set of metrics. - # - For API calls, the quota.metric_rules maps methods to metrics with - # corresponding costs. - # - The quota.limits defines limits on the metrics, which will be used for - # quota checks at runtime. - # An example quota configuration in yaml format: - # quota: - # limits: - # - name: apiWriteQpsPerProject - # metric: library.googleapis.com/write_calls - # unit: "1/min/`project`" # rate limit for consumer projects - # values: - # STANDARD: 10000 - # # The metric rules bind all methods to the read_calls metric, - # # except for the UpdateBook and DeleteBook methods. These two methods - # # are mapped to the write_calls metric, with the UpdateBook method - # # consuming at twice rate as the DeleteBook method. - # metric_rules: - # - selector: "*" - # metric_costs: - # library.googleapis.com/read_calls: 1 - # - selector: google.example.library.v1.LibraryService.UpdateBook - # metric_costs: - # library.googleapis.com/write_calls: 2 - # - selector: google.example.library.v1.LibraryService.DeleteBook - # metric_costs: - # library.googleapis.com/write_calls: 1 - # Corresponding Metric definition: - # metrics: - # - name: library.googleapis.com/read_calls - # display_name: Read requests - # metric_kind: DELTA - # value_type: INT64 - # - name: library.googleapis.com/write_calls - # display_name: Write requests - # metric_kind: DELTA - # value_type: INT64 + # Quota configuration helps to achieve fairness and budgeting in service usage. + # The metric based quota configuration works this way: - The service + # configuration defines a set of metrics. - For API calls, the quota. + # metric_rules maps methods to metrics with corresponding costs. - The quota. + # limits defines limits on the metrics, which will be used for quota checks at + # runtime. An example quota configuration in yaml format: quota: limits: - name: + # apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/` + # project`" # rate limit for consumer projects values: STANDARD: 10000 # The + # metric rules bind all methods to the read_calls metric, # except for the + # UpdateBook and DeleteBook methods. These two methods # are mapped to the + # write_calls metric, with the UpdateBook method # consuming at twice rate as + # the DeleteBook method. metric_rules: - selector: "*" metric_costs: library. + # googleapis.com/read_calls: 1 - selector: google.example.library.v1. + # LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - + # selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: + # library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: + # - name: library.googleapis.com/read_calls display_name: Read requests + # metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/ + # write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 # Corresponds to the JSON property `quota` # @return [Google::Apis::ServiceusageV1beta1::Quota] attr_accessor :quota @@ -1924,20 +1626,18 @@ module Google # @return [Google::Apis::ServiceusageV1beta1::SourceInfo] attr_accessor :source_info - # ### System parameter configuration - # A system parameter is a special kind of parameter defined by the API - # system, not by an individual API. It is typically mapped to an HTTP header - # and/or a URL query parameter. This configuration specifies which methods - # change the names of the system parameters. + # ### System parameter configuration A system parameter is a special kind of + # parameter defined by the API system, not by an individual API. It is typically + # mapped to an HTTP header and/or a URL query parameter. This configuration + # specifies which methods change the names of the system parameters. # Corresponds to the JSON property `systemParameters` # @return [Google::Apis::ServiceusageV1beta1::SystemParameters] attr_accessor :system_parameters - # A list of all proto message types included in this API service. - # It serves similar purpose as [google.api.Service.types], except that - # these types are not needed by user-defined APIs. Therefore, they will not - # show up in the generated discovery doc. This field should only be used - # to define system APIs in ESF. + # A list of all proto message types included in this API service. It serves + # similar purpose as [google.api.Service.types], except that these types are not + # needed by user-defined APIs. Therefore, they will not show up in the generated + # discovery doc. This field should only be used to define system APIs in ESF. # Corresponds to the JSON property `systemTypes` # @return [Array] attr_accessor :system_types @@ -1947,12 +1647,10 @@ module Google # @return [String] attr_accessor :title - # A list of all proto message types included in this API service. - # Types referenced directly or indirectly by the `apis` are - # automatically included. Messages which are not referenced but - # shall be included, such as types used by the `google.protobuf.Any` type, - # should be listed here by name. Example: - # types: + # A list of all proto message types included in this API service. Types + # referenced directly or indirectly by the `apis` are automatically included. + # Messages which are not referenced but shall be included, such as types used by + # the `google.protobuf.Any` type, should be listed here by name. Example: types: # - name: google.protobuf.Int32 # Corresponds to the JSON property `types` # @return [Array] @@ -1999,32 +1697,28 @@ module Google end end - # The per-product per-project service identity for a service. - # Use this field to configure per-product per-project service identity. - # Example of a service identity configuration. - # usage: - # service_identity: - # - service_account_parent: "projects/123456789" - # display_name: "Cloud XXX Service Agent" - # description: "Used as the identity of Cloud XXX to access resources" + # The per-product per-project service identity for a service. Use this field to + # configure per-product per-project service identity. Example of a service + # identity configuration. usage: service_identity: - service_account_parent: " + # projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used + # as the identity of Cloud XXX to access resources" class GoogleApiServiceIdentity include Google::Apis::Core::Hashable - # Optional. A user-specified opaque description of the service account. - # Must be less than or equal to 256 UTF-8 bytes. + # Optional. A user-specified opaque description of the service account. Must be + # less than or equal to 256 UTF-8 bytes. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Optional. A user-specified name for the service account. - # Must be less than or equal to 100 UTF-8 bytes. + # Optional. A user-specified name for the service account. Must be less than or + # equal to 100 UTF-8 bytes. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # A service account project that hosts the service accounts. - # An example name would be: - # `projects/123456789` + # A service account project that hosts the service accounts. An example name + # would be: `projects/123456789` # Corresponds to the JSON property `serviceAccountParent` # @return [String] attr_accessor :service_account_parent @@ -2045,8 +1739,7 @@ module Google class GoogleApiServiceusageV1OperationMetadata include Google::Apis::Core::Hashable - # The full name of the resources that this operation is directly - # associated with. + # The full name of the resources that this operation is directly associated with. # Corresponds to the JSON property `resourceNames` # @return [Array] attr_accessor :resource_names @@ -2070,16 +1763,13 @@ module Google # @return [Google::Apis::ServiceusageV1beta1::GoogleApiServiceusageV1ServiceConfig] attr_accessor :config - # The resource name of the consumer and service. - # A valid name would be: - # - projects/123/services/serviceusage.googleapis.com + # The resource name of the consumer and service. A valid name would be: - + # projects/123/services/serviceusage.googleapis.com # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The resource name of the consumer. - # A valid name would be: - # - projects/123 + # The resource name of the consumer. A valid name would be: - projects/123 # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -2112,129 +1802,76 @@ module Google # @return [Array] attr_accessor :apis - # `Authentication` defines the authentication configuration for an API. - # Example for an API targeted for external use: - # name: calendar.googleapis.com - # authentication: - # providers: - # - id: google_calendar_auth - # jwks_uri: https://www.googleapis.com/oauth2/v1/certs - # issuer: https://securetoken.google.com - # rules: - # - selector: "*" - # requirements: - # provider_id: google_calendar_auth + # `Authentication` defines the authentication configuration for an API. Example + # for an API targeted for external use: name: calendar.googleapis.com + # authentication: providers: - id: google_calendar_auth jwks_uri: https://www. + # googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - + # selector: "*" requirements: provider_id: google_calendar_auth # Corresponds to the JSON property `authentication` # @return [Google::Apis::ServiceusageV1beta1::Authentication] attr_accessor :authentication - # `Documentation` provides the information for describing a service. - # Example: - # 
documentation:
-        # summary: >
-        # The Google Calendar API gives access
-        # to most calendar features.
-        # pages:
-        # - name: Overview
-        # content: (== include google/foo/overview.md ==)
-        # - name: Tutorial
-        # content: (== include google/foo/tutorial.md ==)
-        # subpages;
-        # - name: Java
-        # content: (== include google/foo/tutorial_java.md ==)
-        # rules:
-        # - selector: google.calendar.Calendar.Get
-        # description: >
-        # ...
-        # - selector: google.calendar.Calendar.Put
-        # description: >
-        # ...
-        #
- # Documentation is provided in markdown syntax. In addition to - # standard markdown features, definition lists, tables and fenced - # code blocks are supported. Section headers can be provided and are - # interpreted relative to the section nesting of the context where - # a documentation fragment is embedded. - # Documentation from the IDL is merged with documentation defined - # via the config at normalization time, where documentation provided - # by config rules overrides IDL provided. - # A number of constructs specific to the API platform are supported - # in documentation text. - # In order to reference a proto element, the following - # notation can be used: - # 
[fully.qualified.proto.name][]
- # To override the display text used for the link, this can be used: - # 
[display text][fully.qualified.proto.name]
- # Text can be excluded from doc using the following notation: - # 
(-- internal comment --)
- # A few directives are available in documentation. Note that - # directives must appear on a single line to be properly - # identified. The `include` directive includes a markdown file from - # an external source: - # 
(== include path/to/file ==)
- # The `resource_for` directive marks a message to be the resource of - # a collection in REST view. If it is not specified, tools attempt - # to infer the resource from the operations in a collection: - # 
(== resource_for v1.shelves.books ==)
- # The directive `suppress_warning` does not directly affect documentation - # and is documented together with service config validation. + # `Documentation` provides the information for describing a service. Example: + # documentation: summary: > The Google Calendar API gives access to most + # calendar features. pages: - name: Overview content: (== include google/foo/ + # overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md == + # ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==) + # rules: - selector: google.calendar.Calendar.Get description: > ... - selector: + # google.calendar.Calendar.Put description: > ... Documentation is provided in + # markdown syntax. In addition to standard markdown features, definition lists, + # tables and fenced code blocks are supported. Section headers can be provided + # and are interpreted relative to the section nesting of the context where a + # documentation fragment is embedded. Documentation from the IDL is merged with + # documentation defined via the config at normalization time, where + # documentation provided by config rules overrides IDL provided. A number of + # constructs specific to the API platform are supported in documentation text. + # In order to reference a proto element, the following notation can be used: [ + # fully.qualified.proto.name][] To override the display text used for the link, + # this can be used: [display text][fully.qualified.proto.name] Text can be + # excluded from doc using the following notation: (-- internal comment --) A few + # directives are available in documentation. Note that directives must appear on + # a single line to be properly identified. The `include` directive includes a + # markdown file from an external source: (== include path/to/file ==) The ` + # resource_for` directive marks a message to be the resource of a collection in + # REST view. If it is not specified, tools attempt to infer the resource from + # the operations in a collection: (== resource_for v1.shelves.books ==) The + # directive `suppress_warning` does not directly affect documentation and is + # documented together with service config validation. # Corresponds to the JSON property `documentation` # @return [Google::Apis::ServiceusageV1beta1::Documentation] attr_accessor :documentation - # Configuration for network endpoints. Contains only the names and aliases - # of the endpoints. + # Configuration for network endpoints. Contains only the names and aliases of + # the endpoints. # Corresponds to the JSON property `endpoints` # @return [Array] attr_accessor :endpoints - # The DNS address at which this service is available. - # An example DNS address would be: - # `calendar.googleapis.com`. + # The DNS address at which this service is available. An example DNS address + # would be: `calendar.googleapis.com`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Quota configuration helps to achieve fairness and budgeting in service - # usage. - # The metric based quota configuration works this way: - # - The service configuration defines a set of metrics. - # - For API calls, the quota.metric_rules maps methods to metrics with - # corresponding costs. - # - The quota.limits defines limits on the metrics, which will be used for - # quota checks at runtime. - # An example quota configuration in yaml format: - # quota: - # limits: - # - name: apiWriteQpsPerProject - # metric: library.googleapis.com/write_calls - # unit: "1/min/`project`" # rate limit for consumer projects - # values: - # STANDARD: 10000 - # # The metric rules bind all methods to the read_calls metric, - # # except for the UpdateBook and DeleteBook methods. These two methods - # # are mapped to the write_calls metric, with the UpdateBook method - # # consuming at twice rate as the DeleteBook method. - # metric_rules: - # - selector: "*" - # metric_costs: - # library.googleapis.com/read_calls: 1 - # - selector: google.example.library.v1.LibraryService.UpdateBook - # metric_costs: - # library.googleapis.com/write_calls: 2 - # - selector: google.example.library.v1.LibraryService.DeleteBook - # metric_costs: - # library.googleapis.com/write_calls: 1 - # Corresponding Metric definition: - # metrics: - # - name: library.googleapis.com/read_calls - # display_name: Read requests - # metric_kind: DELTA - # value_type: INT64 - # - name: library.googleapis.com/write_calls - # display_name: Write requests - # metric_kind: DELTA - # value_type: INT64 + # Quota configuration helps to achieve fairness and budgeting in service usage. + # The metric based quota configuration works this way: - The service + # configuration defines a set of metrics. - For API calls, the quota. + # metric_rules maps methods to metrics with corresponding costs. - The quota. + # limits defines limits on the metrics, which will be used for quota checks at + # runtime. An example quota configuration in yaml format: quota: limits: - name: + # apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/` + # project`" # rate limit for consumer projects values: STANDARD: 10000 # The + # metric rules bind all methods to the read_calls metric, # except for the + # UpdateBook and DeleteBook methods. These two methods # are mapped to the + # write_calls metric, with the UpdateBook method # consuming at twice rate as + # the DeleteBook method. metric_rules: - selector: "*" metric_costs: library. + # googleapis.com/read_calls: 1 - selector: google.example.library.v1. + # LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - + # selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: + # library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: + # - name: library.googleapis.com/read_calls display_name: Read requests + # metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/ + # write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 # Corresponds to the JSON property `quota` # @return [Google::Apis::ServiceusageV1beta1::Quota] attr_accessor :quota @@ -2297,15 +1934,14 @@ module Google class GoogleApiServiceusageV1beta1ServiceIdentity include Google::Apis::Core::Hashable - # The email address of the service account that a service producer would use - # to access consumer resources. + # The email address of the service account that a service producer would use to + # access consumer resources. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email - # The unique and stable id of the service account. - # https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts# - # ServiceAccount + # The unique and stable id of the service account. https://cloud.google.com/iam/ + # reference/rest/v1/projects.serviceAccounts#ServiceAccount # Corresponds to the JSON property `uniqueId` # @return [String] attr_accessor :unique_id @@ -2322,23 +1958,22 @@ module Google end # Defines the HTTP configuration for an API service. It contains a list of - # HttpRule, each specifying the mapping of an RPC method - # to one or more HTTP REST API methods. + # HttpRule, each specifying the mapping of an RPC method to one or more HTTP + # REST API methods. class Http include Google::Apis::Core::Hashable # When set to true, URL path parameters will be fully URI-decoded except in # cases of single segment matches in reserved expansion, where "%2F" will be - # left encoded. - # The default behavior is to not decode RFC 6570 reserved characters in multi - # segment matches. + # left encoded. The default behavior is to not decode RFC 6570 reserved + # characters in multi segment matches. # Corresponds to the JSON property `fullyDecodeReservedExpansion` # @return [Boolean] attr_accessor :fully_decode_reserved_expansion alias_method :fully_decode_reserved_expansion?, :fully_decode_reserved_expansion - # A list of HTTP configuration rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of HTTP configuration rules that apply to individual API methods. ** + # NOTE:** All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -2354,251 +1989,156 @@ module Google end end - # # gRPC Transcoding - # gRPC Transcoding is a feature for mapping between a gRPC method and one or - # more HTTP REST endpoints. It allows developers to build a single API service - # that supports both gRPC APIs and REST APIs. Many systems, including [Google - # APIs](https://github.com/googleapis/googleapis), - # [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC - # Gateway](https://github.com/grpc-ecosystem/grpc-gateway), - # and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature - # and use it for large scale production services. - # `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies - # how different portions of the gRPC request message are mapped to the URL - # path, URL query parameters, and HTTP request body. It also controls how the - # gRPC response message is mapped to the HTTP response body. `HttpRule` is + # # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC + # method and one or more HTTP REST endpoints. It allows developers to build a + # single API service that supports both gRPC APIs and REST APIs. Many systems, + # including [Google APIs](https://github.com/googleapis/googleapis), [Cloud + # Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github. + # com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/ + # envoy) proxy support this feature and use it for large scale production + # services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping + # specifies how different portions of the gRPC request message are mapped to the + # URL path, URL query parameters, and HTTP request body. It also controls how + # the gRPC response message is mapped to the HTTP response body. `HttpRule` is # typically specified as an `google.api.http` annotation on the gRPC method. # Each mapping specifies a URL path template and an HTTP method. The path # template may refer to one or more fields in the gRPC request message, as long - # as each field is a non-repeated field with a primitive (non-message) type. - # The path template controls how fields of the request message are mapped to - # the URL path. - # Example: - # service Messaging ` - # rpc GetMessage(GetMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # get: "/v1/`name=messages/*`" - # `; - # ` - # ` - # message GetMessageRequest ` - # string name = 1; // Mapped to URL path. - # ` - # message Message ` - # string text = 1; // The resource content. - # ` - # This enables an HTTP REST to gRPC mapping as below: - # HTTP | gRPC - # -----|----- - # `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` - # Any fields in the request message which are not bound by the path template - # automatically become HTTP query parameters if there is no HTTP request body. - # For example: - # service Messaging ` - # rpc GetMessage(GetMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # get:"/v1/messages/`message_id`" - # `; - # ` - # ` - # message GetMessageRequest ` - # message SubMessage ` - # string subfield = 1; - # ` - # string message_id = 1; // Mapped to URL path. - # int64 revision = 2; // Mapped to URL query parameter `revision`. - # SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. - # ` - # This enables a HTTP JSON to RPC mapping as below: - # HTTP | gRPC - # -----|----- - # `GET /v1/messages/123456?revision=2&sub.subfield=foo` | - # `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: - # "foo"))` - # Note that fields which are mapped to URL query parameters must have a - # primitive type or a repeated primitive type or a non-repeated message type. - # In the case of a repeated type, the parameter can be repeated in the URL - # as `...?param=A¶m=B`. In the case of a message type, each field of the - # message is mapped to a separate parameter, such as - # `...?foo.a=A&foo.b=B&foo.c=C`. - # For HTTP methods that allow a request body, the `body` field - # specifies the mapping. Consider a REST update method on the - # message resource collection: - # service Messaging ` - # rpc UpdateMessage(UpdateMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # patch: "/v1/messages/`message_id`" - # body: "message" - # `; - # ` - # ` - # message UpdateMessageRequest ` - # string message_id = 1; // mapped to the URL - # Message message = 2; // mapped to the body - # ` - # The following HTTP JSON to RPC mapping is enabled, where the - # representation of the JSON in the request body is determined by - # protos JSON encoding: - # HTTP | gRPC - # -----|----- - # `PATCH /v1/messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: - # "123456" message ` text: "Hi!" `)` - # The special name `*` can be used in the body mapping to define that - # every field not bound by the path template should be mapped to the - # request body. This enables the following alternative definition of - # the update method: - # service Messaging ` - # rpc UpdateMessage(Message) returns (Message) ` - # option (google.api.http) = ` - # patch: "/v1/messages/`message_id`" - # body: "*" - # `; - # ` - # ` - # message Message ` - # string message_id = 1; - # string text = 2; - # ` - # The following HTTP JSON to RPC mapping is enabled: - # HTTP | gRPC - # -----|----- - # `PATCH /v1/messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: - # "123456" text: "Hi!")` - # Note that when using `*` in the body mapping, it is not possible to - # have HTTP parameters, as all fields not bound by the path end in - # the body. This makes this option more rarely used in practice when - # defining REST APIs. The common usage of `*` is in custom methods - # which don't use the URL at all for transferring data. - # It is possible to define multiple HTTP methods for one RPC by using - # the `additional_bindings` option. Example: - # service Messaging ` - # rpc GetMessage(GetMessageRequest) returns (Message) ` - # option (google.api.http) = ` - # get: "/v1/messages/`message_id`" - # additional_bindings ` - # get: "/v1/users/`user_id`/messages/`message_id`" - # ` - # `; - # ` - # ` - # message GetMessageRequest ` - # string message_id = 1; - # string user_id = 2; - # ` - # This enables the following two alternative HTTP JSON to RPC mappings: - # HTTP | gRPC - # -----|----- - # `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` - # `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: - # "123456")` - # ## Rules for HTTP mapping - # 1. Leaf request fields (recursive expansion nested messages in the request - # message) are classified into three categories: - # - Fields referred by the path template. They are passed via the URL path. - # - Fields referred by the HttpRule.body. They are passed via the HTTP - # request body. - # - All other fields are passed via the URL query parameters, and the - # parameter name is the field path in the request message. A repeated - # field can be represented as multiple query parameters under the same - # name. - # 2. If HttpRule.body is "*", there is no URL query parameter, all fields - # are passed via URL path and HTTP request body. - # 3. If HttpRule.body is omitted, there is no HTTP request body, all - # fields are passed via URL path and URL query parameters. - # ### Path template syntax - # Template = "/" Segments [ Verb ] ; - # Segments = Segment ` "/" Segment ` ; - # Segment = "*" | "**" | LITERAL | Variable ; - # Variable = "`" FieldPath [ "=" Segments ] "`" ; - # FieldPath = IDENT ` "." IDENT ` ; - # Verb = ":" LITERAL ; - # The syntax `*` matches a single URL path segment. The syntax `**` matches - # zero or more URL path segments, which must be the last part of the URL path - # except the `Verb`. - # The syntax `Variable` matches part of the URL path as specified by its - # template. A variable template must not contain other variables. If a variable - # matches a single path segment, its template may be omitted, e.g. ``var`` - # is equivalent to ``var=*``. - # The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` - # contains any reserved character, such characters should be percent-encoded - # before the matching. - # If a variable contains exactly one path segment, such as `"`var`"` or - # `"`var=*`"`, when such a variable is expanded into a URL path on the client - # side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The - # server side does the reverse decoding. Such variables show up in the - # [Discovery - # Document](https://developers.google.com/discovery/v1/reference/apis) as - # ``var``. - # If a variable contains multiple path segments, such as `"`var=foo/*`"` - # or `"`var=**`"`, when such a variable is expanded into a URL path on the - # client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. - # The server side does the reverse decoding, except "%2F" and "%2f" are left - # unchanged. Such variables show up in the - # [Discovery - # Document](https://developers.google.com/discovery/v1/reference/apis) as - # ``+var``. - # ## Using gRPC API Service Configuration - # gRPC API Service Configuration (service config) is a configuration language - # for configuring a gRPC service to become a user-facing product. The - # service config is simply the YAML representation of the `google.api.Service` - # proto message. + # as each field is a non-repeated field with a primitive (non-message) type. The + # path template controls how fields of the request message are mapped to the URL + # path. Example: service Messaging ` rpc GetMessage(GetMessageRequest) returns ( + # Message) ` option (google.api.http) = ` get: "/v1/`name=messages/*`" `; ` ` + # message GetMessageRequest ` string name = 1; // Mapped to URL path. ` message + # Message ` string text = 1; // The resource content. ` This enables an HTTP + # REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/ + # 123456` | `GetMessage(name: "messages/123456")` Any fields in the request + # message which are not bound by the path template automatically become HTTP + # query parameters if there is no HTTP request body. For example: service + # Messaging ` rpc GetMessage(GetMessageRequest) returns (Message) ` option ( + # google.api.http) = ` get:"/v1/messages/`message_id`" `; ` ` message + # GetMessageRequest ` message SubMessage ` string subfield = 1; ` string + # message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL + # query parameter `revision`. SubMessage sub = 3; // Mapped to URL query + # parameter `sub.subfield`. ` This enables a HTTP JSON to RPC mapping as below: + # HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | + # `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo")) + # ` Note that fields which are mapped to URL query parameters must have a + # primitive type or a repeated primitive type or a non-repeated message type. In + # the case of a repeated type, the parameter can be repeated in the URL as `...? + # param=A¶m=B`. In the case of a message type, each field of the message is + # mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For + # HTTP methods that allow a request body, the `body` field specifies the mapping. + # Consider a REST update method on the message resource collection: service + # Messaging ` rpc UpdateMessage(UpdateMessageRequest) returns (Message) ` option + # (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "message" `; ` ` + # message UpdateMessageRequest ` string message_id = 1; // mapped to the URL + # Message message = 2; // mapped to the body ` The following HTTP JSON to RPC + # mapping is enabled, where the representation of the JSON in the request body + # is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/ + # messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456" + # message ` text: "Hi!" `)` The special name `*` can be used in the body mapping + # to define that every field not bound by the path template should be mapped to + # the request body. This enables the following alternative definition of the + # update method: service Messaging ` rpc UpdateMessage(Message) returns (Message) + # ` option (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "*" `; + # ` ` message Message ` string message_id = 1; string text = 2; ` The following + # HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/ + # messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456" text: + # "Hi!")` Note that when using `*` in the body mapping, it is not possible to + # have HTTP parameters, as all fields not bound by the path end in the body. + # This makes this option more rarely used in practice when defining REST APIs. + # The common usage of `*` is in custom methods which don't use the URL at all + # for transferring data. It is possible to define multiple HTTP methods for one + # RPC by using the `additional_bindings` option. Example: service Messaging ` + # rpc GetMessage(GetMessageRequest) returns (Message) ` option (google.api.http) + # = ` get: "/v1/messages/`message_id`" additional_bindings ` get: "/v1/users/` + # user_id`/messages/`message_id`" ` `; ` ` message GetMessageRequest ` string + # message_id = 1; string user_id = 2; ` This enables the following two + # alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/ + # messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/ + # messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules + # for HTTP mapping 1. Leaf request fields (recursive expansion nested messages + # in the request message) are classified into three categories: - Fields + # referred by the path template. They are passed via the URL path. - Fields + # referred by the HttpRule.body. They are passed via the HTTP request body. - + # All other fields are passed via the URL query parameters, and the parameter + # name is the field path in the request message. A repeated field can be + # represented as multiple query parameters under the same name. 2. If HttpRule. + # body is "*", there is no URL query parameter, all fields are passed via URL + # path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP + # request body, all fields are passed via URL path and URL query parameters. ### + # Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment ` "/ + # " Segment ` ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "`" + # FieldPath [ "=" Segments ] "`" ; FieldPath = IDENT ` "." IDENT ` ; Verb = ":" + # LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` + # matches zero or more URL path segments, which must be the last part of the URL + # path except the `Verb`. The syntax `Variable` matches part of the URL path as + # specified by its template. A variable template must not contain other + # variables. If a variable matches a single path segment, its template may be + # omitted, e.g. ``var`` is equivalent to ``var=*``. The syntax `LITERAL` matches + # literal text in the URL path. If the `LITERAL` contains any reserved character, + # such characters should be percent-encoded before the matching. If a variable + # contains exactly one path segment, such as `"`var`"` or `"`var=*`"`, when such + # a variable is expanded into a URL path on the client side, all characters + # except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse + # decoding. Such variables show up in the [Discovery Document](https:// + # developers.google.com/discovery/v1/reference/apis) as ``var``. If a variable + # contains multiple path segments, such as `"`var=foo/*`"` or `"`var=**`"`, when + # such a variable is expanded into a URL path on the client side, all characters + # except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the + # reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables + # show up in the [Discovery Document](https://developers.google.com/discovery/v1/ + # reference/apis) as ``+var``. ## Using gRPC API Service Configuration gRPC API + # Service Configuration (service config) is a configuration language for + # configuring a gRPC service to become a user-facing product. The service config + # is simply the YAML representation of the `google.api.Service` proto message. # As an alternative to annotating your proto file, you can configure gRPC - # transcoding in your service config YAML files. You do this by specifying a - # `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same - # effect as the proto annotation. This can be particularly useful if you - # have a proto that is reused in multiple services. Note that any transcoding - # specified in the service config will override any matching transcoding - # configuration in the proto. - # Example: - # http: - # rules: - # # Selects a gRPC method and applies HttpRule to it. - # - selector: example.v1.Messaging.GetMessage - # get: /v1/messages/`message_id`/`sub.subfield` - # ## Special notes - # When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the - # proto to JSON conversion must follow the [proto3 - # specification](https://developers.google.com/protocol-buffers/docs/proto3#json) - # . - # While the single segment variable follows the semantics of - # [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String - # Expansion, the multi segment variable **does not** follow RFC 6570 Section - # 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion - # does not expand special characters like `?` and `#`, which would lead - # to invalid URLs. As the result, gRPC Transcoding uses a custom encoding - # for multi segment variables. - # The path variables **must not** refer to any repeated or mapped field, - # because client libraries are not capable of handling such variable expansion. - # The path variables **must not** capture the leading "/" character. The reason - # is that the most common use case "`var`" does not capture the leading "/" - # character. For consistency, all path variables must share the same behavior. - # Repeated message fields must not be mapped to URL query parameters, because - # no client library can support such complicated mapping. - # If an API needs to use a JSON array for request or response body, it can map - # the request or response body to a repeated field. However, some gRPC - # Transcoding implementations may not support this feature. + # transcoding in your service config YAML files. You do this by specifying a ` + # HttpRule` that maps the gRPC method to a REST endpoint, achieving the same + # effect as the proto annotation. This can be particularly useful if you have a + # proto that is reused in multiple services. Note that any transcoding specified + # in the service config will override any matching transcoding configuration in + # the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule + # to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/` + # message_id`/`sub.subfield` ## Special notes When gRPC Transcoding is used to + # map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow + # the [proto3 specification](https://developers.google.com/protocol-buffers/docs/ + # proto3#json). While the single segment variable follows the semantics of [RFC + # 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String + # Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2. + # 3 Reserved Expansion. The reason is that the Reserved Expansion does not + # expand special characters like `?` and `#`, which would lead to invalid URLs. + # As the result, gRPC Transcoding uses a custom encoding for multi segment + # variables. The path variables **must not** refer to any repeated or mapped + # field, because client libraries are not capable of handling such variable + # expansion. The path variables **must not** capture the leading "/" character. + # The reason is that the most common use case "`var`" does not capture the + # leading "/" character. For consistency, all path variables must share the same + # behavior. Repeated message fields must not be mapped to URL query parameters, + # because no client library can support such complicated mapping. If an API + # needs to use a JSON array for request or response body, it can map the request + # or response body to a repeated field. However, some gRPC Transcoding + # implementations may not support this feature. class HttpRule include Google::Apis::Core::Hashable - # Additional HTTP bindings for the selector. Nested bindings must - # not contain an `additional_bindings` field themselves (that is, - # the nesting may only be one level deep). + # Additional HTTP bindings for the selector. Nested bindings must not contain an + # `additional_bindings` field themselves (that is, the nesting may only be one + # level deep). # Corresponds to the JSON property `additionalBindings` # @return [Array] attr_accessor :additional_bindings - # When this flag is set to true, HTTP requests will be allowed to invoke a - # half-duplex streaming method. + # When this flag is set to true, HTTP requests will be allowed to invoke a half- + # duplex streaming method. # Corresponds to the JSON property `allowHalfDuplex` # @return [Boolean] attr_accessor :allow_half_duplex alias_method :allow_half_duplex?, :allow_half_duplex - # The name of the request field whose value is mapped to the HTTP request - # body, or `*` for mapping all request fields not captured by the path - # pattern to the HTTP body, or omitted for not having any HTTP request body. - # NOTE: the referred field must be present at the top-level of the request - # message type. + # The name of the request field whose value is mapped to the HTTP request body, + # or `*` for mapping all request fields not captured by the path pattern to the + # HTTP body, or omitted for not having any HTTP request body. NOTE: the referred + # field must be present at the top-level of the request message type. # Corresponds to the JSON property `body` # @return [String] attr_accessor :body @@ -2613,8 +2153,7 @@ module Google # @return [String] attr_accessor :delete - # Maps to HTTP GET. Used for listing and getting information about - # resources. + # Maps to HTTP GET. Used for listing and getting information about resources. # Corresponds to the JSON property `get` # @return [String] attr_accessor :get @@ -2635,16 +2174,15 @@ module Google attr_accessor :put # Optional. The name of the response field whose value is mapped to the HTTP - # response body. When omitted, the entire response message will be used - # as the HTTP response body. - # NOTE: The referred field must be present at the top-level of the response - # message type. + # response body. When omitted, the entire response message will be used as the + # HTTP response body. NOTE: The referred field must be present at the top-level + # of the response message type. # Corresponds to the JSON property `responseBody` # @return [String] attr_accessor :response_body - # Selects a method to which this rule applies. - # Refer to selector for syntax details. + # Selects a method to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -2711,11 +2249,11 @@ module Google class ImportConsumerOverridesRequest include Google::Apis::Core::Hashable - # Whether to force the creation of the quota overrides. - # If creating an override would cause the effective quota for the consumer to - # decrease by more than 10 percent, the call is rejected, as a safety measure - # to avoid accidentally decreasing quota too quickly. Setting the force - # parameter to true ignores this restriction. + # Whether to force the creation of the quota overrides. If creating an override + # would cause the effective quota for the consumer to decrease by more than 10 + # percent, the call is rejected, as a safety measure to avoid accidentally + # decreasing quota too quickly. Setting the force parameter to true ignores this + # restriction. # Corresponds to the JSON property `force` # @return [Boolean] attr_accessor :force @@ -2770,13 +2308,12 @@ module Google # @return [String] attr_accessor :query - # The value prefix. The value format is "value_prefix`token`" - # Only applies to "in" header type. Must be empty for "in" query type. - # If not empty, the header value has to match (case sensitive) this prefix. - # If not matched, JWT will not be extracted. If matched, JWT will be - # extracted after the prefix is removed. - # For example, for "Authorization: Bearer `JWT`", - # value_prefix="Bearer " with a space at the end. + # The value prefix. The value format is "value_prefix`token`" Only applies to " + # in" header type. Must be empty for "in" query type. If not empty, the header + # value has to match (case sensitive) this prefix. If not matched, JWT will not + # be extracted. If matched, JWT will be extracted after the prefix is removed. + # For example, for "Authorization: Bearer `JWT`", value_prefix="Bearer " with a + # space at the end. # Corresponds to the JSON property `valuePrefix` # @return [String] attr_accessor :value_prefix @@ -2828,8 +2365,7 @@ module Google class ListAdminOverridesResponse include Google::Apis::Core::Hashable - # Token identifying which result to start with; returned by a previous list - # call. + # Token identifying which result to start with; returned by a previous list call. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2854,8 +2390,7 @@ module Google class ListConsumerOverridesResponse include Google::Apis::Core::Hashable - # Token identifying which result to start with; returned by a previous list - # call. + # Token identifying which result to start with; returned by a previous list call. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2885,8 +2420,7 @@ module Google # @return [Array] attr_accessor :metrics - # Token identifying which result to start with; returned by a previous list - # call. + # Token identifying which result to start with; returned by a previous list call. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2931,8 +2465,7 @@ module Google class ListServicesResponse include Google::Apis::Core::Hashable - # Token that can be passed to `ListServices` to resume a paginated - # query. + # Token that can be passed to `ListServices` to resume a paginated query. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2953,39 +2486,35 @@ module Google end end - # A description of a log type. Example in YAML format: - # - name: library.googleapis.com/activity_history - # description: The history of borrowing and returning library items. - # display_name: Activity - # labels: - # - key: /customer_id + # A description of a log type. Example in YAML format: - name: library. + # googleapis.com/activity_history description: The history of borrowing and + # returning library items. display_name: Activity labels: - key: /customer_id # description: Identifier of a library customer class LogDescriptor include Google::Apis::Core::Hashable - # A human-readable description of this log. This information appears in - # the documentation and can contain details. + # A human-readable description of this log. This information appears in the + # documentation and can contain details. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # The human-readable name for this log. This information appears on - # the user interface and should be concise. + # The human-readable name for this log. This information appears on the user + # interface and should be concise. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # The set of labels that are available to describe a specific log entry. - # Runtime requests that contain labels not specified here are - # considered invalid. + # The set of labels that are available to describe a specific log entry. Runtime + # requests that contain labels not specified here are considered invalid. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels - # The name of the log. It must be less than 512 characters long and can - # include the following characters: upper- and lower-case alphanumeric - # characters [A-Za-z0-9], and punctuation characters including - # slash, underscore, hyphen, period [/_-.]. + # The name of the log. It must be less than 512 characters long and can include + # the following characters: upper- and lower-case alphanumeric characters [A-Za- + # z0-9], and punctuation characters including slash, underscore, hyphen, period [ + # /_-.]. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3003,48 +2532,30 @@ module Google end end - # Logging configuration of the service. - # The following example shows how to configure logs to be sent to the - # producer and consumer projects. In the example, the `activity_history` - # log is sent to both the producer and consumer projects, whereas the - # `purchase_history` log is only sent to the producer project. - # monitored_resources: - # - type: library.googleapis.com/branch - # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. - # logs: - # - name: activity_history - # labels: - # - key: /customer_id - # - name: purchase_history - # logging: - # producer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history - # - purchase_history - # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch - # logs: - # - activity_history + # Logging configuration of the service. The following example shows how to + # configure logs to be sent to the producer and consumer projects. In the + # example, the `activity_history` log is sent to both the producer and consumer + # projects, whereas the `purchase_history` log is only sent to the producer + # project. monitored_resources: - type: library.googleapis.com/branch labels: - + # key: /city description: The city where the library branch is located in. - key: + # /name description: The name of the branch. logs: - name: activity_history + # labels: - key: /customer_id - name: purchase_history logging: + # producer_destinations: - monitored_resource: library.googleapis.com/branch + # logs: - activity_history - purchase_history consumer_destinations: - + # monitored_resource: library.googleapis.com/branch logs: - activity_history class Logging include Google::Apis::Core::Hashable - # Logging configurations for sending logs to the consumer project. - # There can be multiple consumer destinations, each one must have a - # different monitored resource type. A log can be used in at most - # one consumer destination. + # Logging configurations for sending logs to the consumer project. There can be + # multiple consumer destinations, each one must have a different monitored + # resource type. A log can be used in at most one consumer destination. # Corresponds to the JSON property `consumerDestinations` # @return [Array] attr_accessor :consumer_destinations - # Logging configurations for sending logs to the producer project. - # There can be multiple producer destinations, each one must have a - # different monitored resource type. A log can be used in at most - # one producer destination. + # Logging configurations for sending logs to the producer project. There can be + # multiple producer destinations, each one must have a different monitored + # resource type. A log can be used in at most one producer destination. # Corresponds to the JSON property `producerDestinations` # @return [Array] attr_accessor :producer_destinations @@ -3060,21 +2571,20 @@ module Google end end - # Configuration of a specific logging destination (the producer project - # or the consumer project). + # Configuration of a specific logging destination (the producer project or the + # consumer project). class LoggingDestination include Google::Apis::Core::Hashable - # Names of the logs to be sent to this destination. Each name must - # be defined in the Service.logs section. If the log name is - # not a domain scoped name, it will be automatically prefixed with - # the service name followed by "/". + # Names of the logs to be sent to this destination. Each name must be defined in + # the Service.logs section. If the log name is not a domain scoped name, it will + # be automatically prefixed with the service name followed by "/". # Corresponds to the JSON property `logs` # @return [Array] attr_accessor :logs - # The monitored resource type. The type must be defined in the - # Service.monitored_resources section. + # The monitored resource type. The type must be defined in the Service. + # monitored_resources section. # Corresponds to the JSON property `monitoredResource` # @return [String] attr_accessor :monitored_resource @@ -3149,16 +2659,13 @@ module Google # Defines a metric type and its schema. Once a metric descriptor is created, # deleting or altering it stops data collection and makes the metric type's - # existing data unusable. - # The following are specific rules for service defined Monitoring metric - # descriptors: - # * `type`, `metric_kind`, `value_type` and `description` - # fields are all required. The `unit` field must be specified - # if the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. - # * Maximum of default 500 metric descriptors per service is allowed. - # * Maximum of default 10 labels per metric descriptor is allowed. - # The default maximum limit can be overridden. Please follow - # https://cloud.google.com/monitoring/quotas + # existing data unusable. The following are specific rules for service defined + # Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and ` + # description` fields are all required. The `unit` field must be specified if + # the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default + # 500 metric descriptors per service is allowed. * Maximum of default 10 labels + # per metric descriptor is allowed. The default maximum limit can be overridden. + # Please follow https://cloud.google.com/monitoring/quotas class MetricDescriptor include Google::Apis::Core::Hashable @@ -3167,26 +2674,21 @@ module Google # @return [String] attr_accessor :description - # A concise name for the metric, which can be displayed in user interfaces. - # Use sentence case without an ending period, for example "Request count". - # This field is optional but it is recommended to be set for any metrics - # associated with user-visible concepts, such as Quota. + # A concise name for the metric, which can be displayed in user interfaces. Use + # sentence case without an ending period, for example "Request count". This + # field is optional but it is recommended to be set for any metrics associated + # with user-visible concepts, such as Quota. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # The set of labels that can be used to describe a specific - # instance of this metric type. - # The label key name must follow: - # * Only upper and lower-case letters, digits and underscores (_) are - # allowed. - # * Label name must start with a letter or digit. - # * The maximum length of a label name is 100 characters. - # For example, the - # `appengine.googleapis.com/http/server/response_latencies` metric - # type has a label for the HTTP response code, `response_code`, so - # you can look at latencies for successful responses or just - # for responses that failed. + # The set of labels that can be used to describe a specific instance of this + # metric type. The label key name must follow: * Only upper and lower-case + # letters, digits and underscores (_) are allowed. * Label name must start with + # a letter or digit. * The maximum length of a label name is 100 characters. For + # example, the `appengine.googleapis.com/http/server/response_latencies` metric + # type has a label for the HTTP response code, `response_code`, so you can look + # at latencies for successful responses or just for responses that failed. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels @@ -3201,17 +2703,16 @@ module Google # @return [Google::Apis::ServiceusageV1beta1::MetricDescriptorMetadata] attr_accessor :metadata - # Whether the metric records instantaneous values, changes to a value, etc. - # Some combinations of `metric_kind` and `value_type` might not be supported. + # Whether the metric records instantaneous values, changes to a value, etc. Some + # combinations of `metric_kind` and `value_type` might not be supported. # Corresponds to the JSON property `metricKind` # @return [String] attr_accessor :metric_kind - # Read-only. If present, then a time - # series, which is identified partially by - # a metric type and a MonitoredResourceDescriptor, that is associated - # with this metric type can only be associated with one of the monitored - # resource types listed here. + # Read-only. If present, then a time series, which is identified partially by a + # metric type and a MonitoredResourceDescriptor, that is associated with this + # metric type can only be associated with one of the monitored resource types + # listed here. # Corresponds to the JSON property `monitoredResourceTypes` # @return [Array] attr_accessor :monitored_resource_types @@ -3221,116 +2722,73 @@ module Google # @return [String] attr_accessor :name - # The metric type, including its DNS name prefix. The type is not - # URL-encoded. + # The metric type, including its DNS name prefix. The type is not URL-encoded. # All service defined metrics must be prefixed with the service name, in the - # format of ``service name`/`relative metric name``, such as - # `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric - # name must follow: + # format of ``service name`/`relative metric name``, such as `cloudsql. + # googleapis.com/database/cpu/utilization`. The relative metric name must follow: # * Only upper and lower-case letters, digits, '/' and underscores '_' are - # allowed. - # * The maximum number of characters allowed for the relative_metric_name is - # 100. - # All user-defined metric types have the DNS name - # `custom.googleapis.com`, `external.googleapis.com`, or - # `logging.googleapis.com/user/`. - # Metric types should use a natural hierarchical grouping. For example: - # "custom.googleapis.com/invoice/paid/amount" - # "external.googleapis.com/prometheus/up" - # "appengine.googleapis.com/http/server/response_latencies" + # allowed. * The maximum number of characters allowed for the + # relative_metric_name is 100. All user-defined metric types have the DNS name ` + # custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/ + # user/`. Metric types should use a natural hierarchical grouping. For example: " + # custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/ + # up" "appengine.googleapis.com/http/server/response_latencies" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # The units in which the metric value is reported. It is only applicable - # if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` - # defines the representation of the stored metric values. - # Different systems may scale the values to be more easily displayed (so a - # value of `0.02KBy` _might_ be displayed as `20By`, and a value of - # `3523KBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is - # `KBy`, then the value of the metric is always in thousands of bytes, no - # matter how it may be displayed.. - # If you want a custom metric to record the exact number of CPU-seconds used - # by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is - # `s`CPU`` (or equivalently `1s`CPU`` or just `s`). If the job uses 12,005 - # CPU-seconds, then the value is written as `12005`. - # Alternatively, if you want a custom metric to record data in a more - # granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is - # `ks`CPU``, and then write the value `12.005` (which is `12005/1000`), - # or use `Kis`CPU`` and write `11.723` (which is `12005/1024`). - # The supported units are a subset of [The Unified Code for Units of - # Measure](http://unitsofmeasure.org/ucum.html) standard: - # **Basic units (UNIT)** - # * `bit` bit - # * `By` byte - # * `s` second - # * `min` minute - # * `h` hour - # * `d` day - # * `1` dimensionless - # **Prefixes (PREFIX)** - # * `k` kilo (10^3) - # * `M` mega (10^6) - # * `G` giga (10^9) - # * `T` tera (10^12) - # * `P` peta (10^15) - # * `E` exa (10^18) - # * `Z` zetta (10^21) - # * `Y` yotta (10^24) - # * `m` milli (10^-3) - # * `u` micro (10^-6) - # * `n` nano (10^-9) - # * `p` pico (10^-12) - # * `f` femto (10^-15) - # * `a` atto (10^-18) - # * `z` zepto (10^-21) - # * `y` yocto (10^-24) - # * `Ki` kibi (2^10) - # * `Mi` mebi (2^20) - # * `Gi` gibi (2^30) - # * `Ti` tebi (2^40) - # * `Pi` pebi (2^50) - # **Grammar** - # The grammar also includes these connectors: - # * `/` division or ratio (as an infix operator). For examples, - # `kBy/`email`` or `MiBy/10ms` (although you should almost never - # have `/s` in a metric `unit`; rates should always be computed at - # query time from the underlying cumulative or delta value). - # * `.` multiplication or composition (as an infix operator). For - # examples, `GBy.d` or `k`watt`.h`. - # The grammar for a unit is as follows: - # Expression = Component ` "." Component ` ` "/" Component ` ; - # Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] - # | Annotation - # | "1" - # ; - # Annotation = "`" NAME "`" ; - # Notes: - # * `Annotation` is just a comment if it follows a `UNIT`. If the annotation - # is used alone, then the unit is equivalent to `1`. For examples, - # ``request`/s == 1/s`, `By`transmitted`/s == By/s`. - # * `NAME` is a sequence of non-blank printable ASCII characters not - # containing ``` or ```. - # * `1` represents a unitary [dimensionless - # unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such - # as in `1/s`. It is typically used when none of the basic units are - # appropriate. For example, "new users per day" can be represented as - # `1/d` or ``new-users`/d` (and a metric value `5` would mean "5 new - # users). Alternatively, "thousands of page views per day" would be - # represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric - # value of `5.3` would mean "5300 page views per day"). - # * `%` represents dimensionless value of 1/100, and annotates values giving - # a percentage (so the metric values are typically in the range of 0..100, - # and a metric value `3` means "3 percent"). - # * `10^2.%` indicates a metric contains a ratio, typically in the range - # 0..1, that will be multiplied by 100 and displayed as a percentage - # (so a metric value `0.03` means "3 percent"). + # The units in which the metric value is reported. It is only applicable if the ` + # value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the + # representation of the stored metric values. Different systems may scale the + # values to be more easily displayed (so a value of `0.02KBy` _might_ be + # displayed as `20By`, and a value of `3523KBy` _might_ be displayed as `3.5MBy`) + # . However, if the `unit` is `KBy`, then the value of the metric is always in + # thousands of bytes, no matter how it may be displayed.. If you want a custom + # metric to record the exact number of CPU-seconds used by a job, you can create + # an `INT64 CUMULATIVE` metric whose `unit` is `s`CPU`` (or equivalently `1s`CPU` + # ` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written + # as `12005`. Alternatively, if you want a custom metric to record data in a + # more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is + # `ks`CPU``, and then write the value `12.005` (which is `12005/1000`), or use ` + # Kis`CPU`` and write `11.723` (which is `12005/1024`). The supported units are + # a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ + # ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` + # second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes ( + # PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^ + # 12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^ + # 24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^- + # 12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto ( + # 10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi ( + # 2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these + # connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/ + # `email`` or `MiBy/10ms` (although you should almost never have `/s` in a + # metric `unit`; rates should always be computed at query time from the + # underlying cumulative or delta value). * `.` multiplication or composition (as + # an infix operator). For examples, `GBy.d` or `k`watt`.h`. The grammar for a + # unit is as follows: Expression = Component ` "." Component ` ` "/" Component ` + # ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; + # Annotation = "`" NAME "`" ; Notes: * `Annotation` is just a comment if it + # follows a `UNIT`. If the annotation is used alone, then the unit is equivalent + # to `1`. For examples, ``request`/s == 1/s`, `By`transmitted`/s == By/s`. * ` + # NAME` is a sequence of non-blank printable ASCII characters not containing ``` + # or ```. * `1` represents a unitary [dimensionless unit](https://en.wikipedia. + # org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used + # when none of the basic units are appropriate. For example, "new users per day" + # can be represented as `1/d` or ``new-users`/d` (and a metric value `5` would + # mean "5 new users). Alternatively, "thousands of page views per day" would be + # represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric value of ` + # 5.3` would mean "5300 page views per day"). * `%` represents dimensionless + # value of 1/100, and annotates values giving a percentage (so the metric values + # are typically in the range of 0..100, and a metric value `3` means "3 percent") + # . * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, + # that will be multiplied by 100 and displayed as a percentage (so a metric + # value `0.03` means "3 percent"). # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit - # Whether the measurement is an integer, a floating-point number, etc. - # Some combinations of `metric_kind` and `value_type` might not be supported. + # Whether the measurement is an integer, a floating-point number, etc. Some + # combinations of `metric_kind` and `value_type` might not be supported. # Corresponds to the JSON property `valueType` # @return [String] attr_accessor :value_type @@ -3359,9 +2817,9 @@ module Google class MetricDescriptorMetadata include Google::Apis::Core::Hashable - # The delay of data points caused by ingestion. Data points older than this - # age are guaranteed to be ingested and available to be read, excluding - # data loss due to errors. + # The delay of data points caused by ingestion. Data points older than this age + # are guaranteed to be ingested and available to be read, excluding data loss + # due to errors. # Corresponds to the JSON property `ingestDelay` # @return [String] attr_accessor :ingest_delay @@ -3373,8 +2831,8 @@ module Google # The sampling period of metric data points. For metrics which are written # periodically, consecutive data points are stored at this time interval, - # excluding data loss due to errors. Metrics with a higher granularity have - # a smaller sampling period. + # excluding data loss due to errors. Metrics with a higher granularity have a + # smaller sampling period. # Corresponds to the JSON property `samplePeriod` # @return [String] attr_accessor :sample_period @@ -3391,22 +2849,21 @@ module Google end end - # Bind API methods to metrics. Binding a method to a metric causes that - # metric's configured quota behaviors to apply to the method call. + # Bind API methods to metrics. Binding a method to a metric causes that metric's + # configured quota behaviors to apply to the method call. class MetricRule include Google::Apis::Core::Hashable # Metrics to update when the selected methods are called, and the associated - # cost applied to each metric. - # The key of the map is the metric name, and the values are the amount - # increased for the metric against which the quota limits are defined. - # The value must not be negative. + # cost applied to each metric. The key of the map is the metric name, and the + # values are the amount increased for the metric against which the quota limits + # are defined. The value must not be negative. # Corresponds to the JSON property `metricCosts` # @return [Hash] attr_accessor :metric_costs - # Selects the methods to which this rule applies. - # Refer to selector for syntax details. + # Selects the methods to which this rule applies. Refer to selector for syntax + # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -3424,66 +2881,33 @@ module Google # Declares an API Interface to be included in this interface. The including # interface must redeclare all the methods from the included interface, but - # documentation and options are inherited as follows: - # - If after comment and whitespace stripping, the documentation - # string of the redeclared method is empty, it will be inherited - # from the original method. - # - Each annotation belonging to the service config (http, - # visibility) which is not set in the redeclared method will be - # inherited. - # - If an http annotation is inherited, the path pattern will be - # modified as follows. Any version prefix will be replaced by the - # version of the including interface plus the root path if - # specified. - # Example of a simple mixin: - # package google.acl.v1; - # service AccessControl ` - # // Get the underlying ACL object. - # rpc GetAcl(GetAclRequest) returns (Acl) ` - # option (google.api.http).get = "/v1/`resource=**`:getAcl"; - # ` - # ` - # package google.storage.v2; - # service Storage ` - # // rpc GetAcl(GetAclRequest) returns (Acl); - # // Get a data record. - # rpc GetData(GetDataRequest) returns (Data) ` - # option (google.api.http).get = "/v2/`resource=**`"; - # ` - # ` - # Example of a mixin configuration: - # apis: - # - name: google.storage.v2.Storage - # mixins: - # - name: google.acl.v1.AccessControl - # The mixin construct implies that all methods in `AccessControl` are - # also declared with same name and request/response types in - # `Storage`. A documentation generator or annotation processor will - # see the effective `Storage.GetAcl` method after inherting - # documentation and annotations as follows: - # service Storage ` - # // Get the underlying ACL object. - # rpc GetAcl(GetAclRequest) returns (Acl) ` - # option (google.api.http).get = "/v2/`resource=**`:getAcl"; - # ` - # ... - # ` - # Note how the version in the path pattern changed from `v1` to `v2`. - # If the `root` field in the mixin is specified, it should be a - # relative path under which inherited HTTP paths are placed. Example: - # apis: - # - name: google.storage.v2.Storage - # mixins: - # - name: google.acl.v1.AccessControl - # root: acls - # This implies the following inherited HTTP annotation: - # service Storage ` - # // Get the underlying ACL object. - # rpc GetAcl(GetAclRequest) returns (Acl) ` - # option (google.api.http).get = "/v2/acls/`resource=**`:getAcl"; - # ` - # ... - # ` + # documentation and options are inherited as follows: - If after comment and + # whitespace stripping, the documentation string of the redeclared method is + # empty, it will be inherited from the original method. - Each annotation + # belonging to the service config (http, visibility) which is not set in the + # redeclared method will be inherited. - If an http annotation is inherited, the + # path pattern will be modified as follows. Any version prefix will be replaced + # by the version of the including interface plus the root path if specified. + # Example of a simple mixin: package google.acl.v1; service AccessControl ` // + # Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) ` + # option (google.api.http).get = "/v1/`resource=**`:getAcl"; ` ` package google. + # storage.v2; service Storage ` // rpc GetAcl(GetAclRequest) returns (Acl); // + # Get a data record. rpc GetData(GetDataRequest) returns (Data) ` option (google. + # api.http).get = "/v2/`resource=**`"; ` ` Example of a mixin configuration: + # apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1. + # AccessControl The mixin construct implies that all methods in `AccessControl` + # are also declared with same name and request/response types in `Storage`. A + # documentation generator or annotation processor will see the effective ` + # Storage.GetAcl` method after inherting documentation and annotations as + # follows: service Storage ` // Get the underlying ACL object. rpc GetAcl( + # GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=** + # `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1` + # to `v2`. If the `root` field in the mixin is specified, it should be a + # relative path under which inherited HTTP paths are placed. Example: apis: - + # name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl + # root: acls This implies the following inherited HTTP annotation: service + # Storage ` // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns ( + # Acl) ` option (google.api.http).get = "/v2/acls/`resource=**`:getAcl"; ` ... ` class Mixin include Google::Apis::Core::Hashable @@ -3492,8 +2916,7 @@ module Google # @return [String] attr_accessor :name - # If non-empty specifies a path under which inherited HTTP paths - # are rooted. + # If non-empty specifies a path under which inherited HTTP paths are rooted. # Corresponds to the JSON property `root` # @return [String] attr_accessor :root @@ -3509,51 +2932,42 @@ module Google end end - # An object that describes the schema of a MonitoredResource object using a - # type name and a set of labels. For example, the monitored resource - # descriptor for Google Compute Engine VM instances has a type of - # `"gce_instance"` and specifies the use of the labels `"instance_id"` and - # `"zone"` to identify particular VM instances. - # Different services can support different monitored resource types. - # The following are specific rules to service defined monitored resources for - # Monitoring and Logging: - # * The `type`, `display_name`, `description`, `labels` and `launch_stage` - # fields are all required. - # * The first label of the monitored resource descriptor must be - # `resource_container`. There are legacy monitored resource descritptors - # start with `project_id`. - # * It must include a `location` label. - # * Maximum of default 5 service defined monitored resource descriptors - # is allowed per service. - # * Maximum of default 10 labels per monitored resource is allowed. - # The default maximum limit can be overridden. Please follow - # https://cloud.google.com/monitoring/quotas + # An object that describes the schema of a MonitoredResource object using a type + # name and a set of labels. For example, the monitored resource descriptor for + # Google Compute Engine VM instances has a type of `"gce_instance"` and + # specifies the use of the labels `"instance_id"` and `"zone"` to identify + # particular VM instances. Different services can support different monitored + # resource types. The following are specific rules to service defined monitored + # resources for Monitoring and Logging: * The `type`, `display_name`, ` + # description`, `labels` and `launch_stage` fields are all required. * The first + # label of the monitored resource descriptor must be `resource_container`. There + # are legacy monitored resource descritptors start with `project_id`. * It must + # include a `location` label. * Maximum of default 5 service defined monitored + # resource descriptors is allowed per service. * Maximum of default 10 labels + # per monitored resource is allowed. The default maximum limit can be overridden. + # Please follow https://cloud.google.com/monitoring/quotas class MonitoredResourceDescriptor include Google::Apis::Core::Hashable - # Optional. A detailed description of the monitored resource type that might - # be used in documentation. + # Optional. A detailed description of the monitored resource type that might be + # used in documentation. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Optional. A concise name for the monitored resource type that might be - # displayed in user interfaces. It should be a Title Cased Noun Phrase, - # without any article or other determiners. For example, - # `"Google Cloud SQL Database"`. + # displayed in user interfaces. It should be a Title Cased Noun Phrase, without + # any article or other determiners. For example, `"Google Cloud SQL Database"`. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Required. A set of labels used to describe instances of this monitored - # resource type. - # The label key name must follow: - # * Only upper and lower-case letters, digits and underscores (_) are - # allowed. - # * Label name must start with a letter or digit. - # * The maximum length of a label name is 100 characters. - # For example, an individual Google Cloud SQL database is - # identified by values for the labels `database_id` and `location`. + # resource type. The label key name must follow: * Only upper and lower-case + # letters, digits and underscores (_) are allowed. * Label name must start with + # a letter or digit. * The maximum length of a label name is 100 characters. For + # example, an individual Google Cloud SQL database is identified by values for + # the labels `database_id` and `location`. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels @@ -3563,27 +2977,25 @@ module Google # @return [String] attr_accessor :launch_stage - # Optional. The resource name of the monitored resource descriptor: - # `"projects/`project_id`/monitoredResourceDescriptors/`type`"` where - # `type` is the value of the `type` field in this object and - # `project_id` is a project ID that provides API-specific context for - # accessing the type. APIs that do not use project information can use the - # resource name format `"monitoredResourceDescriptors/`type`"`. + # Optional. The resource name of the monitored resource descriptor: `"projects/` + # project_id`/monitoredResourceDescriptors/`type`"` where `type` is the value of + # the `type` field in this object and `project_id` is a project ID that provides + # API-specific context for accessing the type. APIs that do not use project + # information can use the resource name format `"monitoredResourceDescriptors/` + # type`"`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The monitored resource type. For example, the type - # `cloudsql_database` represents databases in Google Cloud SQL. - # All service defined monitored resource types must be prefixed with the - # service name, in the format of ``service name`/`relative resource name``. - # The relative resource name must follow: - # * Only upper and lower-case letters and digits are allowed. - # * It must start with upper case character and is recommended to use Upper - # Camel Case style. - # * The maximum number of characters allowed for the relative_resource_name - # is 100. - # Note there are legacy service monitored resources not following this rule. + # Required. The monitored resource type. For example, the type ` + # cloudsql_database` represents databases in Google Cloud SQL. All service + # defined monitored resource types must be prefixed with the service name, in + # the format of ``service name`/`relative resource name``. The relative resource + # name must follow: * Only upper and lower-case letters and digits are allowed. * + # It must start with upper case character and is recommended to use Upper Camel + # Case style. * The maximum number of characters allowed for the + # relative_resource_name is 100. Note there are legacy service monitored + # resources not following this rule. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -3603,75 +3015,47 @@ module Google end end - # Monitoring configuration of the service. - # The example below shows how to configure monitored resources and metrics - # for monitoring. In the example, a monitored resource and two metrics are - # defined. The `library.googleapis.com/book/returned_count` metric is sent - # to both producer and consumer projects, whereas the - # `library.googleapis.com/book/num_overdue` metric is only sent to the - # consumer project. - # monitored_resources: - # - type: library.googleapis.com/Branch - # display_name: "Library Branch" - # description: "A branch of a library." - # launch_stage: GA - # labels: - # - key: resource_container - # description: "The Cloud container (ie. project id) for the Branch." - # - key: location - # description: "The location of the library branch." - # - key: branch_id - # description: "The id of the branch." - # metrics: - # - name: library.googleapis.com/book/returned_count - # display_name: "Books Returned" - # description: "The count of books that have been returned." - # launch_stage: GA - # metric_kind: DELTA - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # - name: library.googleapis.com/book/num_overdue - # display_name: "Books Overdue" - # description: "The current number of overdue books." - # launch_stage: GA - # metric_kind: GAUGE - # value_type: INT64 - # unit: "1" - # labels: - # - key: customer_id - # description: "The id of the customer." - # monitoring: - # producer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # consumer_destinations: - # - monitored_resource: library.googleapis.com/Branch - # metrics: - # - library.googleapis.com/book/returned_count - # - library.googleapis.com/book/num_overdue + # Monitoring configuration of the service. The example below shows how to + # configure monitored resources and metrics for monitoring. In the example, a + # monitored resource and two metrics are defined. The `library.googleapis.com/ + # book/returned_count` metric is sent to both producer and consumer projects, + # whereas the `library.googleapis.com/book/num_overdue` metric is only sent to + # the consumer project. monitored_resources: - type: library.googleapis.com/ + # Branch display_name: "Library Branch" description: "A branch of a library." + # launch_stage: GA labels: - key: resource_container description: "The Cloud + # container (ie. project id) for the Branch." - key: location description: "The + # location of the library branch." - key: branch_id description: "The id of the + # branch." metrics: - name: library.googleapis.com/book/returned_count + # display_name: "Books Returned" description: "The count of books that have been + # returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" + # labels: - key: customer_id description: "The id of the customer." - name: + # library.googleapis.com/book/num_overdue display_name: "Books Overdue" + # description: "The current number of overdue books." launch_stage: GA + # metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id + # description: "The id of the customer." monitoring: producer_destinations: - + # monitored_resource: library.googleapis.com/Branch metrics: - library. + # googleapis.com/book/returned_count consumer_destinations: - monitored_resource: + # library.googleapis.com/Branch metrics: - library.googleapis.com/book/ + # returned_count - library.googleapis.com/book/num_overdue class Monitoring include Google::Apis::Core::Hashable - # Monitoring configurations for sending metrics to the consumer project. - # There can be multiple consumer destinations. A monitored resource type may - # appear in multiple monitoring destinations if different aggregations are - # needed for different sets of metrics associated with that monitored - # resource type. A monitored resource and metric pair may only be used once - # in the Monitoring configuration. + # Monitoring configurations for sending metrics to the consumer project. There + # can be multiple consumer destinations. A monitored resource type may appear in + # multiple monitoring destinations if different aggregations are needed for + # different sets of metrics associated with that monitored resource type. A + # monitored resource and metric pair may only be used once in the Monitoring + # configuration. # Corresponds to the JSON property `consumerDestinations` # @return [Array] attr_accessor :consumer_destinations - # Monitoring configurations for sending metrics to the producer project. - # There can be multiple producer destinations. A monitored resource type may - # appear in multiple monitoring destinations if different aggregations are - # needed for different sets of metrics associated with that monitored - # resource type. A monitored resource and metric pair may only be used once - # in the Monitoring configuration. + # Monitoring configurations for sending metrics to the producer project. There + # can be multiple producer destinations. A monitored resource type may appear in + # multiple monitoring destinations if different aggregations are needed for + # different sets of metrics associated with that monitored resource type. A + # monitored resource and metric pair may only be used once in the Monitoring + # configuration. # Corresponds to the JSON property `producerDestinations` # @return [Array] attr_accessor :producer_destinations @@ -3687,19 +3071,19 @@ module Google end end - # Configuration of a specific monitoring destination (the producer project - # or the consumer project). + # Configuration of a specific monitoring destination (the producer project or + # the consumer project). class MonitoringDestination include Google::Apis::Core::Hashable - # Types of the metrics to report to this monitoring destination. - # Each type must be defined in Service.metrics section. + # Types of the metrics to report to this monitoring destination. Each type must + # be defined in Service.metrics section. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics - # The monitored resource type. The type must be defined in - # Service.monitored_resources section. + # The monitored resource type. The type must be defined in Service. + # monitored_resources section. # Corresponds to the JSON property `monitoredResource` # @return [String] attr_accessor :monitored_resource @@ -3716,27 +3100,25 @@ module Google end # OAuth scopes are a way to define data and permissions on data. For example, - # there are scopes defined for "Read-only access to Google Calendar" and - # "Access to Cloud Platform". Users can consent to a scope for an application, - # giving it permission to access that data on their behalf. - # OAuth scope specifications should be fairly coarse grained; a user will need - # to see and understand the text description of what your scope means. - # In most cases: use one or at most two OAuth scopes for an entire family of - # products. If your product has multiple APIs, you should probably be sharing - # the OAuth scope across all of those APIs. - # When you need finer grained OAuth consent screens: talk with your product - # management about how developers will use them in practice. - # Please note that even though each of the canonical scopes is enough for a - # request to be accepted and passed to the backend, a request can still fail - # due to the backend requiring additional scopes or permissions. + # there are scopes defined for "Read-only access to Google Calendar" and "Access + # to Cloud Platform". Users can consent to a scope for an application, giving it + # permission to access that data on their behalf. OAuth scope specifications + # should be fairly coarse grained; a user will need to see and understand the + # text description of what your scope means. In most cases: use one or at most + # two OAuth scopes for an entire family of products. If your product has + # multiple APIs, you should probably be sharing the OAuth scope across all of + # those APIs. When you need finer grained OAuth consent screens: talk with your + # product management about how developers will use them in practice. Please note + # that even though each of the canonical scopes is enough for a request to be + # accepted and passed to the backend, a request can still fail due to the + # backend requiring additional scopes or permissions. class OAuthRequirements include Google::Apis::Core::Hashable - # The list of publicly documented OAuth scopes that are allowed access. An - # OAuth token containing any of these scopes will be accepted. - # Example: - # canonical_scopes: https://www.googleapis.com/auth/calendar, - # https://www.googleapis.com/auth/calendar.read + # The list of publicly documented OAuth scopes that are allowed access. An OAuth + # token containing any of these scopes will be accepted. Example: + # canonical_scopes: https://www.googleapis.com/auth/calendar, https://www. + # googleapis.com/auth/calendar.read # Corresponds to the JSON property `canonicalScopes` # @return [String] attr_accessor :canonical_scopes @@ -3756,47 +3138,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::ServiceusageV1beta1::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 @@ -3819,8 +3199,7 @@ module Google class OperationMetadata include Google::Apis::Core::Hashable - # The full name of the resources that this operation is directly - # associated with. + # The full name of the resources that this operation is directly associated with. # Corresponds to the JSON property `resourceNames` # @return [Array] attr_accessor :resource_names @@ -3841,17 +3220,17 @@ module Google include Google::Apis::Core::Hashable # The option's name. For protobuf built-in options (options defined in - # descriptor.proto), this is the short name. For example, `"map_entry"`. - # For custom options, it should be the fully-qualified name. For example, - # `"google.api.http"`. + # descriptor.proto), this is the short name. For example, `"map_entry"`. For + # custom options, it should be the fully-qualified name. For example, `"google. + # api.http"`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The option's value packed in an Any message. If the value is a primitive, - # the corresponding wrapper type defined in google/protobuf/wrappers.proto - # should be used. If the value is an enum, it should be stored as an int32 - # value using the google.protobuf.Int32Value type. + # The option's value packed in an Any message. If the value is a primitive, the + # corresponding wrapper type defined in google/protobuf/wrappers.proto should be + # used. If the value is an enum, it should be stored as an int32 value using the + # google.protobuf.Int32Value type. # Corresponds to the JSON property `value` # @return [Hash] attr_accessor :value @@ -3871,9 +3250,9 @@ module Google class OverrideInlineSource include Google::Apis::Core::Hashable - # The overrides to create. - # Each override must have a value for 'metric' and 'unit', to specify - # which metric and which limit the override should be applied to. + # The overrides to create. Each override must have a value for 'metric' and ' + # unit', to specify which metric and which limit the override should be applied + # to. # Corresponds to the JSON property `overrides` # @return [Array] attr_accessor :overrides @@ -3893,32 +3272,25 @@ module Google class Page include Google::Apis::Core::Hashable - # The Markdown content of the page. You can use (== include `path` - # ==) to include content from a Markdown file. + # The Markdown content of the page. You can use (== include `path` ==) to + # include content from a Markdown file. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content - # The name of the page. It will be used as an identity of the page to - # generate URI of the page, text of the link to this page in navigation, - # etc. The full page name (start from the root page name to this page - # concatenated with `.`) can be used as reference to the page in your - # documentation. For example: - # 
pages:
-        # - name: Tutorial
-        # content: (== include tutorial.md ==)
-        # subpages:
-        # - name: Java
-        # content: (== include tutorial_java.md ==)
-        #
- # You can reference `Java` page using Markdown reference link syntax: - # `Java`. + # The name of the page. It will be used as an identity of the page to generate + # URI of the page, text of the link to this page in navigation, etc. The full + # page name (start from the root page name to this page concatenated with `.`) + # can be used as reference to the page in your documentation. For example: pages: + # - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java + # content: (== include tutorial_java.md ==) You can reference `Java` page using + # Markdown reference link syntax: `Java`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Subpages of this page. The order of subpages specified here will be - # honored in the generated docset. + # Subpages of this page. The order of subpages specified here will be honored in + # the generated docset. # Corresponds to the JSON property `subpages` # @return [Array] attr_accessor :subpages @@ -3935,46 +3307,25 @@ module Google end end - # Quota configuration helps to achieve fairness and budgeting in service - # usage. - # The metric based quota configuration works this way: - # - The service configuration defines a set of metrics. - # - For API calls, the quota.metric_rules maps methods to metrics with - # corresponding costs. - # - The quota.limits defines limits on the metrics, which will be used for - # quota checks at runtime. - # An example quota configuration in yaml format: - # quota: - # limits: - # - name: apiWriteQpsPerProject - # metric: library.googleapis.com/write_calls - # unit: "1/min/`project`" # rate limit for consumer projects - # values: - # STANDARD: 10000 - # # The metric rules bind all methods to the read_calls metric, - # # except for the UpdateBook and DeleteBook methods. These two methods - # # are mapped to the write_calls metric, with the UpdateBook method - # # consuming at twice rate as the DeleteBook method. - # metric_rules: - # - selector: "*" - # metric_costs: - # library.googleapis.com/read_calls: 1 - # - selector: google.example.library.v1.LibraryService.UpdateBook - # metric_costs: - # library.googleapis.com/write_calls: 2 - # - selector: google.example.library.v1.LibraryService.DeleteBook - # metric_costs: - # library.googleapis.com/write_calls: 1 - # Corresponding Metric definition: - # metrics: - # - name: library.googleapis.com/read_calls - # display_name: Read requests - # metric_kind: DELTA - # value_type: INT64 - # - name: library.googleapis.com/write_calls - # display_name: Write requests - # metric_kind: DELTA - # value_type: INT64 + # Quota configuration helps to achieve fairness and budgeting in service usage. + # The metric based quota configuration works this way: - The service + # configuration defines a set of metrics. - For API calls, the quota. + # metric_rules maps methods to metrics with corresponding costs. - The quota. + # limits defines limits on the metrics, which will be used for quota checks at + # runtime. An example quota configuration in yaml format: quota: limits: - name: + # apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/` + # project`" # rate limit for consumer projects values: STANDARD: 10000 # The + # metric rules bind all methods to the read_calls metric, # except for the + # UpdateBook and DeleteBook methods. These two methods # are mapped to the + # write_calls metric, with the UpdateBook method # consuming at twice rate as + # the DeleteBook method. metric_rules: - selector: "*" metric_costs: library. + # googleapis.com/read_calls: 1 - selector: google.example.library.v1. + # LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - + # selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: + # library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: + # - name: library.googleapis.com/read_calls display_name: Read requests + # metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/ + # write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 class Quota include Google::Apis::Core::Hashable @@ -3983,8 +3334,8 @@ module Google # @return [Array] attr_accessor :limits - # List of `MetricRule` definitions, each one mapping a selected method to one - # or more metrics. + # List of `MetricRule` definitions, each one mapping a selected method to one or + # more metrics. # Corresponds to the JSON property `metricRules` # @return [Array] attr_accessor :metric_rules @@ -4020,20 +3371,19 @@ module Google # @return [Fixnum] attr_accessor :default_limit - # The dimensions of this quota bucket. - # If this map is empty, this is the global bucket, which is the default quota - # value applied to all requests that do not have a more specific override. - # If this map is nonempty, the default limit, effective limit, and quota - # overrides apply only to requests that have the dimensions given in the map. - # For example, if the map has key "region" and value "us-east-1", then the - # specified effective limit is only effective in that region, and the - # specified overrides apply only in that region. + # The dimensions of this quota bucket. If this map is empty, this is the global + # bucket, which is the default quota value applied to all requests that do not + # have a more specific override. If this map is nonempty, the default limit, + # effective limit, and quota overrides apply only to requests that have the + # dimensions given in the map. For example, if the map has key "region" and + # value "us-east-1", then the specified effective limit is only effective in + # that region, and the specified overrides apply only in that region. # Corresponds to the JSON property `dimensions` # @return [Hash] attr_accessor :dimensions - # The effective limit of this quota bucket. Equal to default_limit if there - # are no overrides. + # The effective limit of this quota bucket. Equal to default_limit if there are + # no overrides. # Corresponds to the JSON property `effectiveLimit` # @return [Fixnum] attr_accessor :effective_limit @@ -4059,95 +3409,89 @@ module Google end # `QuotaLimit` defines a specific limit that applies over a specified duration - # for a limit type. There can be at most one limit for a duration and limit - # type combination defined within a `QuotaGroup`. + # for a limit type. There can be at most one limit for a duration and limit type + # combination defined within a `QuotaGroup`. class QuotaLimit include Google::Apis::Core::Hashable - # Default number of tokens that can be consumed during the specified - # duration. This is the number of tokens assigned when a client - # application developer activates the service for his/her project. - # Specifying a value of 0 will block all requests. This can be used if you - # are provisioning quota to selected consumers and blocking others. - # Similarly, a value of -1 will indicate an unlimited quota. No other - # negative values are allowed. - # Used by group-based quotas only. + # Default number of tokens that can be consumed during the specified duration. + # This is the number of tokens assigned when a client application developer + # activates the service for his/her project. Specifying a value of 0 will block + # all requests. This can be used if you are provisioning quota to selected + # consumers and blocking others. Similarly, a value of -1 will indicate an + # unlimited quota. No other negative values are allowed. Used by group-based + # quotas only. # Corresponds to the JSON property `defaultLimit` # @return [Fixnum] attr_accessor :default_limit - # Optional. User-visible, extended description for this quota limit. - # Should be used only when more context is needed to understand this limit - # than provided by the limit's display name (see: `display_name`). + # Optional. User-visible, extended description for this quota limit. Should be + # used only when more context is needed to understand this limit than provided + # by the limit's display name (see: `display_name`). # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # User-visible display name for this limit. - # Optional. If not set, the UI will provide a default display name based on - # the quota configuration. This field can be used to override the default - # display name generated from the configuration. + # User-visible display name for this limit. Optional. If not set, the UI will + # provide a default display name based on the quota configuration. This field + # can be used to override the default display name generated from the + # configuration. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Duration of this limit in textual notation. Must be "100s" or "1d". - # Used by group-based quotas only. + # Duration of this limit in textual notation. Must be "100s" or "1d". Used by + # group-based quotas only. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration - # Free tier value displayed in the Developers Console for this limit. - # The free tier is the number of tokens that will be subtracted from the - # billed amount when billing is enabled. - # This field can only be set on a limit with duration "1d", in a billable - # group; it is invalid on any other limit. If this field is not set, it - # defaults to 0, indicating that there is no free tier for this service. - # Used by group-based quotas only. + # Free tier value displayed in the Developers Console for this limit. The free + # tier is the number of tokens that will be subtracted from the billed amount + # when billing is enabled. This field can only be set on a limit with duration " + # 1d", in a billable group; it is invalid on any other limit. If this field is + # not set, it defaults to 0, indicating that there is no free tier for this + # service. Used by group-based quotas only. # Corresponds to the JSON property `freeTier` # @return [Fixnum] attr_accessor :free_tier - # Maximum number of tokens that can be consumed during the specified - # duration. Client application developers can override the default limit up - # to this maximum. If specified, this value cannot be set to a value less - # than the default limit. If not specified, it is set to the default limit. - # To allow clients to apply overrides with no upper bound, set this to -1, - # indicating unlimited maximum quota. - # Used by group-based quotas only. + # Maximum number of tokens that can be consumed during the specified duration. + # Client application developers can override the default limit up to this + # maximum. If specified, this value cannot be set to a value less than the + # default limit. If not specified, it is set to the default limit. To allow + # clients to apply overrides with no upper bound, set this to -1, indicating + # unlimited maximum quota. Used by group-based quotas only. # Corresponds to the JSON property `maxLimit` # @return [Fixnum] attr_accessor :max_limit - # The name of the metric this quota limit applies to. The quota limits with - # the same metric will be checked together during runtime. The metric must be + # The name of the metric this quota limit applies to. The quota limits with the + # same metric will be checked together during runtime. The metric must be # defined within the service config. # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric - # Name of the quota limit. - # The name must be provided, and it must be unique within the service. The - # name can only include alphanumeric characters as well as '-'. - # The maximum length of the limit name is 64 characters. + # Name of the quota limit. The name must be provided, and it must be unique + # within the service. The name can only include alphanumeric characters as well + # as '-'. The maximum length of the limit name is 64 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Specify the unit of the quota limit. It uses the same syntax as - # Metric.unit. The supported unit kinds are determined by the quota - # backend system. - # Here are some examples: - # * "1/min/`project`" for quota per minute per project. - # Note: the order of unit components is insignificant. - # The "1" at the beginning is required to follow the metric unit syntax. + # Specify the unit of the quota limit. It uses the same syntax as Metric.unit. + # The supported unit kinds are determined by the quota backend system. Here are + # some examples: * "1/min/`project`" for quota per minute per project. Note: the + # order of unit components is insignificant. The "1" at the beginning is + # required to follow the metric unit syntax. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit # Tiered limit values. You must specify this as a key:value pair, with an - # integer value that is the maximum number of requests allowed for the - # specified unit. Currently only STANDARD is supported. + # integer value that is the maximum number of requests allowed for the specified + # unit. Currently only STANDARD is supported. # Corresponds to the JSON property `values` # @return [Hash] attr_accessor :values @@ -4175,66 +3519,58 @@ module Google class QuotaOverride include Google::Apis::Core::Hashable - # The resource name of the ancestor that requested the override. For example: - # "organizations/12345" or "folders/67890". - # Used by admin overrides only. + # The resource name of the ancestor that requested the override. For example: " + # organizations/12345" or "folders/67890". Used by admin overrides only. # Corresponds to the JSON property `adminOverrideAncestor` # @return [String] attr_accessor :admin_override_ancestor # If this map is nonempty, then this override applies only to specific values - # for dimensions defined in the limit unit. - # For example, an override on a limit with the unit 1/`project`/`region` - # could contain an entry with the key "region" and the value "us-east-1"; - # the override is only applied to quota consumed in that region. - # This map has the following restrictions: - # * Keys that are not defined in the limit's unit are not valid keys. - # Any string appearing in `brackets` in the unit (besides `project` or - # `user`) is a defined key. - # * "project" is not a valid key; the project is already specified in - # the parent resource name. - # * "user" is not a valid key; the API does not support quota overrides - # that apply only to a specific user. - # * If "region" appears as a key, its value must be a valid Cloud region. - # * If "zone" appears as a key, its value must be a valid Cloud zone. - # * If any valid key other than "region" or "zone" appears in the map, then - # all valid keys other than "region" or "zone" must also appear in the - # map. + # for dimensions defined in the limit unit. For example, an override on a limit + # with the unit 1/`project`/`region` could contain an entry with the key "region" + # and the value "us-east-1"; the override is only applied to quota consumed in + # that region. This map has the following restrictions: * Keys that are not + # defined in the limit's unit are not valid keys. Any string appearing in ` + # brackets` in the unit (besides `project` or `user`) is a defined key. * " + # project" is not a valid key; the project is already specified in the parent + # resource name. * "user" is not a valid key; the API does not support quota + # overrides that apply only to a specific user. * If "region" appears as a key, + # its value must be a valid Cloud region. * If "zone" appears as a key, its + # value must be a valid Cloud zone. * If any valid key other than "region" or " + # zone" appears in the map, then all valid keys other than "region" or "zone" + # must also appear in the map. # Corresponds to the JSON property `dimensions` # @return [Hash] attr_accessor :dimensions - # The name of the metric to which this override applies. - # An example name would be: - # `compute.googleapis.com/cpus` + # The name of the metric to which this override applies. An example name would + # be: `compute.googleapis.com/cpus` # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric - # The resource name of the override. - # This name is generated by the server when the override is created. - # Example names would be: - # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. - # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` - # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. - # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` - # The resource name is intended to be opaque and should not be parsed for - # its component strings, since its representation could change in the future. + # The resource name of the override. This name is generated by the server when + # the override is created. Example names would be: `projects/123/services/ + # compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/ + # limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` `projects/123/services/ + # compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/ + # limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` The resource name is + # intended to be opaque and should not be parsed for its component strings, + # since its representation could change in the future. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The overriding quota limit value. - # Can be any nonnegative integer, or -1 (unlimited quota). + # The overriding quota limit value. Can be any nonnegative integer, or -1 ( + # unlimited quota). # Corresponds to the JSON property `overrideValue` # @return [Fixnum] attr_accessor :override_value - # The limit unit of the limit to which this override applies. - # An example unit would be: - # `1/`project`/`region`` - # Note that ``project`` and ``region`` are not placeholders in this example; - # the literal characters ``` and ``` occur in the string. + # The limit unit of the limit to which this override applies. An example unit + # would be: `1/`project`/`region`` Note that ``project`` and ``region`` are not + # placeholders in this example; the literal characters ``` and ``` occur in the + # string. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit @@ -4263,16 +3599,13 @@ module Google # @return [Google::Apis::ServiceusageV1beta1::ServiceConfig] attr_accessor :config - # The resource name of the consumer and service. - # A valid name would be: - # - projects/123/services/serviceusage.googleapis.com + # The resource name of the consumer and service. A valid name would be: - + # projects/123/services/serviceusage.googleapis.com # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The resource name of the consumer. - # A valid name would be: - # - projects/123 + # The resource name of the consumer. A valid name would be: - projects/123 # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -4305,129 +3638,76 @@ module Google # @return [Array] attr_accessor :apis - # `Authentication` defines the authentication configuration for an API. - # Example for an API targeted for external use: - # name: calendar.googleapis.com - # authentication: - # providers: - # - id: google_calendar_auth - # jwks_uri: https://www.googleapis.com/oauth2/v1/certs - # issuer: https://securetoken.google.com - # rules: - # - selector: "*" - # requirements: - # provider_id: google_calendar_auth + # `Authentication` defines the authentication configuration for an API. Example + # for an API targeted for external use: name: calendar.googleapis.com + # authentication: providers: - id: google_calendar_auth jwks_uri: https://www. + # googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - + # selector: "*" requirements: provider_id: google_calendar_auth # Corresponds to the JSON property `authentication` # @return [Google::Apis::ServiceusageV1beta1::Authentication] attr_accessor :authentication - # `Documentation` provides the information for describing a service. - # Example: - # 
documentation:
-        # summary: >
-        # The Google Calendar API gives access
-        # to most calendar features.
-        # pages:
-        # - name: Overview
-        # content: (== include google/foo/overview.md ==)
-        # - name: Tutorial
-        # content: (== include google/foo/tutorial.md ==)
-        # subpages;
-        # - name: Java
-        # content: (== include google/foo/tutorial_java.md ==)
-        # rules:
-        # - selector: google.calendar.Calendar.Get
-        # description: >
-        # ...
-        # - selector: google.calendar.Calendar.Put
-        # description: >
-        # ...
-        #
- # Documentation is provided in markdown syntax. In addition to - # standard markdown features, definition lists, tables and fenced - # code blocks are supported. Section headers can be provided and are - # interpreted relative to the section nesting of the context where - # a documentation fragment is embedded. - # Documentation from the IDL is merged with documentation defined - # via the config at normalization time, where documentation provided - # by config rules overrides IDL provided. - # A number of constructs specific to the API platform are supported - # in documentation text. - # In order to reference a proto element, the following - # notation can be used: - # 
[fully.qualified.proto.name][]
- # To override the display text used for the link, this can be used: - # 
[display text][fully.qualified.proto.name]
- # Text can be excluded from doc using the following notation: - # 
(-- internal comment --)
- # A few directives are available in documentation. Note that - # directives must appear on a single line to be properly - # identified. The `include` directive includes a markdown file from - # an external source: - # 
(== include path/to/file ==)
- # The `resource_for` directive marks a message to be the resource of - # a collection in REST view. If it is not specified, tools attempt - # to infer the resource from the operations in a collection: - # 
(== resource_for v1.shelves.books ==)
- # The directive `suppress_warning` does not directly affect documentation - # and is documented together with service config validation. + # `Documentation` provides the information for describing a service. Example: + # documentation: summary: > The Google Calendar API gives access to most + # calendar features. pages: - name: Overview content: (== include google/foo/ + # overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md == + # ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==) + # rules: - selector: google.calendar.Calendar.Get description: > ... - selector: + # google.calendar.Calendar.Put description: > ... Documentation is provided in + # markdown syntax. In addition to standard markdown features, definition lists, + # tables and fenced code blocks are supported. Section headers can be provided + # and are interpreted relative to the section nesting of the context where a + # documentation fragment is embedded. Documentation from the IDL is merged with + # documentation defined via the config at normalization time, where + # documentation provided by config rules overrides IDL provided. A number of + # constructs specific to the API platform are supported in documentation text. + # In order to reference a proto element, the following notation can be used: [ + # fully.qualified.proto.name][] To override the display text used for the link, + # this can be used: [display text][fully.qualified.proto.name] Text can be + # excluded from doc using the following notation: (-- internal comment --) A few + # directives are available in documentation. Note that directives must appear on + # a single line to be properly identified. The `include` directive includes a + # markdown file from an external source: (== include path/to/file ==) The ` + # resource_for` directive marks a message to be the resource of a collection in + # REST view. If it is not specified, tools attempt to infer the resource from + # the operations in a collection: (== resource_for v1.shelves.books ==) The + # directive `suppress_warning` does not directly affect documentation and is + # documented together with service config validation. # Corresponds to the JSON property `documentation` # @return [Google::Apis::ServiceusageV1beta1::Documentation] attr_accessor :documentation - # Configuration for network endpoints. Contains only the names and aliases - # of the endpoints. + # Configuration for network endpoints. Contains only the names and aliases of + # the endpoints. # Corresponds to the JSON property `endpoints` # @return [Array] attr_accessor :endpoints - # The DNS address at which this service is available. - # An example DNS address would be: - # `calendar.googleapis.com`. + # The DNS address at which this service is available. An example DNS address + # would be: `calendar.googleapis.com`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Quota configuration helps to achieve fairness and budgeting in service - # usage. - # The metric based quota configuration works this way: - # - The service configuration defines a set of metrics. - # - For API calls, the quota.metric_rules maps methods to metrics with - # corresponding costs. - # - The quota.limits defines limits on the metrics, which will be used for - # quota checks at runtime. - # An example quota configuration in yaml format: - # quota: - # limits: - # - name: apiWriteQpsPerProject - # metric: library.googleapis.com/write_calls - # unit: "1/min/`project`" # rate limit for consumer projects - # values: - # STANDARD: 10000 - # # The metric rules bind all methods to the read_calls metric, - # # except for the UpdateBook and DeleteBook methods. These two methods - # # are mapped to the write_calls metric, with the UpdateBook method - # # consuming at twice rate as the DeleteBook method. - # metric_rules: - # - selector: "*" - # metric_costs: - # library.googleapis.com/read_calls: 1 - # - selector: google.example.library.v1.LibraryService.UpdateBook - # metric_costs: - # library.googleapis.com/write_calls: 2 - # - selector: google.example.library.v1.LibraryService.DeleteBook - # metric_costs: - # library.googleapis.com/write_calls: 1 - # Corresponding Metric definition: - # metrics: - # - name: library.googleapis.com/read_calls - # display_name: Read requests - # metric_kind: DELTA - # value_type: INT64 - # - name: library.googleapis.com/write_calls - # display_name: Write requests - # metric_kind: DELTA - # value_type: INT64 + # Quota configuration helps to achieve fairness and budgeting in service usage. + # The metric based quota configuration works this way: - The service + # configuration defines a set of metrics. - For API calls, the quota. + # metric_rules maps methods to metrics with corresponding costs. - The quota. + # limits defines limits on the metrics, which will be used for quota checks at + # runtime. An example quota configuration in yaml format: quota: limits: - name: + # apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/` + # project`" # rate limit for consumer projects values: STANDARD: 10000 # The + # metric rules bind all methods to the read_calls metric, # except for the + # UpdateBook and DeleteBook methods. These two methods # are mapped to the + # write_calls metric, with the UpdateBook method # consuming at twice rate as + # the DeleteBook method. metric_rules: - selector: "*" metric_costs: library. + # googleapis.com/read_calls: 1 - selector: google.example.library.v1. + # LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - + # selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: + # library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: + # - name: library.googleapis.com/read_calls display_name: Read requests + # metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/ + # write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 # Corresponds to the JSON property `quota` # @return [Google::Apis::ServiceusageV1beta1::Quota] attr_accessor :quota @@ -4464,15 +3744,14 @@ module Google class ServiceIdentity include Google::Apis::Core::Hashable - # The email address of the service account that a service producer would use - # to access consumer resources. + # The email address of the service account that a service producer would use to + # access consumer resources. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email - # The unique and stable id of the service account. - # https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts# - # ServiceAccount + # The unique and stable id of the service account. https://cloud.google.com/iam/ + # reference/rest/v1/projects.serviceAccounts#ServiceAccount # Corresponds to the JSON property `uniqueId` # @return [String] attr_accessor :unique_id @@ -4488,13 +3767,13 @@ module Google end end - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. class SourceContext include Google::Apis::Core::Hashable # The path-qualified name of the .proto file that contained the associated - # protobuf element. For example: `"google/protobuf/source_context.proto"`. + # protobuf element. For example: `"google/protobuf/source_context.proto"`. # Corresponds to the JSON property `fileName` # @return [String] attr_accessor :file_name @@ -4528,12 +3807,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 @@ -4542,15 +3821,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 @@ -4573,8 +3852,7 @@ module Google class SystemParameter include Google::Apis::Core::Hashable - # Define the HTTP header name to use for the parameter. It is case - # insensitive. + # Define the HTTP header name to use for the parameter. It is case insensitive. # Corresponds to the JSON property `httpHeader` # @return [String] attr_accessor :http_header @@ -4602,23 +3880,20 @@ module Google end end - # Define a system parameter rule mapping system parameter definitions to - # methods. + # Define a system parameter rule mapping system parameter definitions to methods. class SystemParameterRule include Google::Apis::Core::Hashable - # Define parameters. Multiple names may be defined for a parameter. - # For a given method call, only one of them should be used. If multiple - # names are used the behavior is implementation-dependent. - # If none of the specified names are present the behavior is - # parameter-dependent. + # Define parameters. Multiple names may be defined for a parameter. For a given + # method call, only one of them should be used. If multiple names are used the + # behavior is implementation-dependent. If none of the specified names are + # present the behavior is parameter-dependent. # Corresponds to the JSON property `parameters` # @return [Array] attr_accessor :parameters # Selects the methods to which this rule applies. Use '*' to indicate all - # methods in all APIs. - # Refer to selector for syntax details. + # methods in all APIs. Refer to selector for syntax details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector @@ -4634,36 +3909,23 @@ module Google end end - # ### System parameter configuration - # A system parameter is a special kind of parameter defined by the API - # system, not by an individual API. It is typically mapped to an HTTP header - # and/or a URL query parameter. This configuration specifies which methods - # change the names of the system parameters. + # ### System parameter configuration A system parameter is a special kind of + # parameter defined by the API system, not by an individual API. It is typically + # mapped to an HTTP header and/or a URL query parameter. This configuration + # specifies which methods change the names of the system parameters. class SystemParameters include Google::Apis::Core::Hashable - # Define system parameters. - # The parameters defined here will override the default parameters - # implemented by the system. If this field is missing from the service - # config, default system parameters will be used. Default system parameters - # and names is implementation-dependent. - # Example: define api key for all methods - # system_parameters - # rules: - # - selector: "*" - # parameters: - # - name: api_key - # url_query_parameter: api_key - # Example: define 2 api key names for a specific method. - # system_parameters - # rules: - # - selector: "/ListShelves" - # parameters: - # - name: api_key - # http_header: Api-Key1 - # - name: api_key - # http_header: Api-Key2 - # **NOTE:** All service configuration rules follow "last one wins" order. + # Define system parameters. The parameters defined here will override the + # default parameters implemented by the system. If this field is missing from + # the service config, default system parameters will be used. Default system + # parameters and names is implementation-dependent. Example: define api key for + # all methods system_parameters rules: - selector: "*" parameters: - name: + # api_key url_query_parameter: api_key Example: define 2 api key names for a + # specific method. system_parameters rules: - selector: "/ListShelves" + # parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: + # Api-Key2 **NOTE:** All service configuration rules follow "last one wins" + # order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -4702,8 +3964,8 @@ module Google # @return [Array] attr_accessor :options - # `SourceContext` represents information about the source of a - # protobuf element, like the file in which it is defined. + # `SourceContext` represents information about the source of a protobuf element, + # like the file in which it is defined. # Corresponds to the JSON property `sourceContext` # @return [Google::Apis::ServiceusageV1beta1::SourceContext] attr_accessor :source_context @@ -4733,37 +3995,33 @@ module Google include Google::Apis::Core::Hashable # The full resource name of a channel used for sending notifications to the - # service producer. - # Google Service Management currently only supports - # [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification - # channel. To use Google Cloud Pub/Sub as the channel, this must be the name - # of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format - # documented in https://cloud.google.com/pubsub/docs/overview. + # service producer. Google Service Management currently only supports [Google + # Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To + # use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/ + # Sub topic that uses the Cloud Pub/Sub topic name format documented in https:// + # cloud.google.com/pubsub/docs/overview. # Corresponds to the JSON property `producerNotificationChannel` # @return [String] attr_accessor :producer_notification_channel # Requirements that must be satisfied before a consumer project can use the - # service. Each requirement is of the form /; - # for example 'serviceusage.googleapis.com/billing-enabled'. + # service. Each requirement is of the form /; for example 'serviceusage. + # googleapis.com/billing-enabled'. # Corresponds to the JSON property `requirements` # @return [Array] attr_accessor :requirements - # A list of usage rules that apply to individual API methods. - # **NOTE:** All service configuration rules follow "last one wins" order. + # A list of usage rules that apply to individual API methods. **NOTE:** All + # service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules - # The per-product per-project service identity for a service. - # Use this field to configure per-product per-project service identity. - # Example of a service identity configuration. - # usage: - # service_identity: - # - service_account_parent: "projects/123456789" - # display_name: "Cloud XXX Service Agent" - # description: "Used as the identity of Cloud XXX to access resources" + # The per-product per-project service identity for a service. Use this field to + # configure per-product per-project service identity. Example of a service + # identity configuration. usage: service_identity: - service_account_parent: " + # projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used + # as the identity of Cloud XXX to access resources" # Corresponds to the JSON property `serviceIdentity` # @return [Google::Apis::ServiceusageV1beta1::GoogleApiServiceIdentity] attr_accessor :service_identity @@ -4781,45 +4039,36 @@ module Google end end - # Usage configuration rules for the service. - # NOTE: Under development. - # Use this rule to configure unregistered calls for the service. Unregistered - # calls are calls that do not contain consumer project identity. - # (Example: calls that do not contain an API key). - # By default, API methods do not allow unregistered calls, and each method call - # must be identified by a consumer project identity. Use this rule to - # allow/disallow unregistered calls. - # Example of an API that wants to allow unregistered calls for entire service. - # usage: - # rules: - # - selector: "*" - # allow_unregistered_calls: true - # Example of a method that wants to allow unregistered calls. - # usage: - # rules: - # - selector: "google.example.library.v1.LibraryService.CreateBook" - # allow_unregistered_calls: true + # Usage configuration rules for the service. NOTE: Under development. Use this + # rule to configure unregistered calls for the service. Unregistered calls are + # calls that do not contain consumer project identity. (Example: calls that do + # not contain an API key). By default, API methods do not allow unregistered + # calls, and each method call must be identified by a consumer project identity. + # Use this rule to allow/disallow unregistered calls. Example of an API that + # wants to allow unregistered calls for entire service. usage: rules: - selector: + # "*" allow_unregistered_calls: true Example of a method that wants to allow + # unregistered calls. usage: rules: - selector: "google.example.library.v1. + # LibraryService.CreateBook" allow_unregistered_calls: true class UsageRule include Google::Apis::Core::Hashable - # If true, the selected method allows unregistered calls, e.g. calls - # that don't identify any user or application. + # If true, the selected method allows unregistered calls, e.g. calls that don't + # identify any user or application. # Corresponds to the JSON property `allowUnregisteredCalls` # @return [Boolean] attr_accessor :allow_unregistered_calls alias_method :allow_unregistered_calls?, :allow_unregistered_calls # Selects the methods to which this rule applies. Use '*' to indicate all - # methods in all APIs. - # Refer to selector for syntax details. + # methods in all APIs. Refer to selector for syntax details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector - # If true, the selected method should skip service control and the control - # plane features, such as quota and billing, will not be available. - # This flag is used by Google Cloud Endpoints to bypass checks for internal - # methods, such as service health check methods. + # If true, the selected method should skip service control and the control plane + # features, such as quota and billing, will not be available. This flag is used + # by Google Cloud Endpoints to bypass checks for internal methods, such as + # service health check methods. # Corresponds to the JSON property `skipServiceControl` # @return [Boolean] attr_accessor :skip_service_control diff --git a/generated/google/apis/serviceusage_v1beta1/service.rb b/generated/google/apis/serviceusage_v1beta1/service.rb index 76d456599..a877ab07a 100644 --- a/generated/google/apis/serviceusage_v1beta1/service.rb +++ b/generated/google/apis/serviceusage_v1beta1/service.rb @@ -49,9 +49,8 @@ module Google @batch_path = 'batch' 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 @@ -81,15 +80,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] filter # The standard list filter. # @param [String] name @@ -130,13 +128,11 @@ module Google # Enable multiple services on a project. The operation is atomic: if enabling # any service fails, then the entire batch fails, and no state changes occur. - # Operation + # Operation # @param [String] parent - # Parent to enable services on. - # An example name would be: - # `projects/123` - # where `123` is the project number (not project ID). - # The `BatchEnableServices` method currently only supports projects. + # Parent to enable services on. An example name would be: `projects/123` where ` + # 123` is the project number (not project ID). The `BatchEnableServices` method + # currently only supports projects. # @param [Google::Apis::ServiceusageV1beta1::BatchEnableServicesRequest] batch_enable_services_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -167,19 +163,16 @@ module Google execute_or_queue_command(command, &block) end - # Disable a service so that it can no longer be used with a project. - # This prevents unintended usage that may cause unexpected billing - # charges or security leaks. - # It is not valid to call the disable method on a service that is not - # currently enabled. Callers will receive a `FAILED_PRECONDITION` status if - # the target service is not currently enabled. - # Operation + # Disable a service so that it can no longer be used with a project. This + # prevents unintended usage that may cause unexpected billing charges or + # security leaks. It is not valid to call the disable method on a service that + # is not currently enabled. Callers will receive a `FAILED_PRECONDITION` status + # if the target service is not currently enabled. Operation # @param [String] name - # Name of the consumer and service to disable the service on. - # The enable and disable methods currently only support projects. - # An example name would be: - # `projects/123/services/serviceusage.googleapis.com` - # where `123` is the project number (not project ID). + # Name of the consumer and service to disable the service on. The enable and + # disable methods currently only support projects. An example name would be: ` + # projects/123/services/serviceusage.googleapis.com` where `123` is the project + # number (not project ID). # @param [Google::Apis::ServiceusageV1beta1::DisableServiceRequest] disable_service_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -210,17 +203,14 @@ module Google execute_or_queue_command(command, &block) end - # Enable a service so that it can be used with a project. - # Operation + # Enable a service so that it can be used with a project. Operation # @param [String] name - # Name of the consumer and service to enable the service on. - # The `EnableService` and `DisableService` methods currently only support - # projects. - # Enabling a service requires that the service is public or is shared with - # the user enabling the service. - # An example name would be: - # `projects/123/services/serviceusage.googleapis.com` - # where `123` is the project number (not project ID). + # Name of the consumer and service to enable the service on. The `EnableService` + # and `DisableService` methods currently only support projects. Enabling a + # service requires that the service is public or is shared with the user + # enabling the service. An example name would be: `projects/123/services/ + # serviceusage.googleapis.com` where `123` is the project number (not project ID) + # . # @param [Google::Apis::ServiceusageV1beta1::EnableServiceRequest] enable_service_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -253,11 +243,10 @@ module Google # Generate service identity for service. # @param [String] parent - # Name of the consumer and service to generate an identity for. - # The `GenerateServiceIdentity` methods currently only support projects. - # An example name would be: - # `projects/123/services/example.googleapis.com` where `123` is the - # project number. + # Name of the consumer and service to generate an identity for. The ` + # GenerateServiceIdentity` methods currently only support projects. An example + # name would be: `projects/123/services/example.googleapis.com` where `123` is + # the project number. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -287,10 +276,9 @@ module Google # Returns the service configuration and enabled state for a given service. # @param [String] name - # Name of the consumer and service to get the `ConsumerState` for. - # An example name would be: - # `projects/123/services/serviceusage.googleapis.com` - # where `123` is the project number (not project ID). + # Name of the consumer and service to get the `ConsumerState` for. An example + # name would be: `projects/123/services/serviceusage.googleapis.com` where `123` + # is the project number (not project ID). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -318,28 +306,24 @@ module Google execute_or_queue_command(command, &block) end - # List all services available to the specified project, and the current - # state of those services with respect to the project. The list includes - # all public services, all services for which the calling user has the - # `servicemanagement.services.bind` permission, and all services that have - # already been enabled on the project. The list can be filtered to - # only include services in a specific state, for example to only include - # services enabled on the project. + # List all services available to the specified project, and the current state of + # those services with respect to the project. The list includes all public + # services, all services for which the calling user has the `servicemanagement. + # services.bind` permission, and all services that have already been enabled on + # the project. The list can be filtered to only include services in a specific + # state, for example to only include services enabled on the project. # @param [String] parent - # Parent to search for services on. - # An example name would be: - # `projects/123` + # Parent to search for services on. An example name would be: `projects/123` # where `123` is the project number (not project ID). # @param [String] filter - # Only list services that conform to the given filter. - # The allowed filter strings are `state:ENABLED` and `state:DISABLED`. + # Only list services that conform to the given filter. The allowed filter + # strings are `state:ENABLED` and `state:DISABLED`. # @param [Fixnum] page_size - # Requested size of the next page of data. - # Requested page size cannot exceed 200. + # Requested size of the next page of data. Requested page size cannot exceed 200. # If not set, the default page size is 50. # @param [String] page_token - # Token identifying which result to start with, which is returned by a - # previous list call. + # Token identifying which result to start with, which is returned by a previous + # list call. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -372,10 +356,9 @@ module Google # Retrieves a summary of quota information for a specific quota metric # @param [String] name - # The resource name of the quota limit. - # An example name would be: - # projects/123/services/serviceusage.googleapis.com/quotas/metrics/serviceusage. - # googleapis.com%2Fmutate_requests + # The resource name of the quota limit. An example name would be: projects/123/ + # services/serviceusage.googleapis.com/quotas/metrics/serviceusage.googleapis. + # com%2Fmutate_requests # @param [String] view # Specifies the level of detail for quota information in the response. # @param [String] fields @@ -406,13 +389,12 @@ module Google execute_or_queue_command(command, &block) end - # Create or update multiple consumer overrides atomically, all on the - # same consumer, but on many different metrics or limits. - # The name field in the quota override message should not be set. + # Create or update multiple consumer overrides atomically, all on the same + # consumer, but on many different metrics or limits. The name field in the quota + # override message should not be set. # @param [String] parent - # The resource name of the consumer. - # An example name would be: - # `projects/123/services/compute.googleapis.com` + # The resource name of the consumer. An example name would be: `projects/123/ + # services/compute.googleapis.com` # @param [Google::Apis::ServiceusageV1beta1::ImportConsumerOverridesRequest] import_consumer_overrides_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -443,22 +425,20 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves a summary of all quota information visible to the service - # consumer, organized by service metric. Each metric includes information - # about all of its defined limits. Each limit includes the limit - # configuration (quota unit, preciseness, default value), the current - # effective limit value, and all of the overrides applied to the limit. + # Retrieves a summary of all quota information visible to the service consumer, + # organized by service metric. Each metric includes information about all of its + # defined limits. Each limit includes the limit configuration (quota unit, + # preciseness, default value), the current effective limit value, and all of the + # overrides applied to the limit. # @param [String] parent - # Parent of the quotas resource. - # Some example names would be: - # projects/123/services/serviceconsumermanagement.googleapis.com - # folders/345/services/serviceconsumermanagement.googleapis.com - # organizations/456/services/serviceconsumermanagement.googleapis.com + # Parent of the quotas resource. Some example names would be: projects/123/ + # services/serviceconsumermanagement.googleapis.com folders/345/services/ + # serviceconsumermanagement.googleapis.com organizations/456/services/ + # serviceconsumermanagement.googleapis.com # @param [Fixnum] page_size # Requested size of the next page of data. # @param [String] page_token - # Token identifying which result to start with; returned by a previous list - # call. + # Token identifying which result to start with; returned by a previous list call. # @param [String] view # Specifies the level of detail for quota information in the response. # @param [String] fields @@ -493,9 +473,9 @@ module Google # Retrieves a summary of quota information for a specific quota limit. # @param [String] name - # The resource name of the quota limit. - # Use the quota limit resource name returned by previous - # ListConsumerQuotaMetrics and GetConsumerQuotaMetric API calls. + # The resource name of the quota limit. Use the quota limit resource name + # returned by previous ListConsumerQuotaMetrics and GetConsumerQuotaMetric API + # calls. # @param [String] view # Specifies the level of detail for quota information in the response. # @param [String] fields @@ -526,25 +506,23 @@ module Google execute_or_queue_command(command, &block) end - # Creates an admin override. - # An admin override is applied by an administrator of a parent folder or - # parent organization of the consumer receiving the override. An admin - # override is intended to limit the amount of quota the consumer can use out - # of the total quota pool allocated to all children of the folder or + # Creates an admin override. An admin override is applied by an administrator of + # a parent folder or parent organization of the consumer receiving the override. + # An admin override is intended to limit the amount of quota the consumer can + # use out of the total quota pool allocated to all children of the folder or # organization. # @param [String] parent # The resource name of the parent quota limit, returned by a - # ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. - # An example name would be: - # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. + # ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example name would + # be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` # @param [Google::Apis::ServiceusageV1beta1::QuotaOverride] quota_override_object # @param [Boolean] force - # Whether to force the creation of the quota override. - # If creating an override would cause the effective quota for the consumer to - # decrease by more than 10 percent, the call is rejected, as a safety measure - # to avoid accidentally decreasing quota too quickly. Setting the force - # parameter to true ignores this restriction. + # Whether to force the creation of the quota override. If creating an override + # would cause the effective quota for the consumer to decrease by more than 10 + # percent, the call is rejected, as a safety measure to avoid accidentally + # decreasing quota too quickly. Setting the force parameter to true ignores this + # restriction. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -577,16 +555,15 @@ module Google # Deletes an admin override. # @param [String] name - # The resource name of the override to delete. - # An example name would be: - # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. + # The resource name of the override to delete. An example name would be: ` + # projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` # @param [Boolean] force - # Whether to force the deletion of the quota override. - # If deleting an override would cause the effective quota for the consumer to - # decrease by more than 10 percent, the call is rejected, as a safety measure - # to avoid accidentally decreasing quota too quickly. Setting the force - # parameter to true ignores this restriction. + # Whether to force the deletion of the quota override. If deleting an override + # would cause the effective quota for the consumer to decrease by more than 10 + # percent, the call is rejected, as a safety measure to avoid accidentally + # decreasing quota too quickly. Setting the force parameter to true ignores this + # restriction. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -618,15 +595,13 @@ module Google # Lists all admin overrides on this limit. # @param [String] parent # The resource name of the parent quota limit, returned by a - # ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. - # An example name would be: - # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. + # ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example name would + # be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` # @param [Fixnum] page_size # Requested size of the next page of data. # @param [String] page_token - # Token identifying which result to start with; returned by a previous list - # call. + # Token identifying which result to start with; returned by a previous list call. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -658,20 +633,19 @@ module Google # Updates an admin override. # @param [String] name - # The resource name of the override to update. - # An example name would be: - # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. + # The resource name of the override to update. An example name would be: ` + # projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` # @param [Google::Apis::ServiceusageV1beta1::QuotaOverride] quota_override_object # @param [Boolean] force - # Whether to force the update of the quota override. - # If updating an override would cause the effective quota for the consumer to - # decrease by more than 10 percent, the call is rejected, as a safety measure - # to avoid accidentally decreasing quota too quickly. Setting the force - # parameter to true ignores this restriction. + # Whether to force the update of the quota override. If updating an override + # would cause the effective quota for the consumer to decrease by more than 10 + # percent, the call is rejected, as a safety measure to avoid accidentally + # decreasing quota too quickly. Setting the force parameter to true ignores this + # restriction. # @param [String] update_mask - # Update only the specified fields of the override. - # If unset, all fields will be updated. + # Update only the specified fields of the override. If unset, all fields will be + # updated. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -703,24 +677,22 @@ module Google execute_or_queue_command(command, &block) end - # Creates a consumer override. - # A consumer override is applied to the consumer on its own authority to - # limit its own quota usage. Consumer overrides cannot be used to grant more - # quota than would be allowed by admin overrides, producer overrides, or the - # default limit of the service. + # Creates a consumer override. A consumer override is applied to the consumer on + # its own authority to limit its own quota usage. Consumer overrides cannot be + # used to grant more quota than would be allowed by admin overrides, producer + # overrides, or the default limit of the service. # @param [String] parent # The resource name of the parent quota limit, returned by a - # ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. - # An example name would be: - # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. + # ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example name would + # be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` # @param [Google::Apis::ServiceusageV1beta1::QuotaOverride] quota_override_object # @param [Boolean] force - # Whether to force the creation of the quota override. - # If creating an override would cause the effective quota for the consumer to - # decrease by more than 10 percent, the call is rejected, as a safety measure - # to avoid accidentally decreasing quota too quickly. Setting the force - # parameter to true ignores this restriction. + # Whether to force the creation of the quota override. If creating an override + # would cause the effective quota for the consumer to decrease by more than 10 + # percent, the call is rejected, as a safety measure to avoid accidentally + # decreasing quota too quickly. Setting the force parameter to true ignores this + # restriction. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -753,16 +725,15 @@ module Google # Deletes a consumer override. # @param [String] name - # The resource name of the override to delete. - # An example name would be: - # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. + # The resource name of the override to delete. An example name would be: ` + # projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` # @param [Boolean] force - # Whether to force the deletion of the quota override. - # If deleting an override would cause the effective quota for the consumer to - # decrease by more than 10 percent, the call is rejected, as a safety measure - # to avoid accidentally decreasing quota too quickly. Setting the force - # parameter to true ignores this restriction. + # Whether to force the deletion of the quota override. If deleting an override + # would cause the effective quota for the consumer to decrease by more than 10 + # percent, the call is rejected, as a safety measure to avoid accidentally + # decreasing quota too quickly. Setting the force parameter to true ignores this + # restriction. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -794,15 +765,13 @@ module Google # Lists all consumer overrides on this limit. # @param [String] parent # The resource name of the parent quota limit, returned by a - # ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. - # An example name would be: - # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. + # ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example name would + # be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` # @param [Fixnum] page_size # Requested size of the next page of data. # @param [String] page_token - # Token identifying which result to start with; returned by a previous list - # call. + # Token identifying which result to start with; returned by a previous list call. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -834,20 +803,19 @@ module Google # Updates a consumer override. # @param [String] name - # The resource name of the override to update. - # An example name would be: - # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. + # The resource name of the override to update. An example name would be: ` + # projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` # @param [Google::Apis::ServiceusageV1beta1::QuotaOverride] quota_override_object # @param [Boolean] force - # Whether to force the update of the quota override. - # If updating an override would cause the effective quota for the consumer to - # decrease by more than 10 percent, the call is rejected, as a safety measure - # to avoid accidentally decreasing quota too quickly. Setting the force - # parameter to true ignores this restriction. + # Whether to force the update of the quota override. If updating an override + # would cause the effective quota for the consumer to decrease by more than 10 + # percent, the call is rejected, as a safety measure to avoid accidentally + # decreasing quota too quickly. Setting the force parameter to true ignores this + # restriction. # @param [String] update_mask - # Update only the specified fields of the override. - # If unset, all fields will be updated. + # Update only the specified fields of the override. If unset, all fields will be + # updated. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/toolresults_v1beta3.rb b/generated/google/apis/toolresults_v1beta3.rb index 746ecc3f1..68311ed1c 100644 --- a/generated/google/apis/toolresults_v1beta3.rb +++ b/generated/google/apis/toolresults_v1beta3.rb @@ -25,7 +25,7 @@ module Google # @see https://firebase.google.com/docs/test-lab/ module ToolresultsV1beta3 VERSION = 'V1beta3' - REVISION = '20200722' + REVISION = '20200803' # 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/toolresults_v1beta3/classes.rb b/generated/google/apis/toolresults_v1beta3/classes.rb index 658efdb19..741588909 100644 --- a/generated/google/apis/toolresults_v1beta3/classes.rb +++ b/generated/google/apis/toolresults_v1beta3/classes.rb @@ -45,26 +45,22 @@ module Google class AndroidAppInfo include Google::Apis::Core::Hashable - # The name of the app. - # Optional + # The name of the app. Optional # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The package name of the app. - # Required. + # The package name of the app. Required. # Corresponds to the JSON property `packageName` # @return [String] attr_accessor :package_name - # The internal version code of the app. - # Optional. + # The internal version code of the app. Optional. # Corresponds to the JSON property `versionCode` # @return [String] attr_accessor :version_code - # The version name of the app. - # Optional. + # The version name of the app. Optional. # Corresponds to the JSON property `versionName` # @return [String] attr_accessor :version_name @@ -83,36 +79,31 @@ module Google end # A test of an Android application that can control an Android component - # independently of its normal lifecycle. - # See for - # more information on types of Android tests. + # independently of its normal lifecycle. See for more information on types of + # Android tests. class AndroidInstrumentationTest include Google::Apis::Core::Hashable - # The java package for the test to be executed. - # Required + # The java package for the test to be executed. Required # Corresponds to the JSON property `testPackageId` # @return [String] attr_accessor :test_package_id - # The InstrumentationTestRunner class. - # Required + # The InstrumentationTestRunner class. Required # Corresponds to the JSON property `testRunnerClass` # @return [String] attr_accessor :test_runner_class - # Each target must be fully qualified with the package name or class name, - # in one of these formats: - # - "package package_name" - # - "class package_name.class_name" - # - "class package_name.class_name#method_name" - # If empty, all targets in the module will be run. + # Each target must be fully qualified with the package name or class name, in + # one of these formats: - "package package_name" - "class package_name. + # class_name" - "class package_name.class_name#method_name" If empty, all + # targets in the module will be run. # Corresponds to the JSON property `testTargets` # @return [Array] attr_accessor :test_targets - # The flag indicates whether Android Test Orchestrator will be used to run - # test or not. + # The flag indicates whether Android Test Orchestrator will be used to run test + # or not. # Corresponds to the JSON property `useOrchestrator` # @return [Boolean] attr_accessor :use_orchestrator @@ -131,37 +122,32 @@ module Google end end - # A test of an android application that explores the application on a virtual - # or physical Android device, finding culprits and crashes as it goes. + # A test of an android application that explores the application on a virtual or + # physical Android device, finding culprits and crashes as it goes. class AndroidRoboTest include Google::Apis::Core::Hashable - # The initial activity that should be used to start the app. - # Optional + # The initial activity that should be used to start the app. Optional # Corresponds to the JSON property `appInitialActivity` # @return [String] attr_accessor :app_initial_activity - # The java package for the bootstrap. - # Optional + # The java package for the bootstrap. Optional # Corresponds to the JSON property `bootstrapPackageId` # @return [String] attr_accessor :bootstrap_package_id - # The runner class for the bootstrap. - # Optional + # The runner class for the bootstrap. Optional # Corresponds to the JSON property `bootstrapRunnerClass` # @return [String] attr_accessor :bootstrap_runner_class - # The max depth of the traversal stack Robo can explore. - # Optional + # The max depth of the traversal stack Robo can explore. Optional # Corresponds to the JSON property `maxDepth` # @return [Fixnum] attr_accessor :max_depth - # The max number of steps/actions Robo can execute. - # Default is no limit (0). + # The max number of steps/actions Robo can execute. Default is no limit (0). # Optional # Corresponds to the JSON property `maxSteps` # @return [Fixnum] @@ -191,31 +177,30 @@ module Google attr_accessor :android_app_info # A test of an Android application that can control an Android component - # independently of its normal lifecycle. - # See for - # more information on types of Android tests. + # independently of its normal lifecycle. See for more information on types of + # Android tests. # Corresponds to the JSON property `androidInstrumentationTest` # @return [Google::Apis::ToolresultsV1beta3::AndroidInstrumentationTest] attr_accessor :android_instrumentation_test - # A test of an android application that explores the application on a virtual - # or physical Android device, finding culprits and crashes as it goes. + # A test of an android application that explores the application on a virtual or + # physical Android device, finding culprits and crashes as it goes. # Corresponds to the JSON property `androidRoboTest` # @return [Google::Apis::ToolresultsV1beta3::AndroidRoboTest] attr_accessor :android_robo_test - # Test Loops are tests that can be launched by the app itself, determining - # when to run by listening for an intent. + # Test Loops are tests that can be launched by the app itself, determining when + # to run by listening for an intent. # Corresponds to the JSON property `androidTestLoop` # @return [Google::Apis::ToolresultsV1beta3::AndroidTestLoop] attr_accessor :android_test_loop - # A Duration represents a signed, fixed-length span of time represented - # as a count of seconds and fractions of seconds at nanosecond - # resolution. It is independent of any calendar and concepts like "day" - # or "month". It is related to Timestamp in that the difference between - # two Timestamp values is a Duration and it can be added or subtracted - # from a Timestamp. Range is approximately +-10,000 years. + # A Duration represents a signed, fixed-length span of time represented as a + # count of seconds and fractions of seconds at nanosecond resolution. It is + # independent of any calendar and concepts like "day" or "month". It is related + # to Timestamp in that the difference between two Timestamp values is a Duration + # and it can be added or subtracted from a Timestamp. Range is approximately +- + # 10,000 years. # Corresponds to the JSON property `testTimeout` # @return [Google::Apis::ToolresultsV1beta3::Duration] attr_accessor :test_timeout @@ -234,8 +219,8 @@ module Google end end - # Test Loops are tests that can be launched by the app itself, determining - # when to run by listening for an intent. + # Test Loops are tests that can be launched by the app itself, determining when + # to run by listening for an intent. class AndroidTestLoop include Google::Apis::Core::Hashable @@ -249,93 +234,50 @@ module Google end # `Any` contains an arbitrary serialized protocol buffer message along with a - # URL that describes the type of the serialized message. - # Protobuf library provides support to pack/unpack Any values in the form - # of utility functions or additional generated methods of the Any type. - # Example 1: Pack and unpack a message in C++. - # Foo foo = ...; - # Any any; - # any.PackFrom(foo); - # ... - # if (any.UnpackTo(&foo)) ` - # ... - # ` - # Example 2: Pack and unpack a message in Java. - # Foo foo = ...; - # Any any = Any.pack(foo); - # ... - # if (any.is(Foo.class)) ` - # foo = any.unpack(Foo.class); - # ` - # Example 3: Pack and unpack a message in Python. - # foo = Foo(...) - # any = Any() - # any.Pack(foo) - # ... - # if any.Is(Foo.DESCRIPTOR): - # any.Unpack(foo) - # ... - # Example 4: Pack and unpack a message in Go - # foo := &pb.Foo`...` - # any, err := ptypes.MarshalAny(foo) - # ... - # foo := &pb.Foo`` - # if err := ptypes.UnmarshalAny(any, foo); err != nil ` - # ... - # ` - # The pack methods provided by protobuf library will by default use - # 'type.googleapis.com/full.type.name' as the type URL and the unpack - # methods only use the fully qualified type name after the last '/' - # in the type URL, for example "foo.bar.com/x/y.z" will yield type - # name "y.z". - # # JSON - # The JSON representation of an `Any` value uses the regular - # representation of the deserialized, embedded message, with an - # additional field `@type` which contains the type URL. Example: - # package google.profile; - # message Person ` - # string first_name = 1; - # string last_name = 2; - # ` - # ` - # "@type": "type.googleapis.com/google.profile.Person", - # "firstName": , - # "lastName": - # ` - # If the embedded message type is well-known and has a custom JSON - # representation, that representation will be embedded adding a field - # `value` which holds the custom JSON in addition to the `@type` - # field. Example (for message google.protobuf.Duration): - # ` - # "@type": "type.googleapis.com/google.protobuf.Duration", - # "value": "1.212s" - # ` + # URL that describes the type of the serialized message. Protobuf library + # provides support to pack/unpack Any values in the form of utility functions or + # additional generated methods of the Any type. Example 1: Pack and unpack a + # message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any. + # UnpackTo(&foo)) ` ... ` Example 2: Pack and unpack a message in Java. Foo foo = + # ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) ` foo = any.unpack( + # Foo.class); ` Example 3: Pack and unpack a message in Python. foo = Foo(...) + # any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... + # Example 4: Pack and unpack a message in Go foo := &pb.Foo`...` any, err := + # ptypes.MarshalAny(foo) ... foo := &pb.Foo`` if err := ptypes.UnmarshalAny(any, + # foo); err != nil ` ... ` The pack methods provided by protobuf library will by + # default use 'type.googleapis.com/full.type.name' as the type URL and the + # unpack methods only use the fully qualified type name after the last '/' in + # the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". # + # JSON The JSON representation of an `Any` value uses the regular representation + # of the deserialized, embedded message, with an additional field `@type` which + # contains the type URL. Example: package google.profile; message Person ` + # string first_name = 1; string last_name = 2; ` ` "@type": "type.googleapis.com/ + # google.profile.Person", "firstName": , "lastName": ` If the embedded message + # type is well-known and has a custom JSON representation, that representation + # will be embedded adding a field `value` which holds the custom JSON in + # addition to the `@type` field. Example (for message google.protobuf.Duration): + # ` "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" ` class Any include Google::Apis::Core::Hashable # A URL/resource name that uniquely identifies the type of the serialized - # protocol buffer message. This string must contain at least - # one "/" character. The last segment of the URL's path must represent - # the fully qualified name of the type (as in - # `path/google.protobuf.Duration`). The name should be in a canonical form - # (e.g., leading "." is not accepted). - # In practice, teams usually precompile into the binary all types that they - # expect it to use in the context of Any. However, for URLs which use the - # scheme `http`, `https`, or no scheme, one can optionally set up a type - # server that maps type URLs to message definitions as follows: - # * If no scheme is provided, `https` is assumed. - # * An HTTP GET on the URL must yield a google.protobuf.Type - # value in binary format, or produce an error. - # * Applications are allowed to cache lookup results based on the - # URL, or have them precompiled into a binary to avoid any - # lookup. Therefore, binary compatibility needs to be preserved - # on changes to types. (Use versioned type names to manage - # breaking changes.) - # Note: this functionality is not currently available in the official - # protobuf release, and it is not used for type URLs beginning with - # type.googleapis.com. - # Schemes other than `http`, `https` (or the empty scheme) might be - # used with implementation specific semantics. + # protocol buffer message. This string must contain at least one "/" character. + # The last segment of the URL's path must represent the fully qualified name of + # the type (as in `path/google.protobuf.Duration`). The name should be in a + # canonical form (e.g., leading "." is not accepted). In practice, teams usually + # precompile into the binary all types that they expect it to use in the context + # of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, + # one can optionally set up a type server that maps type URLs to message + # definitions as follows: * If no scheme is provided, `https` is assumed. * An + # HTTP GET on the URL must yield a google.protobuf.Type value in binary format, + # or produce an error. * Applications are allowed to cache lookup results based + # on the URL, or have them precompiled into a binary to avoid any lookup. + # Therefore, binary compatibility needs to be preserved on changes to types. ( + # Use versioned type names to manage breaking changes.) Note: this functionality + # is not currently available in the official protobuf release, and it is not + # used for type URLs beginning with type.googleapis.com. Schemes other than ` + # http`, `https` (or the empty scheme) might be used with implementation + # specific semantics. # Corresponds to the JSON property `typeUrl` # @return [String] attr_accessor :type_url @@ -361,22 +303,22 @@ module Google class AppStartTime include Google::Apis::Core::Hashable - # A Duration represents a signed, fixed-length span of time represented - # as a count of seconds and fractions of seconds at nanosecond - # resolution. It is independent of any calendar and concepts like "day" - # or "month". It is related to Timestamp in that the difference between - # two Timestamp values is a Duration and it can be added or subtracted - # from a Timestamp. Range is approximately +-10,000 years. + # A Duration represents a signed, fixed-length span of time represented as a + # count of seconds and fractions of seconds at nanosecond resolution. It is + # independent of any calendar and concepts like "day" or "month". It is related + # to Timestamp in that the difference between two Timestamp values is a Duration + # and it can be added or subtracted from a Timestamp. Range is approximately +- + # 10,000 years. # Corresponds to the JSON property `fullyDrawnTime` # @return [Google::Apis::ToolresultsV1beta3::Duration] attr_accessor :fully_drawn_time - # A Duration represents a signed, fixed-length span of time represented - # as a count of seconds and fractions of seconds at nanosecond - # resolution. It is independent of any calendar and concepts like "day" - # or "month". It is related to Timestamp in that the difference between - # two Timestamp values is a Duration and it can be added or subtracted - # from a Timestamp. Range is approximately +-10,000 years. + # A Duration represents a signed, fixed-length span of time represented as a + # count of seconds and fractions of seconds at nanosecond resolution. It is + # independent of any calendar and concepts like "day" or "month". It is related + # to Timestamp in that the difference between two Timestamp values is a Duration + # and it can be added or subtracted from a Timestamp. Range is approximately +- + # 10,000 years. # Corresponds to the JSON property `initialDisplayTime` # @return [Google::Apis::ToolresultsV1beta3::Duration] attr_accessor :initial_display_time @@ -436,8 +378,8 @@ module Google end end - # The request must provide up to a maximum of 5000 samples to be - # created; a larger sample size will cause an INVALID_ARGUMENT error + # The request must provide up to a maximum of 5000 samples to be created; a + # larger sample size will cause an INVALID_ARGUMENT error class BatchCreatePerfSamplesRequest include Google::Apis::Core::Hashable @@ -545,28 +487,27 @@ module Google end end - # A Duration represents a signed, fixed-length span of time represented - # as a count of seconds and fractions of seconds at nanosecond - # resolution. It is independent of any calendar and concepts like "day" - # or "month". It is related to Timestamp in that the difference between - # two Timestamp values is a Duration and it can be added or subtracted - # from a Timestamp. Range is approximately +-10,000 years. + # A Duration represents a signed, fixed-length span of time represented as a + # count of seconds and fractions of seconds at nanosecond resolution. It is + # independent of any calendar and concepts like "day" or "month". It is related + # to Timestamp in that the difference between two Timestamp values is a Duration + # and it can be added or subtracted from a Timestamp. Range is approximately +- + # 10,000 years. class Duration include Google::Apis::Core::Hashable - # Signed fractions of a second at nanosecond resolution of the span - # of time. Durations less than one second are represented with a 0 - # `seconds` field and a positive or negative `nanos` field. For durations - # of one second or more, a non-zero value for the `nanos` field must be - # of the same sign as the `seconds` field. Must be from -999,999,999 - # to +999,999,999 inclusive. + # Signed fractions of a second at nanosecond resolution of the span of time. + # Durations less than one second are represented with a 0 `seconds` field and a + # positive or negative `nanos` field. For durations of one second or more, a non- + # zero value for the `nanos` field must be of the same sign as the `seconds` + # field. Must be from -999,999,999 to +999,999,999 inclusive. # Corresponds to the JSON property `nanos` # @return [Fixnum] attr_accessor :nanos - # Signed seconds of the span of time. Must be from -315,576,000,000 - # to +315,576,000,000 inclusive. Note: these bounds are computed from: - # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576, + # 000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/ + # hr * 24 hr/day * 365.25 days/year * 10000 years # Corresponds to the JSON property `seconds` # @return [Fixnum] attr_accessor :seconds @@ -634,55 +575,50 @@ module Google end # An Environment represents the set of test runs (Steps) from the parent - # Execution that are configured with the same set of dimensions (Model, - # Version, Locale, and Orientation). Multiple such runs occur particularly - # because of features like sharding (splitting up a test suite to run in - # parallel across devices) and reruns (running a test multiple times to check - # for different outcomes). + # Execution that are configured with the same set of dimensions (Model, Version, + # Locale, and Orientation). Multiple such runs occur particularly because of + # features like sharding (splitting up a test suite to run in parallel across + # devices) and reruns (running a test multiple times to check for different + # outcomes). class Environment include Google::Apis::Core::Hashable # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at - # nanosecond resolution. The count is relative to an epoch at UTC midnight on - # January 1, 1970, in the proleptic Gregorian calendar which extends the - # Gregorian calendar backwards to year one. - # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear - # smear](https://developers.google.com/time/smear). - # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC - # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. + # calendar, encoded as a count of seconds and fractions of seconds at nanosecond + # resolution. The count is relative to an epoch at UTC midnight on January 1, + # 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar + # backwards to year one. All minutes are 60 seconds long. Leap seconds are " + # smeared" so that no leap second table is needed for interpretation, using a [ + # 24-hour linear smear](https://developers.google.com/time/smear). The range is + # from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to + # that range, we ensure that we can convert to and from [RFC 3339](https://www. + # ietf.org/rfc/rfc3339.txt) date strings. # Corresponds to the JSON property `completionTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :completion_time # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at - # nanosecond resolution. The count is relative to an epoch at UTC midnight on - # January 1, 1970, in the proleptic Gregorian calendar which extends the - # Gregorian calendar backwards to year one. - # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear - # smear](https://developers.google.com/time/smear). - # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC - # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. + # calendar, encoded as a count of seconds and fractions of seconds at nanosecond + # resolution. The count is relative to an epoch at UTC midnight on January 1, + # 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar + # backwards to year one. All minutes are 60 seconds long. Leap seconds are " + # smeared" so that no leap second table is needed for interpretation, using a [ + # 24-hour linear smear](https://developers.google.com/time/smear). The range is + # from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to + # that range, we ensure that we can convert to and from [RFC 3339](https://www. + # ietf.org/rfc/rfc3339.txt) date strings. # Corresponds to the JSON property `creationTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :creation_time - # Dimension values describing the environment. Dimension values always - # consist of "Model", "Version", "Locale", and "Orientation". - # - In response: always set - # - In create request: always set - # - In update request: never set + # Dimension values describing the environment. Dimension values always consist + # of "Model", "Version", "Locale", and "Orientation". - In response: always set - + # In create request: always set - In update request: never set # Corresponds to the JSON property `dimensionValue` # @return [Array] attr_accessor :dimension_value - # A short human-readable name to display in the UI. - # Maximum of 100 characters. + # A short human-readable name to display in the UI. Maximum of 100 characters. # For example: Nexus 5, API 27. # Corresponds to the JSON property `displayName` # @return [String] @@ -693,11 +629,11 @@ module Google # @return [String] attr_accessor :environment_id - # Merged test result for environment. - # If the environment has only one step (no reruns or shards), then the merged - # result is the same as the step result. If the environment has multiple shards - # and/or reruns, then the results of shards and reruns that belong to the same - # environment are merged into one environment result. + # Merged test result for environment. If the environment has only one step (no + # reruns or shards), then the merged result is the same as the step result. If + # the environment has multiple shards and/or reruns, then the results of shards + # and reruns that belong to the same environment are merged into one environment + # result. # Corresponds to the JSON property `environmentResult` # @return [Google::Apis::ToolresultsV1beta3::MergedResult] attr_accessor :environment_result @@ -722,9 +658,8 @@ module Google # @return [Google::Apis::ToolresultsV1beta3::ResultsStorage] attr_accessor :results_storage - # Output only. Summaries of shards. - # Only one shard will present unless sharding feature is enabled in - # TestExecutionService. + # Output only. Summaries of shards. Only one shard will present unless sharding + # feature is enabled in TestExecutionService. # Corresponds to the JSON property `shardSummaries` # @return [Array] attr_accessor :shard_summaries @@ -775,62 +710,54 @@ module Google end # An Execution represents a collection of Steps. For instance, it could - # represent: - # - a mobile test executed across a range of device configurations - # - a jenkins job with a build step followed by a test step - # The maximum size of an execution message is 1 MiB. - # An Execution can be updated until its state is set to COMPLETE at which - # point it becomes immutable. + # represent: - a mobile test executed across a range of device configurations - + # a jenkins job with a build step followed by a test step The maximum size of an + # execution message is 1 MiB. An Execution can be updated until its state is set + # to COMPLETE at which point it becomes immutable. class Execution include Google::Apis::Core::Hashable # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at - # nanosecond resolution. The count is relative to an epoch at UTC midnight on - # January 1, 1970, in the proleptic Gregorian calendar which extends the - # Gregorian calendar backwards to year one. - # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear - # smear](https://developers.google.com/time/smear). - # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC - # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. + # calendar, encoded as a count of seconds and fractions of seconds at nanosecond + # resolution. The count is relative to an epoch at UTC midnight on January 1, + # 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar + # backwards to year one. All minutes are 60 seconds long. Leap seconds are " + # smeared" so that no leap second table is needed for interpretation, using a [ + # 24-hour linear smear](https://developers.google.com/time/smear). The range is + # from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to + # that range, we ensure that we can convert to and from [RFC 3339](https://www. + # ietf.org/rfc/rfc3339.txt) date strings. # Corresponds to the JSON property `completionTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :completion_time # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at - # nanosecond resolution. The count is relative to an epoch at UTC midnight on - # January 1, 1970, in the proleptic Gregorian calendar which extends the - # Gregorian calendar backwards to year one. - # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear - # smear](https://developers.google.com/time/smear). - # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC - # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. + # calendar, encoded as a count of seconds and fractions of seconds at nanosecond + # resolution. The count is relative to an epoch at UTC midnight on January 1, + # 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar + # backwards to year one. All minutes are 60 seconds long. Leap seconds are " + # smeared" so that no leap second table is needed for interpretation, using a [ + # 24-hour linear smear](https://developers.google.com/time/smear). The range is + # from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to + # that range, we ensure that we can convert to and from [RFC 3339](https://www. + # ietf.org/rfc/rfc3339.txt) date strings. # Corresponds to the JSON property `creationTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :creation_time - # The dimensions along which different steps in this execution may vary. - # This must remain fixed over the life of the execution. - # Returns INVALID_ARGUMENT if this field is set in an update request. - # Returns INVALID_ARGUMENT if the same name occurs in more than one - # dimension_definition. - # Returns INVALID_ARGUMENT if the size of the list is over 100. - # - In response: present if set by create - # - In create request: optional - # - In update request: never set + # The dimensions along which different steps in this execution may vary. This + # must remain fixed over the life of the execution. Returns INVALID_ARGUMENT if + # this field is set in an update request. Returns INVALID_ARGUMENT if the same + # name occurs in more than one dimension_definition. Returns INVALID_ARGUMENT if + # the size of the list is over 100. - In response: present if set by create - In + # create request: optional - In update request: never set # Corresponds to the JSON property `dimensionDefinitions` # @return [Array] attr_accessor :dimension_definitions - # A unique identifier within a History for this Execution. - # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - # - In response always set - # - In create/update request: never set + # A unique identifier within a History for this Execution. Returns + # INVALID_ARGUMENT if this field is set or overwritten by the caller. - In + # response always set - In create/update request: never set # Corresponds to the JSON property `executionId` # @return [String] attr_accessor :execution_id @@ -845,25 +772,20 @@ module Google # @return [Google::Apis::ToolresultsV1beta3::Specification] attr_accessor :specification - # The initial state is IN_PROGRESS. - # The only legal state transitions is from IN_PROGRESS to COMPLETE. - # A PRECONDITION_FAILED will be returned if an invalid transition is - # requested. - # The state can only be set to COMPLETE once. A FAILED_PRECONDITION will be - # returned if the state is set to COMPLETE multiple times. - # If the state is set to COMPLETE, all the in-progress steps within the - # execution will be set as COMPLETE. If the outcome of the step is not set, - # the outcome will be set to INCONCLUSIVE. - # - In response always set - # - In create/update request: optional + # The initial state is IN_PROGRESS. The only legal state transitions is from + # IN_PROGRESS to COMPLETE. A PRECONDITION_FAILED will be returned if an invalid + # transition is requested. The state can only be set to COMPLETE once. A + # FAILED_PRECONDITION will be returned if the state is set to COMPLETE multiple + # times. If the state is set to COMPLETE, all the in-progress steps within the + # execution will be set as COMPLETE. If the outcome of the step is not set, the + # outcome will be set to INCONCLUSIVE. - In response always set - In create/ + # update request: optional # Corresponds to the JSON property `state` # @return [String] attr_accessor :state - # TestExecution Matrix ID that the TestExecutionService uses. - # - In response: present if set by create - # - In create: optional - # - In update: never set + # TestExecution Matrix ID that the TestExecutionService uses. - In response: + # present if set by create - In create: optional - In update: never set # Corresponds to the JSON property `testExecutionMatrixId` # @return [String] attr_accessor :test_execution_matrix_id @@ -908,16 +830,16 @@ module Google attr_accessor :crashed alias_method :crashed?, :crashed - # If the Roboscript failed to complete successfully, e.g., because a - # Roboscript action or assertion failed or a Roboscript action could not be - # matched during the entire crawl. + # If the Roboscript failed to complete successfully, e.g., because a Roboscript + # action or assertion failed or a Roboscript action could not be matched during + # the entire crawl. # Corresponds to the JSON property `failedRoboscript` # @return [Boolean] attr_accessor :failed_roboscript alias_method :failed_roboscript?, :failed_roboscript - # If an app is not installed and thus no test can be run with the app. - # This might be caused by trying to run a test on an unsupported platform. + # If an app is not installed and thus no test can be run with the app. This + # might be caused by trying to run a test on an unsupported platform. # Corresponds to the JSON property `notInstalled` # @return [Boolean] attr_accessor :not_installed @@ -935,8 +857,7 @@ module Google attr_accessor :timed_out alias_method :timed_out?, :timed_out - # If the robo was unable to crawl the app; perhaps because the app did not - # start. + # If the robo was unable to crawl the app; perhaps because the app did not start. # Corresponds to the JSON property `unableToCrawl` # @return [Boolean] attr_accessor :unable_to_crawl @@ -980,15 +901,12 @@ module Google class FileReference include Google::Apis::Core::Hashable - # The URI of a file stored in Google Cloud Storage. - # For example: http://storage.googleapis.com/mybucket/path/to/test.xml - # or in gsutil format: gs://mybucket/path/to/test.xml - # with version-specific info, - # gs://mybucket/path/to/test.xml#1360383693690000 - # An INVALID_ARGUMENT error will be returned if the URI format is not - # supported. - # - In response: always set - # - In create/update request: always set + # The URI of a file stored in Google Cloud Storage. For example: http://storage. + # googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/ + # path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml# + # 1360383693690000 An INVALID_ARGUMENT error will be returned if the URI format + # is not supported. - In response: always set - In create/update request: always + # set # Corresponds to the JSON property `fileUri` # @return [String] attr_accessor :file_uri @@ -1003,16 +921,14 @@ module Google end end - # Graphics statistics for the App. - # The information is collected from 'adb shell dumpsys graphicsstats'. - # For more info see: - # https://developer.android.com/training/testing/performance.html - # Statistics will only be present for API 23+. + # Graphics statistics for the App. The information is collected from 'adb shell + # dumpsys graphicsstats'. For more info see: https://developer.android.com/ + # training/testing/performance.html Statistics will only be present for API 23+. class GraphicsStats include Google::Apis::Core::Hashable - # Histogram of frame render times. There should be 154 buckets ranging from - # [5ms, 6ms) to [4950ms, infinity) + # Histogram of frame render times. There should be 154 buckets ranging from [5ms, + # 6ms) to [4950ms, infinity) # Corresponds to the JSON property `buckets` # @return [Array] attr_accessor :buckets @@ -1120,40 +1036,34 @@ module Google # A History represents a sorted list of Executions ordered by the # start_timestamp_millis field (descending). It can be used to group all the - # Executions of a continuous build. - # Note that the ordering only operates on one-dimension. If a repository has - # multiple branches, it means that multiple histories will need to be - # used in order to order Executions per branch. + # Executions of a continuous build. Note that the ordering only operates on one- + # dimension. If a repository has multiple branches, it means that multiple + # histories will need to be used in order to order Executions per branch. class History include Google::Apis::Core::Hashable - # A short human-readable (plain text) name to display in the UI. - # Maximum of 100 characters. - # - In response: present if set during create. - # - In create request: optional + # A short human-readable (plain text) name to display in the UI. Maximum of 100 + # characters. - In response: present if set during create. - In create request: + # optional # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # A unique identifier within a project for this History. - # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - # - In response always set - # - In create request: never set + # A unique identifier within a project for this History. Returns + # INVALID_ARGUMENT if this field is set or overwritten by the caller. - In + # response always set - In create request: never set # Corresponds to the JSON property `historyId` # @return [String] attr_accessor :history_id - # A name to uniquely identify a history within a project. - # Maximum of 200 characters. - # - In response always set - # - In create request: always set + # A name to uniquely identify a history within a project. Maximum of 200 + # characters. - In response always set - In create request: always set # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The platform of the test history. - # - In response: always set. Returns the platform of the last execution if - # unknown. + # The platform of the test history. - In response: always set. Returns the + # platform of the last execution if unknown. # Corresponds to the JSON property `testPlatform` # @return [String] attr_accessor :test_platform @@ -1175,12 +1085,12 @@ module Google class Image include Google::Apis::Core::Hashable - # 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::ToolresultsV1beta3::Status] attr_accessor :error @@ -1190,8 +1100,7 @@ module Google # @return [Google::Apis::ToolresultsV1beta3::ToolOutputReference] attr_accessor :source_image - # The step to which the image is attached. - # Always set. + # The step to which the image is attached. Always set. # Corresponds to the JSON property `stepId` # @return [String] attr_accessor :step_id @@ -1218,8 +1127,8 @@ module Google class InAppPurchasesFound include Google::Apis::Core::Hashable - # The total number of in-app purchases flows explored: how many times the - # robo tries to buy a SKU. + # The total number of in-app purchases flows explored: how many times the robo + # tries to buy a SKU. # Corresponds to the JSON property `inAppPurchasesFlowsExplored` # @return [Fixnum] attr_accessor :in_app_purchases_flows_explored @@ -1245,25 +1154,24 @@ module Google include Google::Apis::Core::Hashable # If the end user aborted the test execution before a pass or fail could be - # determined. - # For example, the user pressed ctrl-c which sent a kill signal to the test - # runner while the test was running. + # determined. For example, the user pressed ctrl-c which sent a kill signal to + # the test runner while the test was running. # Corresponds to the JSON property `abortedByUser` # @return [Boolean] attr_accessor :aborted_by_user alias_method :aborted_by_user?, :aborted_by_user - # If results are being provided to the user in certain cases of - # infrastructure failures + # If results are being provided to the user in certain cases of infrastructure + # failures # Corresponds to the JSON property `hasErrorLogs` # @return [Boolean] attr_accessor :has_error_logs alias_method :has_error_logs?, :has_error_logs # If the test runner could not determine success or failure because the test - # depends on a component other than the system under test which failed. - # For example, a mobile test requires provisioning a device where the test - # executes, and that provisioning can fail. + # depends on a component other than the system under test which failed. For + # example, a mobile test requires provisioning a device where the test executes, + # and that provisioning can fail. # Corresponds to the JSON property `infrastructureFailure` # @return [Boolean] attr_accessor :infrastructure_failure @@ -1281,14 +1189,13 @@ module Google end end - # Step Id and outcome of each individual step that was run as a group with - # other steps with the same configuration. + # Step Id and outcome of each individual step that was run as a group with other + # steps with the same configuration. class IndividualOutcome include Google::Apis::Core::Hashable - # Unique int given to each step. - # Ranges from 0(inclusive) to total number of steps(exclusive). - # The primary step is 0. + # Unique int given to each step. Ranges from 0(inclusive) to total number of + # steps(exclusive). The primary step is 0. # Corresponds to the JSON property `multistepNumber` # @return [Fixnum] attr_accessor :multistep_number @@ -1298,12 +1205,12 @@ module Google # @return [String] attr_accessor :outcome_summary - # A Duration represents a signed, fixed-length span of time represented - # as a count of seconds and fractions of seconds at nanosecond - # resolution. It is independent of any calendar and concepts like "day" - # or "month". It is related to Timestamp in that the difference between - # two Timestamp values is a Duration and it can be added or subtracted - # from a Timestamp. Range is approximately +-10,000 years. + # A Duration represents a signed, fixed-length span of time represented as a + # count of seconds and fractions of seconds at nanosecond resolution. It is + # independent of any calendar and concepts like "day" or "month". It is related + # to Timestamp in that the difference between two Timestamp values is a Duration + # and it can be added or subtracted from a Timestamp. Range is approximately +- + # 10,000 years. # Corresponds to the JSON property `runDuration` # @return [Google::Apis::ToolresultsV1beta3::Duration] attr_accessor :run_duration @@ -1362,8 +1269,7 @@ module Google class IosAppInfo include Google::Apis::Core::Hashable - # The name of the app. - # Required + # The name of the app. Required # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1415,12 +1321,12 @@ module Google # @return [Google::Apis::ToolresultsV1beta3::IosXcTest] attr_accessor :ios_xc_test - # A Duration represents a signed, fixed-length span of time represented - # as a count of seconds and fractions of seconds at nanosecond - # resolution. It is independent of any calendar and concepts like "day" - # or "month". It is related to Timestamp in that the difference between - # two Timestamp values is a Duration and it can be added or subtracted - # from a Timestamp. Range is approximately +-10,000 years. + # A Duration represents a signed, fixed-length span of time represented as a + # count of seconds and fractions of seconds at nanosecond resolution. It is + # independent of any calendar and concepts like "day" or "month". It is related + # to Timestamp in that the difference between two Timestamp values is a Duration + # and it can be added or subtracted from a Timestamp. Range is approximately +- + # 10,000 years. # Corresponds to the JSON property `testTimeout` # @return [Google::Apis::ToolresultsV1beta3::Duration] attr_accessor :test_timeout @@ -1500,32 +1406,28 @@ module Google class ListEnvironmentsResponse include Google::Apis::Core::Hashable - # Environments. - # Always set. + # Environments. Always set. # Corresponds to the JSON property `environments` # @return [Array] attr_accessor :environments - # A Execution id - # Always set. + # A Execution id Always set. # Corresponds to the JSON property `executionId` # @return [String] attr_accessor :execution_id - # A History id. - # Always set. + # A History id. Always set. # Corresponds to the JSON property `historyId` # @return [String] attr_accessor :history_id - # A continuation token to resume the query at the next item. - # Will only be set if there are more Environments to fetch. + # A continuation token to resume the query at the next item. Will only be set if + # there are more Environments to fetch. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # A Project id. - # Always set. + # A Project id. Always set. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id @@ -1548,14 +1450,13 @@ module Google class ListExecutionsResponse include Google::Apis::Core::Hashable - # Executions. - # Always set. + # Executions. Always set. # Corresponds to the JSON property `executions` # @return [Array] attr_accessor :executions - # A continuation token to resume the query at the next item. - # Will only be set if there are more Executions to fetch. + # A continuation token to resume the query at the next item. Will only be set if + # there are more Executions to fetch. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1580,12 +1481,11 @@ module Google # @return [Array] attr_accessor :histories - # A continuation token to resume the query at the next item. - # Will only be set if there are more histories to fetch. - # Tokens are valid for up to one hour from the time of the first list - # request. For instance, if you make a list request at 1PM and use the token - # from this first request 10 minutes later, the token from this second - # response will only be valid for 50 minutes. + # A continuation token to resume the query at the next item. Will only be set if + # there are more histories to fetch. Tokens are valid for up to one hour from + # the time of the first list request. For instance, if you make a list request + # at 1PM and use the token from this first request 10 minutes later, the token + # from this second response will only be valid for 50 minutes. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1625,8 +1525,8 @@ module Google include Google::Apis::Core::Hashable # Optional, returned if result size exceeds the page size specified in the - # request (or the default page size, 500, if unspecified). It indicates the - # last sample timestamp to be used as page_token in subsequent request + # request (or the default page size, 500, if unspecified). It indicates the last + # sample timestamp to be used as page_token in subsequent request # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1651,8 +1551,7 @@ module Google class ListScreenshotClustersResponse include Google::Apis::Core::Hashable - # The set of clusters associated with an execution - # Always set + # The set of clusters associated with an execution Always set # Corresponds to the JSON property `clusters` # @return [Array] attr_accessor :clusters @@ -1671,19 +1570,17 @@ module Google class ListStepAccessibilityClustersResponse include Google::Apis::Core::Hashable - # A sequence of accessibility suggestions, grouped into clusters. - # Within the sequence, clusters that belong to the same SuggestionCategory - # should be adjacent. - # Within each category, clusters should be ordered by their - # SuggestionPriority (ERRORs first). - # The categories should be ordered by their highest priority cluster. + # A sequence of accessibility suggestions, grouped into clusters. Within the + # sequence, clusters that belong to the same SuggestionCategory should be + # adjacent. Within each category, clusters should be ordered by their + # SuggestionPriority (ERRORs first). The categories should be ordered by their + # highest priority cluster. # Corresponds to the JSON property `clusters` # @return [Array] attr_accessor :clusters - # A full resource name of the step. - # For example, projects/my-project/histories/bh.1234567890abcdef/executions/ - # 1234567890123456789/steps/bs.1234567890abcdef + # A full resource name of the step. For example, projects/my-project/histories/ + # bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef # Always presents. # Corresponds to the JSON property `name` # @return [String] @@ -1704,23 +1601,19 @@ module Google class ListStepThumbnailsResponse include Google::Apis::Core::Hashable - # A continuation token to resume the query at the next item. - # If set, indicates that there are more thumbnails to read, by calling list - # again with this value in the page_token field. + # A continuation token to resume the query at the next item. If set, indicates + # that there are more thumbnails to read, by calling list again with this value + # in the page_token field. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # A list of image data. - # Images are returned in a deterministic order; they are ordered by these - # factors, in order of - # importance: - # * First, by their associated test case. Images without a test case are - # considered greater than images with one. - # * Second, by their creation time. Images without a creation time are - # greater than images with one. - # * Third, by the order in which they were added to the step (by calls to - # CreateStep or UpdateStep). + # A list of image data. Images are returned in a deterministic order; they are + # ordered by these factors, in order of importance: * First, by their associated + # test case. Images without a test case are considered greater than images with + # one. * Second, by their creation time. Images without a creation time are + # greater than images with one. * Third, by the order in which they were added + # to the step (by calls to CreateStep or UpdateStep). # Corresponds to the JSON property `thumbnails` # @return [Array] attr_accessor :thumbnails @@ -1740,9 +1633,9 @@ module Google class ListStepsResponse include Google::Apis::Core::Hashable - # A continuation token to resume the query at the next item. - # If set, indicates that there are more steps to read, by calling list again - # with this value in the page_token field. + # A continuation token to resume the query at the next item. If set, indicates + # that there are more steps to read, by calling list again with this value in + # the page_token field. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1826,11 +1719,11 @@ module Google end end - # Merged test result for environment. - # If the environment has only one step (no reruns or shards), then the merged - # result is the same as the step result. If the environment has multiple shards - # and/or reruns, then the results of shards and reruns that belong to the same - # environment are merged into one environment result. + # Merged test result for environment. If the environment has only one step (no + # reruns or shards), then the merged result is the same as the step result. If + # the environment has multiple shards and/or reruns, then the results of shards + # and reruns that belong to the same environment are merged into one environment + # result. class MergedResult include Google::Apis::Core::Hashable @@ -1844,17 +1737,14 @@ module Google # @return [String] attr_accessor :state - # The combined and rolled-up result of each test suite that was run as part - # of this environment. - # Combining: - # When the test cases from a suite are run in different steps (sharding), - # the results are added back together in one overview. (e.g., if shard1 has - # 2 failures and shard2 has 1 failure than the overview failure_count = 3). - # Rollup: - # When test cases from the same suite are run multiple times (flaky), the - # results are combined (e.g., if testcase1.run1 fails, testcase1.run2 - # passes, and both testcase2.run1 and testcase2.run2 fail then the overview - # flaky_count = 1 and failure_count = 1). + # The combined and rolled-up result of each test suite that was run as part of + # this environment. Combining: When the test cases from a suite are run in + # different steps (sharding), the results are added back together in one + # overview. (e.g., if shard1 has 2 failures and shard2 has 1 failure than the + # overview failure_count = 3). Rollup: When test cases from the same suite are + # run multiple times (flaky), the results are combined (e.g., if testcase1.run1 + # fails, testcase1.run2 passes, and both testcase2.run1 and testcase2.run2 fail + # then the overview flaky_count = 1 and failure_count = 1). # Corresponds to the JSON property `testSuiteOverviews` # @return [Array] attr_accessor :test_suite_overviews @@ -1875,9 +1765,8 @@ module Google class MultiStep include Google::Apis::Core::Hashable - # Unique int given to each step. - # Ranges from 0(inclusive) to total number of steps(exclusive). - # The primary step is 0. + # Unique int given to each step. Ranges from 0(inclusive) to total number of + # steps(exclusive). The primary step is 0. # Corresponds to the JSON property `multistepNumber` # @return [Fixnum] attr_accessor :multistep_number @@ -1924,8 +1813,7 @@ module Google end end - # A non-sdk API and examples of it being called along with other metadata - # See + # A non-sdk API and examples of it being called along with other metadata See # https://developer.android.com/distribute/best-practices/develop/restrictions- # non-sdk-interfaces class NonSdkApi @@ -1974,20 +1862,20 @@ module Google class NonSdkApiInsight include Google::Apis::Core::Hashable - # Optional sample stack traces, for which this insight applies (there - # should be at least one). + # Optional sample stack traces, for which this insight applies (there should be + # at least one). # Corresponds to the JSON property `exampleTraceMessages` # @return [Array] attr_accessor :example_trace_messages - # A unique ID, to be used for determining the effectiveness of this - # particular insight in the context of a matcher. (required) + # A unique ID, to be used for determining the effectiveness of this particular + # insight in the context of a matcher. (required) # Corresponds to the JSON property `matcherId` # @return [String] attr_accessor :matcher_id - # This insight indicates that the hidden API usage originates from a - # Google-provided library. Users need not take any action. + # This insight indicates that the hidden API usage originates from a Google- + # provided library. Users need not take any action. # Corresponds to the JSON property `pendingGoogleUpdateInsight` # @return [Google::Apis::ToolresultsV1beta3::PendingGoogleUpdateInsight] attr_accessor :pending_google_update_insight @@ -2092,14 +1980,12 @@ module Google # @return [Google::Apis::ToolresultsV1beta3::SkippedDetail] attr_accessor :skipped_detail - # Details for an outcome with a SUCCESS outcome summary. - # LINT.IfChange + # Details for an outcome with a SUCCESS outcome summary. LINT.IfChange # Corresponds to the JSON property `successDetail` # @return [Google::Apis::ToolresultsV1beta3::SuccessDetail] attr_accessor :success_detail - # The simplest way to interpret a result. - # Required + # The simplest way to interpret a result. Required # Corresponds to the JSON property `summary` # @return [String] attr_accessor :summary @@ -2144,8 +2030,8 @@ module Google end end - # This insight indicates that the hidden API usage originates from a - # Google-provided library. Users need not take any action. + # This insight indicates that the hidden API usage originates from a Google- + # provided library. Users need not take any action. class PendingGoogleUpdateInsight include Google::Apis::Core::Hashable @@ -2198,23 +2084,19 @@ module Google # @return [Google::Apis::ToolresultsV1beta3::AppStartTime] attr_accessor :app_start_time - # A tool results execution ID. - # @OutputOnly + # A tool results execution ID. @OutputOnly # Corresponds to the JSON property `executionId` # @return [String] attr_accessor :execution_id - # Graphics statistics for the App. - # The information is collected from 'adb shell dumpsys graphicsstats'. - # For more info see: - # https://developer.android.com/training/testing/performance.html - # Statistics will only be present for API 23+. + # Graphics statistics for the App. The information is collected from 'adb shell + # dumpsys graphicsstats'. For more info see: https://developer.android.com/ + # training/testing/performance.html Statistics will only be present for API 23+. # Corresponds to the JSON property `graphicsStats` # @return [Google::Apis::ToolresultsV1beta3::GraphicsStats] attr_accessor :graphics_stats - # A tool results history ID. - # @OutputOnly + # A tool results history ID. @OutputOnly # Corresponds to the JSON property `historyId` # @return [String] attr_accessor :history_id @@ -2229,14 +2111,12 @@ module Google # @return [Array] attr_accessor :perf_metrics - # The cloud project - # @OutputOnly + # The cloud project @OutputOnly # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # A tool results step ID. - # @OutputOnly + # A tool results step ID. @OutputOnly # Corresponds to the JSON property `stepId` # @return [String] attr_accessor :step_id @@ -2263,16 +2143,15 @@ module Google include Google::Apis::Core::Hashable # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at - # nanosecond resolution. The count is relative to an epoch at UTC midnight on - # January 1, 1970, in the proleptic Gregorian calendar which extends the - # Gregorian calendar backwards to year one. - # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear - # smear](https://developers.google.com/time/smear). - # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC - # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. + # calendar, encoded as a count of seconds and fractions of seconds at nanosecond + # resolution. The count is relative to an epoch at UTC midnight on January 1, + # 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar + # backwards to year one. All minutes are 60 seconds long. Leap seconds are " + # smeared" so that no leap second table is needed for interpretation, using a [ + # 24-hour linear smear](https://developers.google.com/time/smear). The range is + # from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to + # that range, we ensure that we can convert to and from [RFC 3339](https://www. + # ietf.org/rfc/rfc3339.txt) date strings. # Corresponds to the JSON property `sampleTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :sample_time @@ -2302,32 +2181,27 @@ module Google # @return [Google::Apis::ToolresultsV1beta3::BasicPerfSampleSeries] attr_accessor :basic_perf_sample_series - # A tool results execution ID. - # @OutputOnly + # A tool results execution ID. @OutputOnly # Corresponds to the JSON property `executionId` # @return [String] attr_accessor :execution_id - # A tool results history ID. - # @OutputOnly + # A tool results history ID. @OutputOnly # Corresponds to the JSON property `historyId` # @return [String] attr_accessor :history_id - # The cloud project - # @OutputOnly + # The cloud project @OutputOnly # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # A sample series id - # @OutputOnly + # A sample series id @OutputOnly # Corresponds to the JSON property `sampleSeriesId` # @return [String] attr_accessor :sample_series_id - # A tool results step ID. - # @OutputOnly + # A tool results step ID. @OutputOnly # Corresponds to the JSON property `stepId` # @return [String] attr_accessor :step_id @@ -2389,8 +2263,8 @@ module Google # @return [Array] attr_accessor :individual_outcome - # Rollup test status of multiple steps that were run with the same - # configuration as a group. + # Rollup test status of multiple steps that were run with the same configuration + # as a group. # Corresponds to the JSON property `rollUp` # @return [String] attr_accessor :roll_up @@ -2410,19 +2284,14 @@ module Google class ProjectSettings include Google::Apis::Core::Hashable - # The name of the Google Cloud Storage bucket to which results are written. - # By default, this is unset. - # In update request: optional - # In response: optional + # The name of the Google Cloud Storage bucket to which results are written. By + # default, this is unset. In update request: optional In response: optional # Corresponds to the JSON property `defaultBucket` # @return [String] attr_accessor :default_bucket - # The name of the project's settings. - # Always of the form: - # projects/`project-id`/settings - # In update request: never set - # In response: always set + # The name of the project's settings. Always of the form: projects/`project-id`/ + # settings In update request: never set In response: always set # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2442,9 +2311,8 @@ module Google class PublishXunitXmlFilesRequest include Google::Apis::Core::Hashable - # URI of the Xunit XML files to publish. - # The maximum size of the file this reference is pointing to is 50MB. - # Required. + # URI of the Xunit XML files to publish. The maximum size of the file this + # reference is pointing to is 50MB. Required. # Corresponds to the JSON property `xunitXmlFiles` # @return [Array] attr_accessor :xunit_xml_files @@ -2463,26 +2331,22 @@ module Google class RegionProto include Google::Apis::Core::Hashable - # The height, in pixels. - # Always set. + # The height, in pixels. Always set. # Corresponds to the JSON property `heightPx` # @return [Fixnum] attr_accessor :height_px - # The left side of the rectangle, in pixels. - # Always set. + # The left side of the rectangle, in pixels. Always set. # Corresponds to the JSON property `leftPx` # @return [Fixnum] attr_accessor :left_px - # The top of the rectangle, in pixels. - # Always set. + # The top of the rectangle, in pixels. Always set. # Corresponds to the JSON property `topPx` # @return [Fixnum] attr_accessor :top_px - # The width, in pixels. - # Always set. + # The width, in pixels. Always set. # Corresponds to the JSON property `widthPx` # @return [Fixnum] attr_accessor :width_px @@ -2550,19 +2414,18 @@ module Google end end - # IMPORTANT: It is unsafe to accept this message from an untrusted source, - # since it's trivial for an attacker to forge serialized messages that - # don't fulfill the type's safety contract -- for example, it could contain - # attacker controlled script. A system which receives a SafeHtmlProto - # implicitly trusts the producer of the SafeHtmlProto. So, it's generally safe - # to return this message in RPC responses, but generally unsafe to accept it - # in RPC requests. + # IMPORTANT: It is unsafe to accept this message from an untrusted source, since + # it's trivial for an attacker to forge serialized messages that don't fulfill + # the type's safety contract -- for example, it could contain attacker + # controlled script. A system which receives a SafeHtmlProto implicitly trusts + # the producer of the SafeHtmlProto. So, it's generally safe to return this + # message in RPC responses, but generally unsafe to accept it in RPC requests. class SafeHtmlProto include Google::Apis::Core::Hashable - # IMPORTANT: Never set or read this field, even from tests, it is private. - # See documentation at the top of .proto file for programming language - # packages with which to create or read this message. + # IMPORTANT: Never set or read this field, even from tests, it is private. See + # documentation at the top of .proto file for programming language packages with + # which to create or read this message. # Corresponds to the JSON property `privateDoNotAccessOrElseSafeHtmlWrappedValue` # @return [String] attr_accessor :private_do_not_access_or_else_safe_html_wrapped_value @@ -2581,26 +2444,22 @@ module Google class Screen include Google::Apis::Core::Hashable - # File reference of the png file. - # Required. + # File reference of the png file. Required. # Corresponds to the JSON property `fileReference` # @return [String] attr_accessor :file_reference - # Locale of the device that the screenshot was taken on. - # Required. + # Locale of the device that the screenshot was taken on. Required. # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale - # Model of the device that the screenshot was taken on. - # Required. + # Model of the device that the screenshot was taken on. Required. # Corresponds to the JSON property `model` # @return [String] attr_accessor :model - # OS version of the device that the screenshot was taken on. - # Required. + # OS version of the device that the screenshot was taken on. Required. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -2627,16 +2486,15 @@ module Google # @return [String] attr_accessor :activity - # A unique identifier for the cluster. - # @OutputOnly + # A unique identifier for the cluster. @OutputOnly # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id - # A singular screen that represents the cluster as a whole. This screen will - # act as the "cover" of the entire cluster. When users look at the clusters, - # only the key screen from each cluster will be shown. Which screen is the - # key screen is determined by the ClusteringAlgorithm + # A singular screen that represents the cluster as a whole. This screen will act + # as the "cover" of the entire cluster. When users look at the clusters, only + # the key screen from each cluster will be shown. Which screen is the key screen + # is determined by the ClusteringAlgorithm # Corresponds to the JSON property `keyScreen` # @return [Google::Apis::ToolresultsV1beta3::Screen] attr_accessor :key_screen @@ -2663,18 +2521,18 @@ module Google class ShardSummary include Google::Apis::Core::Hashable - # Summaries of the steps belonging to the shard. - # With flaky_test_attempts enabled from TestExecutionService, more than one - # run (Step) can present. And the runs will be sorted by multistep_number. + # Summaries of the steps belonging to the shard. With flaky_test_attempts + # enabled from TestExecutionService, more than one run (Step) can present. And + # the runs will be sorted by multistep_number. # Corresponds to the JSON property `runs` # @return [Array] attr_accessor :runs - # Merged test result for environment. - # If the environment has only one step (no reruns or shards), then the merged - # result is the same as the step result. If the environment has multiple shards - # and/or reruns, then the results of shards and reruns that belong to the same - # environment are merged into one environment result. + # Merged test result for environment. If the environment has only one step (no + # reruns or shards), then the merged result is the same as the step result. If + # the environment has multiple shards and/or reruns, then the results of shards + # and reruns that belong to the same environment are merged into one environment + # result. # Corresponds to the JSON property `shardResult` # @return [Google::Apis::ToolresultsV1beta3::MergedResult] attr_accessor :shard_result @@ -2753,8 +2611,7 @@ module Google class StackTrace include Google::Apis::Core::Hashable - # The stack trace message. - # Required + # The stack trace message. Required # Corresponds to the JSON property `exception` # @return [String] attr_accessor :exception @@ -2794,12 +2651,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 @@ -2808,15 +2665,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 @@ -2833,121 +2690,103 @@ module Google end end - # A Step represents a single operation performed as part of - # Execution. A step can be used to represent the execution of a tool ( - # for example a test runner execution or an execution of a compiler). - # Steps can overlap (for instance two steps might have the same - # start time if some operations are done in parallel). + # A Step represents a single operation performed as part of Execution. A step + # can be used to represent the execution of a tool ( for example a test runner + # execution or an execution of a compiler). Steps can overlap (for instance two + # steps might have the same start time if some operations are done in parallel). # Here is an example, let's consider that we have a continuous build is - # executing a test runner for each iteration. The workflow would look like: - # - user creates a Execution with id 1 - # - user creates an TestExecutionStep with id 100 for Execution 1 - # - user update TestExecutionStep with id 100 to add a raw xml log - # + the service parses the xml logs and returns a TestExecutionStep with - # updated TestResult(s). - # - user update the status of TestExecutionStep with id 100 to COMPLETE - # A Step can be updated until its state is set to COMPLETE at which - # points it becomes immutable. - # Next tag: 27 + # executing a test runner for each iteration. The workflow would look like: - + # user creates a Execution with id 1 - user creates an TestExecutionStep with id + # 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw + # xml log + the service parses the xml logs and returns a TestExecutionStep with + # updated TestResult(s). - user update the status of TestExecutionStep with id + # 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at + # which points it becomes immutable. Next tag: 27 class Step include Google::Apis::Core::Hashable # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at - # nanosecond resolution. The count is relative to an epoch at UTC midnight on - # January 1, 1970, in the proleptic Gregorian calendar which extends the - # Gregorian calendar backwards to year one. - # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear - # smear](https://developers.google.com/time/smear). - # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC - # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. + # calendar, encoded as a count of seconds and fractions of seconds at nanosecond + # resolution. The count is relative to an epoch at UTC midnight on January 1, + # 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar + # backwards to year one. All minutes are 60 seconds long. Leap seconds are " + # smeared" so that no leap second table is needed for interpretation, using a [ + # 24-hour linear smear](https://developers.google.com/time/smear). The range is + # from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to + # that range, we ensure that we can convert to and from [RFC 3339](https://www. + # ietf.org/rfc/rfc3339.txt) date strings. # Corresponds to the JSON property `completionTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :completion_time # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at - # nanosecond resolution. The count is relative to an epoch at UTC midnight on - # January 1, 1970, in the proleptic Gregorian calendar which extends the - # Gregorian calendar backwards to year one. - # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear - # smear](https://developers.google.com/time/smear). - # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC - # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. + # calendar, encoded as a count of seconds and fractions of seconds at nanosecond + # resolution. The count is relative to an epoch at UTC midnight on January 1, + # 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar + # backwards to year one. All minutes are 60 seconds long. Leap seconds are " + # smeared" so that no leap second table is needed for interpretation, using a [ + # 24-hour linear smear](https://developers.google.com/time/smear). The range is + # from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to + # that range, we ensure that we can convert to and from [RFC 3339](https://www. + # ietf.org/rfc/rfc3339.txt) date strings. # Corresponds to the JSON property `creationTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :creation_time - # A description of this tool - # For example: mvn clean package -D skipTests=true - # - In response: present if set by create/update request - # - In create/update request: optional + # A description of this tool For example: mvn clean package -D skipTests=true - + # In response: present if set by create/update request - In create/update + # request: optional # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # A Duration represents a signed, fixed-length span of time represented - # as a count of seconds and fractions of seconds at nanosecond - # resolution. It is independent of any calendar and concepts like "day" - # or "month". It is related to Timestamp in that the difference between - # two Timestamp values is a Duration and it can be added or subtracted - # from a Timestamp. Range is approximately +-10,000 years. + # A Duration represents a signed, fixed-length span of time represented as a + # count of seconds and fractions of seconds at nanosecond resolution. It is + # independent of any calendar and concepts like "day" or "month". It is related + # to Timestamp in that the difference between two Timestamp values is a Duration + # and it can be added or subtracted from a Timestamp. Range is approximately +- + # 10,000 years. # Corresponds to the JSON property `deviceUsageDuration` # @return [Google::Apis::ToolresultsV1beta3::Duration] attr_accessor :device_usage_duration - # If the execution containing this step has any dimension_definition set, - # then this field allows the child to specify the values of the dimensions. - # The keys must exactly match the dimension_definition of the execution. - # For example, if the execution has - # `dimension_definition = ['attempt', 'device']` - # then a step must define values for those dimensions, eg. - # `dimension_value = ['attempt': '1', 'device': 'Nexus 6']` - # If a step does not participate in one dimension of the matrix, - # the value for that dimension should be empty string. - # For example, if one of the tests is executed by a runner which - # does not support retries, the step could have - # `dimension_value = ['attempt': '', 'device': 'Nexus 6']` - # If the step does not participate in any dimensions of the matrix, - # it may leave dimension_value unset. - # A PRECONDITION_FAILED will be returned if any of the keys do not exist - # in the dimension_definition of the execution. - # A PRECONDITION_FAILED will be returned if another step in this execution - # already has the same name and dimension_value, but differs on other data - # fields, for example, step field is different. - # A PRECONDITION_FAILED will be returned if dimension_value is set, and - # there is a dimension_definition in the execution which is not specified - # as one of the keys. - # - In response: present if set by create - # - In create request: optional - # - In update request: never set + # If the execution containing this step has any dimension_definition set, then + # this field allows the child to specify the values of the dimensions. The keys + # must exactly match the dimension_definition of the execution. For example, if + # the execution has `dimension_definition = ['attempt', 'device']` then a step + # must define values for those dimensions, eg. `dimension_value = ['attempt': '1' + # , 'device': 'Nexus 6']` If a step does not participate in one dimension of the + # matrix, the value for that dimension should be empty string. For example, if + # one of the tests is executed by a runner which does not support retries, the + # step could have `dimension_value = ['attempt': '', 'device': 'Nexus 6']` If + # the step does not participate in any dimensions of the matrix, it may leave + # dimension_value unset. A PRECONDITION_FAILED will be returned if any of the + # keys do not exist in the dimension_definition of the execution. A + # PRECONDITION_FAILED will be returned if another step in this execution already + # has the same name and dimension_value, but differs on other data fields, for + # example, step field is different. A PRECONDITION_FAILED will be returned if + # dimension_value is set, and there is a dimension_definition in the execution + # which is not specified as one of the keys. - In response: present if set by + # create - In create request: optional - In update request: never set # Corresponds to the JSON property `dimensionValue` # @return [Array] attr_accessor :dimension_value - # Whether any of the outputs of this step are images whose - # thumbnails can be fetched with ListThumbnails. - # - In response: always set - # - In create/update request: never set + # Whether any of the outputs of this step are images whose thumbnails can be + # fetched with ListThumbnails. - In response: always set - In create/update + # request: never set # Corresponds to the JSON property `hasImages` # @return [Boolean] attr_accessor :has_images alias_method :has_images?, :has_images - # Arbitrary user-supplied key/value pairs that are associated with the - # step. - # Users are responsible for managing the key namespace such that keys - # don't accidentally collide. - # An INVALID_ARGUMENT will be returned if the number of labels exceeds 100 or - # if the length of any of the keys or values exceeds 100 characters. - # - In response: always set - # - In create request: optional - # - In update request: optional; any new key/value pair will be added to the - # map, and any new value for an existing key will update that key's value + # Arbitrary user-supplied key/value pairs that are associated with the step. + # Users are responsible for managing the key namespace such that keys don't + # accidentally collide. An INVALID_ARGUMENT will be returned if the number of + # labels exceeds 100 or if the length of any of the keys or values exceeds 100 + # characters. - In response: always set - In create request: optional - In + # update request: optional; any new key/value pair will be added to the map, and + # any new value for an existing key will update that key's value # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels @@ -2957,17 +2796,14 @@ module Google # @return [Google::Apis::ToolresultsV1beta3::MultiStep] attr_accessor :multi_step - # A short human-readable name to display in the UI. - # Maximum of 100 characters. - # For example: Clean build - # A PRECONDITION_FAILED will be returned upon creating a new step if it - # shares its name and dimension_value with an existing step. If two steps - # represent a similar action, but have different dimension values, they - # should share the same name. For instance, if the same set of tests is - # run on two different platforms, the two steps should have the same name. - # - In response: always set - # - In create request: always set - # - In update request: never set + # A short human-readable name to display in the UI. Maximum of 100 characters. + # For example: Clean build A PRECONDITION_FAILED will be returned upon creating + # a new step if it shares its name and dimension_value with an existing step. If + # two steps represent a similar action, but have different dimension values, + # they should share the same name. For instance, if the same set of tests is run + # on two different platforms, the two steps should have the same name. - In + # response: always set - In create request: always set - In update request: + # never set # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2977,49 +2813,43 @@ module Google # @return [Google::Apis::ToolresultsV1beta3::Outcome] attr_accessor :outcome - # A Duration represents a signed, fixed-length span of time represented - # as a count of seconds and fractions of seconds at nanosecond - # resolution. It is independent of any calendar and concepts like "day" - # or "month". It is related to Timestamp in that the difference between - # two Timestamp values is a Duration and it can be added or subtracted - # from a Timestamp. Range is approximately +-10,000 years. + # A Duration represents a signed, fixed-length span of time represented as a + # count of seconds and fractions of seconds at nanosecond resolution. It is + # independent of any calendar and concepts like "day" or "month". It is related + # to Timestamp in that the difference between two Timestamp values is a Duration + # and it can be added or subtracted from a Timestamp. Range is approximately +- + # 10,000 years. # Corresponds to the JSON property `runDuration` # @return [Google::Apis::ToolresultsV1beta3::Duration] attr_accessor :run_duration - # The initial state is IN_PROGRESS. - # The only legal state transitions are - # * IN_PROGRESS -> COMPLETE - # A PRECONDITION_FAILED will be returned if an invalid transition is - # requested. - # It is valid to create Step with a state set to COMPLETE. - # The state can only be set to COMPLETE once. A PRECONDITION_FAILED will be - # returned if the state is set to COMPLETE multiple times. - # - In response: always set - # - In create/update request: optional + # The initial state is IN_PROGRESS. The only legal state transitions are * + # IN_PROGRESS -> COMPLETE A PRECONDITION_FAILED will be returned if an invalid + # transition is requested. It is valid to create Step with a state set to + # COMPLETE. The state can only be set to COMPLETE once. A PRECONDITION_FAILED + # will be returned if the state is set to COMPLETE multiple times. - In response: + # always set - In create/update request: optional # Corresponds to the JSON property `state` # @return [String] attr_accessor :state - # A unique identifier within a Execution for this Step. - # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - # - In response: always set - # - In create/update request: never set + # A unique identifier within a Execution for this Step. Returns INVALID_ARGUMENT + # if this field is set or overwritten by the caller. - In response: always set - + # In create/update request: never set # Corresponds to the JSON property `stepId` # @return [String] attr_accessor :step_id - # A step that represents running tests. - # It accepts ant-junit xml files which will be parsed into structured test - # results by the service. Xml file paths are updated in order to append more - # files, however they can't be deleted. - # Users can also add test results manually by using the test_result field. + # A step that represents running tests. It accepts ant-junit xml files which + # will be parsed into structured test results by the service. Xml file paths are + # updated in order to append more files, however they can't be deleted. Users + # can also add test results manually by using the test_result field. # Corresponds to the JSON property `testExecutionStep` # @return [Google::Apis::ToolresultsV1beta3::TestExecutionStep] attr_accessor :test_execution_step - # Generic tool step to be used for binaries we do not explicitly support. - # For example: running cp to copy artifacts from one location to another. + # Generic tool step to be used for binaries we do not explicitly support. For + # example: running cp to copy artifacts from one location to another. # Corresponds to the JSON property `toolExecutionStep` # @return [Google::Apis::ToolresultsV1beta3::ToolExecutionStep] attr_accessor :tool_execution_step @@ -3111,8 +2941,7 @@ module Google end end - # Details for an outcome with a SUCCESS outcome summary. - # LINT.IfChange + # Details for an outcome with a SUCCESS outcome summary. LINT.IfChange class SuccessDetail include Google::Apis::Core::Hashable @@ -3132,21 +2961,19 @@ module Google end end - # A set of similar suggestions that we suspect are closely related. - # This proto and most of the nested protos are branched from - # foxandcrown.prelaunchreport.service.SuggestionClusterProto, replacing PLR's - # dependencies with FTL's. + # A set of similar suggestions that we suspect are closely related. This proto + # and most of the nested protos are branched from foxandcrown.prelaunchreport. + # service.SuggestionClusterProto, replacing PLR's dependencies with FTL's. class SuggestionClusterProto include Google::Apis::Core::Hashable - # Category in which these types of suggestions should appear. - # Always set. + # Category in which these types of suggestions should appear. Always set. # Corresponds to the JSON property `category` # @return [String] attr_accessor :category - # A sequence of suggestions. All of the suggestions within a cluster must - # have the same SuggestionPriority and belong to the same SuggestionCategory. + # A sequence of suggestions. All of the suggestions within a cluster must have + # the same SuggestionPriority and belong to the same SuggestionCategory. # Suggestions with the same screenshot URL should be adjacent. # Corresponds to the JSON property `suggestions` # @return [Array] @@ -3167,32 +2994,30 @@ module Google class SuggestionProto include Google::Apis::Core::Hashable - # Reference to a help center article concerning this type of suggestion. - # Always set. + # Reference to a help center article concerning this type of suggestion. Always + # set. # Corresponds to the JSON property `helpUrl` # @return [String] attr_accessor :help_url - # IMPORTANT: It is unsafe to accept this message from an untrusted source, - # since it's trivial for an attacker to forge serialized messages that - # don't fulfill the type's safety contract -- for example, it could contain - # attacker controlled script. A system which receives a SafeHtmlProto - # implicitly trusts the producer of the SafeHtmlProto. So, it's generally safe - # to return this message in RPC responses, but generally unsafe to accept it - # in RPC requests. + # IMPORTANT: It is unsafe to accept this message from an untrusted source, since + # it's trivial for an attacker to forge serialized messages that don't fulfill + # the type's safety contract -- for example, it could contain attacker + # controlled script. A system which receives a SafeHtmlProto implicitly trusts + # the producer of the SafeHtmlProto. So, it's generally safe to return this + # message in RPC responses, but generally unsafe to accept it in RPC requests. # Corresponds to the JSON property `longMessage` # @return [Google::Apis::ToolresultsV1beta3::SafeHtmlProto] attr_accessor :long_message - # Relative importance of a suggestion. - # Always set. + # Relative importance of a suggestion. Always set. # Corresponds to the JSON property `priority` # @return [String] attr_accessor :priority - # A somewhat human readable identifier of the source view, if it does not - # have a resource_name. This is a path within the accessibility hierarchy, - # an element with resource name; similar to an XPath. + # A somewhat human readable identifier of the source view, if it does not have a + # resource_name. This is a path within the accessibility hierarchy, an element + # with resource name; similar to an XPath. # Corresponds to the JSON property `pseudoResourceId` # @return [String] attr_accessor :pseudo_resource_id @@ -3202,37 +3027,33 @@ module Google # @return [Google::Apis::ToolresultsV1beta3::RegionProto] attr_accessor :region - # Reference to a view element, identified by its resource name, if it has - # one. + # Reference to a view element, identified by its resource name, if it has one. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name - # ID of the screen for the suggestion. - # It is used for getting the corresponding screenshot path. For example, - # screen_id "1" corresponds to "1.png" file in GCS. + # ID of the screen for the suggestion. It is used for getting the corresponding + # screenshot path. For example, screen_id "1" corresponds to "1.png" file in GCS. # Always set. # Corresponds to the JSON property `screenId` # @return [String] attr_accessor :screen_id - # Relative importance of a suggestion as compared with other suggestions - # that have the same priority and category. - # This is a meaningless value that can be used to order suggestions that are - # in the same category and have the same priority. - # The larger values have higher priority (i.e., are more important). + # Relative importance of a suggestion as compared with other suggestions that + # have the same priority and category. This is a meaningless value that can be + # used to order suggestions that are in the same category and have the same + # priority. The larger values have higher priority (i.e., are more important). # Optional. # Corresponds to the JSON property `secondaryPriority` # @return [Float] attr_accessor :secondary_priority - # IMPORTANT: It is unsafe to accept this message from an untrusted source, - # since it's trivial for an attacker to forge serialized messages that - # don't fulfill the type's safety contract -- for example, it could contain - # attacker controlled script. A system which receives a SafeHtmlProto - # implicitly trusts the producer of the SafeHtmlProto. So, it's generally safe - # to return this message in RPC responses, but generally unsafe to accept it - # in RPC requests. + # IMPORTANT: It is unsafe to accept this message from an untrusted source, since + # it's trivial for an attacker to forge serialized messages that don't fulfill + # the type's safety contract -- for example, it could contain attacker + # controlled script. A system which receives a SafeHtmlProto implicitly trusts + # the producer of the SafeHtmlProto. So, it's generally safe to return this + # message in RPC responses, but generally unsafe to accept it in RPC requests. # Corresponds to the JSON property `shortMessage` # @return [Google::Apis::ToolresultsV1beta3::SafeHtmlProto] attr_accessor :short_message @@ -3266,62 +3087,57 @@ module Google class TestCase include Google::Apis::Core::Hashable - # A Duration represents a signed, fixed-length span of time represented - # as a count of seconds and fractions of seconds at nanosecond - # resolution. It is independent of any calendar and concepts like "day" - # or "month". It is related to Timestamp in that the difference between - # two Timestamp values is a Duration and it can be added or subtracted - # from a Timestamp. Range is approximately +-10,000 years. + # A Duration represents a signed, fixed-length span of time represented as a + # count of seconds and fractions of seconds at nanosecond resolution. It is + # independent of any calendar and concepts like "day" or "month". It is related + # to Timestamp in that the difference between two Timestamp values is a Duration + # and it can be added or subtracted from a Timestamp. Range is approximately +- + # 10,000 years. # Corresponds to the JSON property `elapsedTime` # @return [Google::Apis::ToolresultsV1beta3::Duration] attr_accessor :elapsed_time # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at - # nanosecond resolution. The count is relative to an epoch at UTC midnight on - # January 1, 1970, in the proleptic Gregorian calendar which extends the - # Gregorian calendar backwards to year one. - # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear - # smear](https://developers.google.com/time/smear). - # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC - # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. + # calendar, encoded as a count of seconds and fractions of seconds at nanosecond + # resolution. The count is relative to an epoch at UTC midnight on January 1, + # 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar + # backwards to year one. All minutes are 60 seconds long. Leap seconds are " + # smeared" so that no leap second table is needed for interpretation, using a [ + # 24-hour linear smear](https://developers.google.com/time/smear). The range is + # from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to + # that range, we ensure that we can convert to and from [RFC 3339](https://www. + # ietf.org/rfc/rfc3339.txt) date strings. # Corresponds to the JSON property `endTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :end_time - # Why the test case was skipped. - # Present only for skipped test case + # Why the test case was skipped. Present only for skipped test case # Corresponds to the JSON property `skippedMessage` # @return [String] attr_accessor :skipped_message - # The stack trace details if the test case failed or encountered an error. - # The maximum size of the stack traces is 100KiB, beyond which the stack - # track will be truncated. - # Zero if the test case passed. + # The stack trace details if the test case failed or encountered an error. The + # maximum size of the stack traces is 100KiB, beyond which the stack track will + # be truncated. Zero if the test case passed. # Corresponds to the JSON property `stackTraces` # @return [Array] attr_accessor :stack_traces # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at - # nanosecond resolution. The count is relative to an epoch at UTC midnight on - # January 1, 1970, in the proleptic Gregorian calendar which extends the - # Gregorian calendar backwards to year one. - # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear - # smear](https://developers.google.com/time/smear). - # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC - # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. + # calendar, encoded as a count of seconds and fractions of seconds at nanosecond + # resolution. The count is relative to an epoch at UTC midnight on January 1, + # 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar + # backwards to year one. All minutes are 60 seconds long. Leap seconds are " + # smeared" so that no leap second table is needed for interpretation, using a [ + # 24-hour linear smear](https://developers.google.com/time/smear). The range is + # from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to + # that range, we ensure that we can convert to and from [RFC 3339](https://www. + # ietf.org/rfc/rfc3339.txt) date strings. # Corresponds to the JSON property `startTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :start_time - # The status of the test case. - # Required. + # The status of the test case. Required. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -3331,18 +3147,15 @@ module Google # @return [String] attr_accessor :test_case_id - # A reference to a test case. - # Test case references are canonically ordered lexicographically by these three - # factors: - # * First, by test_suite_name. - # * Second, by class_name. - # * Third, by name. + # A reference to a test case. Test case references are canonically ordered + # lexicographically by these three factors: * First, by test_suite_name. * + # Second, by class_name. * Third, by name. # Corresponds to the JSON property `testCaseReference` # @return [Google::Apis::ToolresultsV1beta3::TestCaseReference] attr_accessor :test_case_reference - # References to opaque files of any format output by the tool execution. - # @OutputOnly + # References to opaque files of any format output by the tool execution. @ + # OutputOnly # Corresponds to the JSON property `toolOutputs` # @return [Array] attr_accessor :tool_outputs @@ -3365,12 +3178,9 @@ module Google end end - # A reference to a test case. - # Test case references are canonically ordered lexicographically by these three - # factors: - # * First, by test_suite_name. - # * Second, by class_name. - # * Third, by name. + # A reference to a test case. Test case references are canonically ordered + # lexicographically by these three factors: * First, by test_suite_name. * + # Second, by class_name. * Third, by name. class TestCaseReference include Google::Apis::Core::Hashable @@ -3379,8 +3189,7 @@ module Google # @return [String] attr_accessor :class_name - # The name of the test case. - # Required. + # The name of the test case. Required. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3402,31 +3211,27 @@ module Google end end - # A step that represents running tests. - # It accepts ant-junit xml files which will be parsed into structured test - # results by the service. Xml file paths are updated in order to append more - # files, however they can't be deleted. - # Users can also add test results manually by using the test_result field. + # A step that represents running tests. It accepts ant-junit xml files which + # will be parsed into structured test results by the service. Xml file paths are + # updated in order to append more files, however they can't be deleted. Users + # can also add test results manually by using the test_result field. class TestExecutionStep include Google::Apis::Core::Hashable - # Issues observed during the test execution. - # For example, if the mobile app under test crashed during the test, - # the error message and the stack trace content can be recorded here - # to assist debugging. - # - In response: present if set by create or update - # - In create/update request: optional + # Issues observed during the test execution. For example, if the mobile app + # under test crashed during the test, the error message and the stack trace + # content can be recorded here to assist debugging. - In response: present if + # set by create or update - In create/update request: optional # Corresponds to the JSON property `testIssues` # @return [Array] attr_accessor :test_issues - # List of test suite overview contents. This could be parsed from xUnit XML - # log by server, or uploaded directly by user. This references should only be - # called when test suites are fully parsed or uploaded. - # The maximum allowed number of test suite overviews per step is 1000. - # - In response: always set - # - In create request: optional - # - In update request: never (use publishXunitXmlFiles custom method instead) + # List of test suite overview contents. This could be parsed from xUnit XML log + # by server, or uploaded directly by user. This references should only be called + # when test suites are fully parsed or uploaded. The maximum allowed number of + # test suite overviews per step is 1000. - In response: always set - In create + # request: optional - In update request: never (use publishXunitXmlFiles custom + # method instead) # Corresponds to the JSON property `testSuiteOverviews` # @return [Array] attr_accessor :test_suite_overviews @@ -3436,8 +3241,8 @@ module Google # @return [Google::Apis::ToolresultsV1beta3::TestTiming] attr_accessor :test_timing - # An execution of an arbitrary tool. It could be a test runner or a tool - # copying artifacts or deploying code. + # An execution of an arbitrary tool. It could be a test runner or a tool copying + # artifacts or deploying code. # Corresponds to the JSON property `toolExecution` # @return [Google::Apis::ToolresultsV1beta3::ToolExecution] attr_accessor :tool_execution @@ -3459,20 +3264,17 @@ module Google class TestIssue include Google::Apis::Core::Hashable - # Category of issue. - # Required. + # Category of issue. Required. # Corresponds to the JSON property `category` # @return [String] attr_accessor :category - # A brief human-readable message describing the issue. - # Required. + # A brief human-readable message describing the issue. Required. # Corresponds to the JSON property `errorMessage` # @return [String] attr_accessor :error_message - # Severity of issue. - # Required. + # Severity of issue. Required. # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity @@ -3482,74 +3284,35 @@ module Google # @return [Google::Apis::ToolresultsV1beta3::StackTrace] attr_accessor :stack_trace - # Type of issue. - # Required. + # Type of issue. Required. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # `Any` contains an arbitrary serialized protocol buffer message along with a - # URL that describes the type of the serialized message. - # Protobuf library provides support to pack/unpack Any values in the form - # of utility functions or additional generated methods of the Any type. - # Example 1: Pack and unpack a message in C++. - # Foo foo = ...; - # Any any; - # any.PackFrom(foo); - # ... - # if (any.UnpackTo(&foo)) ` - # ... - # ` - # Example 2: Pack and unpack a message in Java. - # Foo foo = ...; - # Any any = Any.pack(foo); - # ... - # if (any.is(Foo.class)) ` - # foo = any.unpack(Foo.class); - # ` - # Example 3: Pack and unpack a message in Python. - # foo = Foo(...) - # any = Any() - # any.Pack(foo) - # ... - # if any.Is(Foo.DESCRIPTOR): - # any.Unpack(foo) - # ... - # Example 4: Pack and unpack a message in Go - # foo := &pb.Foo`...` - # any, err := ptypes.MarshalAny(foo) - # ... - # foo := &pb.Foo`` - # if err := ptypes.UnmarshalAny(any, foo); err != nil ` - # ... - # ` - # The pack methods provided by protobuf library will by default use - # 'type.googleapis.com/full.type.name' as the type URL and the unpack - # methods only use the fully qualified type name after the last '/' - # in the type URL, for example "foo.bar.com/x/y.z" will yield type - # name "y.z". - # # JSON - # The JSON representation of an `Any` value uses the regular - # representation of the deserialized, embedded message, with an - # additional field `@type` which contains the type URL. Example: - # package google.profile; - # message Person ` - # string first_name = 1; - # string last_name = 2; - # ` - # ` - # "@type": "type.googleapis.com/google.profile.Person", - # "firstName": , - # "lastName": - # ` - # If the embedded message type is well-known and has a custom JSON - # representation, that representation will be embedded adding a field - # `value` which holds the custom JSON in addition to the `@type` - # field. Example (for message google.protobuf.Duration): - # ` - # "@type": "type.googleapis.com/google.protobuf.Duration", - # "value": "1.212s" - # ` + # URL that describes the type of the serialized message. Protobuf library + # provides support to pack/unpack Any values in the form of utility functions or + # additional generated methods of the Any type. Example 1: Pack and unpack a + # message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any. + # UnpackTo(&foo)) ` ... ` Example 2: Pack and unpack a message in Java. Foo foo = + # ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) ` foo = any.unpack( + # Foo.class); ` Example 3: Pack and unpack a message in Python. foo = Foo(...) + # any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... + # Example 4: Pack and unpack a message in Go foo := &pb.Foo`...` any, err := + # ptypes.MarshalAny(foo) ... foo := &pb.Foo`` if err := ptypes.UnmarshalAny(any, + # foo); err != nil ` ... ` The pack methods provided by protobuf library will by + # default use 'type.googleapis.com/full.type.name' as the type URL and the + # unpack methods only use the fully qualified type name after the last '/' in + # the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". # + # JSON The JSON representation of an `Any` value uses the regular representation + # of the deserialized, embedded message, with an additional field `@type` which + # contains the type URL. Example: package google.profile; message Person ` + # string first_name = 1; string last_name = 2; ` ` "@type": "type.googleapis.com/ + # google.profile.Person", "firstName": , "lastName": ` If the embedded message + # type is well-known and has a custom JSON representation, that representation + # will be embedded adding a field `value` which holds the custom JSON in + # addition to the `@type` field. Example (for message google.protobuf.Duration): + # ` "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" ` # Corresponds to the JSON property `warning` # @return [Google::Apis::ToolresultsV1beta3::Any] attr_accessor :warning @@ -3569,67 +3332,57 @@ module Google end end - # A summary of a test suite result either parsed from XML or uploaded - # directly by a user. - # Note: the API related comments are for StepService only. This message is - # also being used in ExecutionService in a read only mode for the corresponding - # step. + # A summary of a test suite result either parsed from XML or uploaded directly + # by a user. Note: the API related comments are for StepService only. This + # message is also being used in ExecutionService in a read only mode for the + # corresponding step. class TestSuiteOverview include Google::Apis::Core::Hashable - # A Duration represents a signed, fixed-length span of time represented - # as a count of seconds and fractions of seconds at nanosecond - # resolution. It is independent of any calendar and concepts like "day" - # or "month". It is related to Timestamp in that the difference between - # two Timestamp values is a Duration and it can be added or subtracted - # from a Timestamp. Range is approximately +-10,000 years. + # A Duration represents a signed, fixed-length span of time represented as a + # count of seconds and fractions of seconds at nanosecond resolution. It is + # independent of any calendar and concepts like "day" or "month". It is related + # to Timestamp in that the difference between two Timestamp values is a Duration + # and it can be added or subtracted from a Timestamp. Range is approximately +- + # 10,000 years. # Corresponds to the JSON property `elapsedTime` # @return [Google::Apis::ToolresultsV1beta3::Duration] attr_accessor :elapsed_time # Number of test cases in error, typically set by the service by parsing the - # xml_source. - # - In create/response: always set - # - In update request: never + # xml_source. - In create/response: always set - In update request: never # Corresponds to the JSON property `errorCount` # @return [Fixnum] attr_accessor :error_count # Number of failed test cases, typically set by the service by parsing the - # xml_source. May also be set by the user. - # - In create/response: always set - # - In update request: never + # xml_source. May also be set by the user. - In create/response: always set - In + # update request: never # Corresponds to the JSON property `failureCount` # @return [Fixnum] attr_accessor :failure_count # Number of flaky test cases, set by the service by rolling up flaky test - # attempts. - # Present only for rollup test suite overview at environment level. A step - # cannot have flaky test cases. + # attempts. Present only for rollup test suite overview at environment level. A + # step cannot have flaky test cases. # Corresponds to the JSON property `flakyCount` # @return [Fixnum] attr_accessor :flaky_count - # The name of the test suite. - # - In create/response: always set - # - In update request: never + # The name of the test suite. - In create/response: always set - In update + # request: never # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Number of test cases not run, typically set by the service by parsing the - # xml_source. - # - In create/response: always set - # - In update request: never + # xml_source. - In create/response: always set - In update request: never # Corresponds to the JSON property `skippedCount` # @return [Fixnum] attr_accessor :skipped_count - # Number of test cases, typically set by the service by parsing the - # xml_source. - # - In create/response: always set - # - In update request: never + # Number of test cases, typically set by the service by parsing the xml_source. - + # In create/response: always set - In update request: never # Corresponds to the JSON property `totalCount` # @return [Fixnum] attr_accessor :total_count @@ -3660,12 +3413,12 @@ module Google class TestTiming include Google::Apis::Core::Hashable - # A Duration represents a signed, fixed-length span of time represented - # as a count of seconds and fractions of seconds at nanosecond - # resolution. It is independent of any calendar and concepts like "day" - # or "month". It is related to Timestamp in that the difference between - # two Timestamp values is a Duration and it can be added or subtracted - # from a Timestamp. Range is approximately +-10,000 years. + # A Duration represents a signed, fixed-length span of time represented as a + # count of seconds and fractions of seconds at nanosecond resolution. It is + # independent of any calendar and concepts like "day" or "month". It is related + # to Timestamp in that the difference between two Timestamp values is a Duration + # and it can be added or subtracted from a Timestamp. Range is approximately +- + # 10,000 years. # Corresponds to the JSON property `testProcessDuration` # @return [Google::Apis::ToolresultsV1beta3::Duration] attr_accessor :test_process_duration @@ -3684,30 +3437,25 @@ module Google class Thumbnail include Google::Apis::Core::Hashable - # The thumbnail's content type, i.e. "image/png". - # Always set. + # The thumbnail's content type, i.e. "image/png". Always set. # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type - # The thumbnail file itself. - # That is, the bytes here are precisely the bytes that make up the thumbnail - # file; they can be served as an image as-is (with the appropriate content - # type.) - # Always set. + # The thumbnail file itself. That is, the bytes here are precisely the bytes + # that make up the thumbnail file; they can be served as an image as-is (with + # the appropriate content type.) Always set. # Corresponds to the JSON property `data` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :data - # The height of the thumbnail, in pixels. - # Always set. + # The height of the thumbnail, in pixels. Always set. # Corresponds to the JSON property `heightPx` # @return [Fixnum] attr_accessor :height_px - # The width of the thumbnail, in pixels. - # Always set. + # The width of the thumbnail, in pixels. Always set. # Corresponds to the JSON property `widthPx` # @return [Fixnum] attr_accessor :width_px @@ -3726,30 +3474,27 @@ module Google end # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at - # nanosecond resolution. The count is relative to an epoch at UTC midnight on - # January 1, 1970, in the proleptic Gregorian calendar which extends the - # Gregorian calendar backwards to year one. - # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear - # smear](https://developers.google.com/time/smear). - # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC - # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. + # calendar, encoded as a count of seconds and fractions of seconds at nanosecond + # resolution. The count is relative to an epoch at UTC midnight on January 1, + # 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar + # backwards to year one. All minutes are 60 seconds long. Leap seconds are " + # smeared" so that no leap second table is needed for interpretation, using a [ + # 24-hour linear smear](https://developers.google.com/time/smear). The range is + # from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to + # that range, we ensure that we can convert to and from [RFC 3339](https://www. + # ietf.org/rfc/rfc3339.txt) date strings. class Timestamp include Google::Apis::Core::Hashable - # Non-negative fractions of a second at nanosecond resolution. Negative - # second values with fractions must still have non-negative nanos values - # that count forward in time. Must be from 0 to 999,999,999 - # inclusive. + # Non-negative fractions of a second at nanosecond resolution. Negative second + # values with fractions must still have non-negative nanos values that count + # forward in time. Must be from 0 to 999,999,999 inclusive. # Corresponds to the JSON property `nanos` # @return [Fixnum] attr_accessor :nanos - # Represents seconds of UTC time since Unix epoch - # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to - # 9999-12-31T23:59:59Z inclusive. + # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be + # from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. # Corresponds to the JSON property `seconds` # @return [Fixnum] attr_accessor :seconds @@ -3765,16 +3510,14 @@ module Google end end - # An execution of an arbitrary tool. It could be a test runner or a tool - # copying artifacts or deploying code. + # An execution of an arbitrary tool. It could be a test runner or a tool copying + # artifacts or deploying code. class ToolExecution include Google::Apis::Core::Hashable - # The full tokenized command line including the program name (equivalent to - # argv in a C program). - # - In response: present if set by create request - # - In create request: optional - # - In update request: never set + # The full tokenized command line including the program name (equivalent to argv + # in a C program). - In response: present if set by create request - In create + # request: optional - In update request: never set # Corresponds to the JSON property `commandLineArguments` # @return [Array] attr_accessor :command_line_arguments @@ -3784,24 +3527,21 @@ module Google # @return [Google::Apis::ToolresultsV1beta3::ToolExitCode] attr_accessor :exit_code - # References to any plain text logs output the tool execution. - # This field can be set before the tool has exited in order to be able to - # have access to a live view of the logs while the tool is running. - # The maximum allowed number of tool logs per step is 1000. - # - In response: present if set by create/update request - # - In create request: optional - # - In update request: optional, any value provided will be appended to the - # existing list + # References to any plain text logs output the tool execution. This field can be + # set before the tool has exited in order to be able to have access to a live + # view of the logs while the tool is running. The maximum allowed number of tool + # logs per step is 1000. - In response: present if set by create/update request - + # In create request: optional - In update request: optional, any value provided + # will be appended to the existing list # Corresponds to the JSON property `toolLogs` # @return [Array] attr_accessor :tool_logs - # References to opaque files of any format output by the tool execution. - # The maximum allowed number of tool outputs per step is 1000. - # - In response: present if set by create/update request - # - In create request: optional - # - In update request: optional, any value provided will be appended to the - # existing list + # References to opaque files of any format output by the tool execution. The + # maximum allowed number of tool outputs per step is 1000. - In response: + # present if set by create/update request - In create request: optional - In + # update request: optional, any value provided will be appended to the existing + # list # Corresponds to the JSON property `toolOutputs` # @return [Array] attr_accessor :tool_outputs @@ -3819,13 +3559,13 @@ module Google end end - # Generic tool step to be used for binaries we do not explicitly support. - # For example: running cp to copy artifacts from one location to another. + # Generic tool step to be used for binaries we do not explicitly support. For + # example: running cp to copy artifacts from one location to another. class ToolExecutionStep include Google::Apis::Core::Hashable - # An execution of an arbitrary tool. It could be a test runner or a tool - # copying artifacts or deploying code. + # An execution of an arbitrary tool. It could be a test runner or a tool copying + # artifacts or deploying code. # Corresponds to the JSON property `toolExecution` # @return [Google::Apis::ToolresultsV1beta3::ToolExecution] attr_accessor :tool_execution @@ -3844,10 +3584,8 @@ module Google class ToolExitCode include Google::Apis::Core::Hashable - # Tool execution exit code. A value of 0 means that the execution was - # successful. - # - In response: always set - # - In create/update request: always set + # Tool execution exit code. A value of 0 means that the execution was successful. + # - In response: always set - In create/update request: always set # Corresponds to the JSON property `number` # @return [Fixnum] attr_accessor :number @@ -3867,16 +3605,15 @@ module Google include Google::Apis::Core::Hashable # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at - # nanosecond resolution. The count is relative to an epoch at UTC midnight on - # January 1, 1970, in the proleptic Gregorian calendar which extends the - # Gregorian calendar backwards to year one. - # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear - # smear](https://developers.google.com/time/smear). - # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC - # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. + # calendar, encoded as a count of seconds and fractions of seconds at nanosecond + # resolution. The count is relative to an epoch at UTC midnight on January 1, + # 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar + # backwards to year one. All minutes are 60 seconds long. Leap seconds are " + # smeared" so that no leap second table is needed for interpretation, using a [ + # 24-hour linear smear](https://developers.google.com/time/smear). The range is + # from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to + # that range, we ensure that we can convert to and from [RFC 3339](https://www. + # ietf.org/rfc/rfc3339.txt) date strings. # Corresponds to the JSON property `creationTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :creation_time @@ -3886,12 +3623,9 @@ module Google # @return [Google::Apis::ToolresultsV1beta3::FileReference] attr_accessor :output - # A reference to a test case. - # Test case references are canonically ordered lexicographically by these three - # factors: - # * First, by test_suite_name. - # * Second, by class_name. - # * Third, by name. + # A reference to a test case. Test case references are canonically ordered + # lexicographically by these three factors: * First, by test_suite_name. * + # Second, by class_name. * Third, by name. # Corresponds to the JSON property `testCase` # @return [Google::Apis::ToolresultsV1beta3::TestCaseReference] attr_accessor :test_case @@ -3981,8 +3715,8 @@ module Google # @return [String] attr_accessor :package_name - # The suggested version to upgrade to. - # Optional: In case we are not sure which version solves this problem + # The suggested version to upgrade to. Optional: In case we are not sure which + # version solves this problem # Corresponds to the JSON property `upgradeToVersion` # @return [String] attr_accessor :upgrade_to_version @@ -4017,8 +3751,8 @@ module Google end end - # Additional details of a used Robo directive with an ignore action. - # Note: This is a different scenario than unused directive. + # Additional details of a used Robo directive with an ignore action. Note: This + # is a different scenario than unused directive. class UsedRoboIgnoreDirective include Google::Apis::Core::Hashable diff --git a/generated/google/apis/toolresults_v1beta3/service.rb b/generated/google/apis/toolresults_v1beta3/service.rb index 78d316e83..d6809510c 100644 --- a/generated/google/apis/toolresults_v1beta3/service.rb +++ b/generated/google/apis/toolresults_v1beta3/service.rb @@ -47,12 +47,11 @@ module Google @batch_path = 'batch' end - # Gets the Tool Results settings for a project. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to read from project + # Gets the Tool Results settings for a project. May return any of the following + # canonical error codes: - PERMISSION_DENIED - if the user is not authorized to + # read from project # @param [String] project_id - # A Project id. - # Required. + # A Project id. Required. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -80,31 +79,26 @@ module Google execute_or_queue_command(command, &block) end - # Creates resources for settings which have not yet been set. - # Currently, this creates a single resource: a Google Cloud Storage bucket, - # to be used as the default bucket for this project. The bucket is created - # in an FTL-own storage project. Except for in rare cases, calling this - # method in parallel from multiple clients will only create a single bucket. - # In order to avoid unnecessary storage charges, the bucket is configured to - # automatically delete objects older than 90 days. - # The bucket is created with the following permissions: - # - Owner access for owners of central storage project (FTL-owned) - # - Writer access for owners/editors of customer project - # - Reader access for viewers of customer project - # The default ACL on objects created in the bucket is: - # - Owner access for owners of central storage project - # - Reader access for owners/editors/viewers of customer project - # See Google Cloud Storage documentation for more details. - # If there is already a default bucket set and the project can access the - # bucket, this call does nothing. However, if the project doesn't have the - # permission to access the bucket or the bucket is deleted, a new bucket - # will be created. - # May return any canonical error codes, including the following: - # - PERMISSION_DENIED - if the user is not authorized to write to project - # - Any error code raised by Google Cloud Storage + # Creates resources for settings which have not yet been set. Currently, this + # creates a single resource: a Google Cloud Storage bucket, to be used as the + # default bucket for this project. The bucket is created in an FTL-own storage + # project. Except for in rare cases, calling this method in parallel from + # multiple clients will only create a single bucket. In order to avoid + # unnecessary storage charges, the bucket is configured to automatically delete + # objects older than 90 days. The bucket is created with the following + # permissions: - Owner access for owners of central storage project (FTL-owned) - + # Writer access for owners/editors of customer project - Reader access for + # viewers of customer project The default ACL on objects created in the bucket + # is: - Owner access for owners of central storage project - Reader access for + # owners/editors/viewers of customer project See Google Cloud Storage + # documentation for more details. If there is already a default bucket set and + # the project can access the bucket, this call does nothing. However, if the + # project doesn't have the permission to access the bucket or the bucket is + # deleted, a new bucket will be created. May return any canonical error codes, + # including the following: - PERMISSION_DENIED - if the user is not authorized + # to write to project - Any error code raised by Google Cloud Storage # @param [String] project_id - # A Project id. - # Required. + # A Project id. Required. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -132,20 +126,16 @@ module Google execute_or_queue_command(command, &block) end - # Creates a History. - # The returned History will have the id set. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to write to project - # - INVALID_ARGUMENT - if the request is malformed - # - NOT_FOUND - if the containing project does not exist + # Creates a History. The returned History will have the id set. May return any + # of the following canonical error codes: - PERMISSION_DENIED - if the user is + # not authorized to write to project - INVALID_ARGUMENT - if the request is + # malformed - NOT_FOUND - if the containing project does not exist # @param [String] project_id - # A Project id. - # Required. + # A Project id. Required. # @param [Google::Apis::ToolresultsV1beta3::History] history_object # @param [String] request_id - # A unique request ID for server to detect duplicated requests. - # For example, a UUID. - # Optional, but strongly recommended. + # A unique request ID for server to detect duplicated requests. For example, a + # UUID. Optional, but strongly recommended. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -176,17 +166,14 @@ module Google execute_or_queue_command(command, &block) end - # Gets a History. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to read project - # - INVALID_ARGUMENT - if the request is malformed - # - NOT_FOUND - if the History does not exist + # Gets a History. May return any of the following canonical error codes: - + # PERMISSION_DENIED - if the user is not authorized to read project - + # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the History + # does not exist # @param [String] project_id - # A Project id. - # Required. + # A Project id. Required. # @param [String] history_id - # A History id. - # Required. + # A History id. Required. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -215,28 +202,22 @@ module Google execute_or_queue_command(command, &block) end - # Lists Histories for a given Project. - # The histories are sorted by modification time in descending order. The - # history_id key will be used to order the history with the same - # modification time. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to read project - # - INVALID_ARGUMENT - if the request is malformed - # - NOT_FOUND - if the History does not exist + # Lists Histories for a given Project. The histories are sorted by modification + # time in descending order. The history_id key will be used to order the history + # with the same modification time. May return any of the following canonical + # error codes: - PERMISSION_DENIED - if the user is not authorized to read + # project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the + # History does not exist # @param [String] project_id - # A Project id. - # Required. + # A Project id. Required. # @param [String] filter_by_name - # If set, only return histories with the given name. - # Optional. + # If set, only return histories with the given name. Optional. # @param [Fixnum] page_size - # The maximum number of Histories to fetch. - # Default value: 20. The server will use this default if the field is not set - # or has a value of 0. Any value greater than 100 will be treated as 100. - # Optional. + # The maximum number of Histories to fetch. Default value: 20. The server will + # use this default if the field is not set or has a value of 0. Any value + # greater than 100 will be treated as 100. Optional. # @param [String] page_token - # A continuation token to resume the query at the next item. - # Optional. + # A continuation token to resume the query at the next item. Optional. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -267,23 +248,18 @@ module Google execute_or_queue_command(command, &block) end - # Creates an Execution. - # The returned Execution will have the id set. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to write to project - # - INVALID_ARGUMENT - if the request is malformed - # - NOT_FOUND - if the containing History does not exist + # Creates an Execution. The returned Execution will have the id set. May return + # any of the following canonical error codes: - PERMISSION_DENIED - if the user + # is not authorized to write to project - INVALID_ARGUMENT - if the request is + # malformed - NOT_FOUND - if the containing History does not exist # @param [String] project_id - # A Project id. - # Required. + # A Project id. Required. # @param [String] history_id - # A History id. - # Required. + # A History id. Required. # @param [Google::Apis::ToolresultsV1beta3::Execution] execution_object # @param [String] request_id - # A unique request ID for server to detect duplicated requests. - # For example, a UUID. - # Optional, but strongly recommended. + # A unique request ID for server to detect duplicated requests. For example, a + # UUID. Optional, but strongly recommended. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -315,20 +291,16 @@ module Google execute_or_queue_command(command, &block) end - # Gets an Execution. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to write to project - # - INVALID_ARGUMENT - if the request is malformed - # - NOT_FOUND - if the Execution does not exist + # Gets an Execution. May return any of the following canonical error codes: - + # PERMISSION_DENIED - if the user is not authorized to write to project - + # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Execution + # does not exist # @param [String] project_id - # A Project id. - # Required. + # A Project id. Required. # @param [String] history_id - # A History id. - # Required. + # A History id. Required. # @param [String] execution_id - # An Execution id. - # Required. + # An Execution id. Required. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -358,28 +330,21 @@ module Google execute_or_queue_command(command, &block) end - # Lists Executions for a given History. - # The executions are sorted by creation_time in descending order. The - # execution_id key will be used to order the executions with the same - # creation_time. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to read project - # - INVALID_ARGUMENT - if the request is malformed - # - NOT_FOUND - if the containing History does not exist + # Lists Executions for a given History. The executions are sorted by + # creation_time in descending order. The execution_id key will be used to order + # the executions with the same creation_time. May return any of the following + # canonical error codes: - PERMISSION_DENIED - if the user is not authorized to + # read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if + # the containing History does not exist # @param [String] project_id - # A Project id. - # Required. + # A Project id. Required. # @param [String] history_id - # A History id. - # Required. + # A History id. Required. # @param [Fixnum] page_size - # The maximum number of Executions to fetch. - # Default value: 25. The server will use this default if the field is not set - # or has a value of 0. - # Optional. + # The maximum number of Executions to fetch. Default value: 25. The server will + # use this default if the field is not set or has a value of 0. Optional. # @param [String] page_token - # A continuation token to resume the query at the next item. - # Optional. + # A continuation token to resume the query at the next item. Optional. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -410,24 +375,21 @@ module Google execute_or_queue_command(command, &block) end - # Updates an existing Execution with the supplied partial entity. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to write to project - # - INVALID_ARGUMENT - if the request is malformed - # - FAILED_PRECONDITION - if the requested state transition is illegal + # Updates an existing Execution with the supplied partial entity. May return any + # of the following canonical error codes: - PERMISSION_DENIED - if the user is + # not authorized to write to project - INVALID_ARGUMENT - if the request is + # malformed - FAILED_PRECONDITION - if the requested state transition is illegal # - NOT_FOUND - if the containing History does not exist # @param [String] project_id - # A Project id. - # Required. + # A Project id. Required. # @param [String] history_id # Required. # @param [String] execution_id # Required. # @param [Google::Apis::ToolresultsV1beta3::Execution] execution_object # @param [String] request_id - # A unique request ID for server to detect duplicated requests. - # For example, a UUID. - # Optional, but strongly recommended. + # A unique request ID for server to detect duplicated requests. For example, a + # UUID. Optional, but strongly recommended. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -462,17 +424,13 @@ module Google # Retrieves a single screenshot cluster by its ID # @param [String] project_id - # A Project id. - # Required. + # A Project id. Required. # @param [String] history_id - # A History id. - # Required. + # A History id. Required. # @param [String] execution_id - # An Execution id. - # Required. + # An Execution id. Required. # @param [String] cluster_id - # A Cluster id - # Required. + # A Cluster id Required. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -503,23 +461,18 @@ module Google execute_or_queue_command(command, &block) end - # Lists Screenshot Clusters - # Returns the list of screenshot clusters corresponding to an execution. - # Screenshot clusters are created after the execution is finished. - # Clusters are created from a set of screenshots. Between any two - # screenshots, a matching score is calculated based off their metadata - # that determines how similar they are. Screenshots are placed - # in the cluster that has screens which have the highest matching - # scores. + # Lists Screenshot Clusters Returns the list of screenshot clusters + # corresponding to an execution. Screenshot clusters are created after the + # execution is finished. Clusters are created from a set of screenshots. Between + # any two screenshots, a matching score is calculated based off their metadata + # that determines how similar they are. Screenshots are placed in the cluster + # that has screens which have the highest matching scores. # @param [String] project_id - # A Project id. - # Required. + # A Project id. Required. # @param [String] history_id - # A History id. - # Required. + # A History id. Required. # @param [String] execution_id - # An Execution id. - # Required. + # An Execution id. Required. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -549,11 +502,10 @@ module Google execute_or_queue_command(command, &block) end - # Gets an Environment. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to read project - # - INVALID_ARGUMENT - if the request is malformed - # - NOT_FOUND - if the Environment does not exist + # Gets an Environment. May return any of the following canonical error codes: - + # PERMISSION_DENIED - if the user is not authorized to read project - + # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the + # Environment does not exist # @param [String] project_id # Required. A Project id. # @param [String] history_id @@ -592,12 +544,11 @@ module Google execute_or_queue_command(command, &block) end - # Lists Environments for a given Execution. - # The Environments are sorted by display name. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to read project - # - INVALID_ARGUMENT - if the request is malformed - # - NOT_FOUND - if the containing Execution does not exist + # Lists Environments for a given Execution. The Environments are sorted by + # display name. May return any of the following canonical error codes: - + # PERMISSION_DENIED - if the user is not authorized to read project - + # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing + # Execution does not exist # @param [String] project_id # Required. A Project id. # @param [String] history_id @@ -605,9 +556,8 @@ module Google # @param [String] execution_id # Required. An Execution id. # @param [Fixnum] page_size - # The maximum number of Environments to fetch. - # Default value: 25. The server will use this default if the field is not set - # or has a value of 0. + # The maximum number of Environments to fetch. Default value: 25. The server + # will use this default if the field is not set or has a value of 0. # @param [String] page_token # A continuation token to resume the query at the next item. # @param [String] fields @@ -641,25 +591,21 @@ module Google execute_or_queue_command(command, &block) end - # Lists accessibility clusters for a given Step - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to read project - # - INVALID_ARGUMENT - if the request is malformed - # - FAILED_PRECONDITION - if an argument in the request happens to be - # invalid; e.g. if the locale format is incorrect - # - NOT_FOUND - if the containing Step does not exist + # Lists accessibility clusters for a given Step May return any of the following + # canonical error codes: - PERMISSION_DENIED - if the user is not authorized to + # read project - INVALID_ARGUMENT - if the request is malformed - + # FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g. + # if the locale format is incorrect - NOT_FOUND - if the containing Step does + # not exist # @param [String] name - # A full resource name of the step. - # For example, projects/my-project/histories/bh.1234567890abcdef/executions/ - # 1234567890123456789/steps/bs.1234567890abcdef + # A full resource name of the step. For example, projects/my-project/histories/ + # bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef # Required. # @param [String] locale - # The accepted format is the canonical Unicode format with hyphen as a - # delimiter. Language must be lowercase, Language Script - Capitalized, - # Region - UPPERCASE. + # The accepted format is the canonical Unicode format with hyphen as a delimiter. + # Language must be lowercase, Language Script - Capitalized, Region - UPPERCASE. # See http://www.unicode.org/reports/tr35/#Unicode_locale_identifier for - # details. - # Required. + # details. Required. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -688,13 +634,11 @@ module Google execute_or_queue_command(command, &block) end - # Creates a Step. - # The returned Step will have the id set. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to write to project - # - INVALID_ARGUMENT - if the request is malformed - # - FAILED_PRECONDITION - if the step is too large (more than 10Mib) - # - NOT_FOUND - if the containing Execution does not exist + # Creates a Step. The returned Step will have the id set. May return any of the + # following canonical error codes: - PERMISSION_DENIED - if the user is not + # authorized to write to project - INVALID_ARGUMENT - if the request is + # malformed - FAILED_PRECONDITION - if the step is too large (more than 10Mib) - + # NOT_FOUND - if the containing Execution does not exist # @param [String] project_id # Required. A Project id. # @param [String] history_id @@ -703,9 +647,8 @@ module Google # Required. An Execution id. # @param [Google::Apis::ToolresultsV1beta3::Step] step_object # @param [String] request_id - # A unique request ID for server to detect duplicated requests. - # For example, a UUID. - # Optional, but strongly recommended. + # A unique request ID for server to detect duplicated requests. For example, a + # UUID. Optional, but strongly recommended. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -738,23 +681,18 @@ module Google execute_or_queue_command(command, &block) end - # Gets a Step. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to read project - # - INVALID_ARGUMENT - if the request is malformed - # - NOT_FOUND - if the Step does not exist + # Gets a Step. May return any of the following canonical error codes: - + # PERMISSION_DENIED - if the user is not authorized to read project - + # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Step does + # not exist # @param [String] project_id - # A Project id. - # Required. + # A Project id. Required. # @param [String] history_id - # A History id. - # Required. + # A History id. Required. # @param [String] execution_id - # A Execution id. - # Required. + # A Execution id. Required. # @param [String] step_id - # A Step id. - # Required. + # A Step id. Required. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -785,8 +723,7 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves a PerfMetricsSummary. - # May return any of the following error code(s): + # Retrieves a PerfMetricsSummary. May return any of the following error code(s): # - NOT_FOUND - The specified PerfMetricsSummary does not exist # @param [String] project_id # The cloud project @@ -826,34 +763,25 @@ module Google execute_or_queue_command(command, &block) end - # Lists Steps for a given Execution. - # The steps are sorted by creation_time in descending order. The - # step_id key will be used to order the steps with the same - # creation_time. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to read project - # - INVALID_ARGUMENT - if the request is malformed - # - FAILED_PRECONDITION - if an argument in the request happens to be - # invalid; e.g. if an attempt is made to list the - # children of a nonexistent Step - # - NOT_FOUND - if the containing Execution does not exist + # Lists Steps for a given Execution. The steps are sorted by creation_time in + # descending order. The step_id key will be used to order the steps with the + # same creation_time. May return any of the following canonical error codes: - + # PERMISSION_DENIED - if the user is not authorized to read project - + # INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if an + # argument in the request happens to be invalid; e.g. if an attempt is made to + # list the children of a nonexistent Step - NOT_FOUND - if the containing + # Execution does not exist # @param [String] project_id - # A Project id. - # Required. + # A Project id. Required. # @param [String] history_id - # A History id. - # Required. + # A History id. Required. # @param [String] execution_id - # A Execution id. - # Required. + # A Execution id. Required. # @param [Fixnum] page_size - # The maximum number of Steps to fetch. - # Default value: 25. The server will use this default if the field is not set - # or has a value of 0. - # Optional. + # The maximum number of Steps to fetch. Default value: 25. The server will use + # this default if the field is not set or has a value of 0. Optional. # @param [String] page_token - # A continuation token to resume the query at the next item. - # Optional. + # A continuation token to resume the query at the next item. Optional. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -885,31 +813,24 @@ module Google execute_or_queue_command(command, &block) end - # Updates an existing Step with the supplied partial entity. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to write project - # - INVALID_ARGUMENT - if the request is malformed - # - FAILED_PRECONDITION - if the requested state transition is illegal - # (e.g try to upload a duplicate xml file), if the - # updated step is too large (more than 10Mib) - # - NOT_FOUND - if the containing Execution does not exist + # Updates an existing Step with the supplied partial entity. May return any of + # the following canonical error codes: - PERMISSION_DENIED - if the user is not + # authorized to write project - INVALID_ARGUMENT - if the request is malformed - + # FAILED_PRECONDITION - if the requested state transition is illegal (e.g try to + # upload a duplicate xml file), if the updated step is too large (more than + # 10Mib) - NOT_FOUND - if the containing Execution does not exist # @param [String] project_id - # A Project id. - # Required. + # A Project id. Required. # @param [String] history_id - # A History id. - # Required. + # A History id. Required. # @param [String] execution_id - # A Execution id. - # Required. + # A Execution id. Required. # @param [String] step_id - # A Step id. - # Required. + # A Step id. Required. # @param [Google::Apis::ToolresultsV1beta3::Step] step_object # @param [String] request_id - # A unique request ID for server to detect duplicated requests. - # For example, a UUID. - # Optional, but strongly recommended. + # A unique request ID for server to detect duplicated requests. For example, a + # UUID. Optional, but strongly recommended. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -943,26 +864,20 @@ module Google execute_or_queue_command(command, &block) end - # Publish xml files to an existing Step. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to write project - # - INVALID_ARGUMENT - if the request is malformed - # - FAILED_PRECONDITION - if the requested state transition is illegal, - # e.g try to upload a duplicate xml file or a file too large. - # - NOT_FOUND - if the containing Execution does not exist + # Publish xml files to an existing Step. May return any of the following + # canonical error codes: - PERMISSION_DENIED - if the user is not authorized to + # write project - INVALID_ARGUMENT - if the request is malformed - + # FAILED_PRECONDITION - if the requested state transition is illegal, e.g try to + # upload a duplicate xml file or a file too large. - NOT_FOUND - if the + # containing Execution does not exist # @param [String] project_id - # A Project id. - # Required. + # A Project id. Required. # @param [String] history_id - # A History id. - # Required. + # A History id. Required. # @param [String] execution_id - # A Execution id. - # Required. + # A Execution id. Required. # @param [String] step_id - # A Step id. - # Note: This step must include a TestExecutionStep. - # Required. + # A Step id. Note: This step must include a TestExecutionStep. Required. # @param [Google::Apis::ToolresultsV1beta3::PublishXunitXmlFilesRequest] publish_xunit_xml_files_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -997,9 +912,8 @@ module Google end # Creates a PerfMetricsSummary resource. Returns the existing one if it has - # already been created. - # May return any of the following error code(s): - # - NOT_FOUND - The containing Step does not exist + # already been created. May return any of the following error code(s): - + # NOT_FOUND - The containing Step does not exist # @param [String] project_id # The cloud project # @param [String] history_id @@ -1041,10 +955,9 @@ module Google execute_or_queue_command(command, &block) end - # Creates a PerfSampleSeries. - # May return any of the following error code(s): - # - ALREADY_EXISTS - PerfMetricSummary already exists for the given Step - # - NOT_FOUND - The containing Step does not exist + # Creates a PerfSampleSeries. May return any of the following error code(s): - + # ALREADY_EXISTS - PerfMetricSummary already exists for the given Step - + # NOT_FOUND - The containing Step does not exist # @param [String] project_id # The cloud project # @param [String] history_id @@ -1086,9 +999,8 @@ module Google execute_or_queue_command(command, &block) end - # Gets a PerfSampleSeries. - # May return any of the following error code(s): - # - NOT_FOUND - The specified PerfSampleSeries does not exist + # Gets a PerfSampleSeries. May return any of the following error code(s): - + # NOT_FOUND - The specified PerfSampleSeries does not exist # @param [String] project_id # The cloud project # @param [String] history_id @@ -1130,12 +1042,11 @@ module Google execute_or_queue_command(command, &block) end - # Lists PerfSampleSeries for a given Step. - # The request provides an optional filter which specifies one or more - # PerfMetricsType to include in the result; if none returns all. - # The resulting PerfSampleSeries are sorted by ids. - # May return any of the following canonical error codes: - # - NOT_FOUND - The containing Step does not exist + # Lists PerfSampleSeries for a given Step. The request provides an optional + # filter which specifies one or more PerfMetricsType to include in the result; + # if none returns all. The resulting PerfSampleSeries are sorted by ids. May + # return any of the following canonical error codes: - NOT_FOUND - The + # containing Step does not exist # @param [String] project_id # The cloud project # @param [String] history_id @@ -1177,15 +1088,13 @@ module Google execute_or_queue_command(command, &block) end - # Creates a batch of PerfSamples - # - a client can submit multiple batches of Perf Samples through repeated - # calls to this method in order to split up a large request payload - # - duplicates and existing timestamp entries will be ignored. - # - the batch operation may partially succeed - # - the set of elements successfully inserted is returned in the response - # (omits items which already existed in the database). - # May return any of the following canonical error codes: - # - NOT_FOUND - The containing PerfSampleSeries does not exist + # Creates a batch of PerfSamples - a client can submit multiple batches of Perf + # Samples through repeated calls to this method in order to split up a large + # request payload - duplicates and existing timestamp entries will be ignored. - + # the batch operation may partially succeed - the set of elements successfully + # inserted is returned in the response (omits items which already existed in the + # database). May return any of the following canonical error codes: - NOT_FOUND - + # The containing PerfSampleSeries does not exist # @param [String] project_id # The cloud project # @param [String] history_id @@ -1230,16 +1139,14 @@ module Google execute_or_queue_command(command, &block) end - # Lists the Performance Samples of a given Sample Series - # - The list results are sorted by timestamps ascending - # - The default page size is 500 samples; and maximum size allowed 5000 - # - The response token indicates the last returned PerfSample timestamp - # - When the results size exceeds the page size, submit a subsequent request - # including the page token to return the rest of the samples up to the - # page limit - # May return any of the following canonical error codes: - # - OUT_OF_RANGE - The specified request page_token is out of valid range - # - NOT_FOUND - The containing PerfSampleSeries does not exist + # Lists the Performance Samples of a given Sample Series - The list results are + # sorted by timestamps ascending - The default page size is 500 samples; and + # maximum size allowed 5000 - The response token indicates the last returned + # PerfSample timestamp - When the results size exceeds the page size, submit a + # subsequent request including the page token to return the rest of the samples + # up to the page limit May return any of the following canonical error codes: - + # OUT_OF_RANGE - The specified request page_token is out of valid range - + # NOT_FOUND - The containing PerfSampleSeries does not exist # @param [String] project_id # The cloud project # @param [String] history_id @@ -1251,8 +1158,8 @@ module Google # @param [String] sample_series_id # A sample series id # @param [Fixnum] page_size - # The default page size is 500 samples, and the maximum size is 5000. If - # the page_size is greater than 5000, the effective page size will be 5000 + # The default page size is 500 samples, and the maximum size is 5000. If the + # page_size is greater than 5000, the effective page size will be 5000 # @param [String] page_token # Optional, the next_page_token returned in the previous response # @param [String] fields @@ -1288,28 +1195,21 @@ module Google execute_or_queue_command(command, &block) end - # Gets details of a Test Case for a Step. - # Experimental test cases API. Still in active development. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to write to project - # - INVALID_ARGUMENT - if the request is malformed - # - NOT_FOUND - if the containing Test Case does not exist + # Gets details of a Test Case for a Step. Experimental test cases API. Still in + # active development. May return any of the following canonical error codes: - + # PERMISSION_DENIED - if the user is not authorized to write to project - + # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing + # Test Case does not exist # @param [String] project_id - # A Project id. - # Required. + # A Project id. Required. # @param [String] history_id - # A History id. - # Required. + # A History id. Required. # @param [String] execution_id - # A Execution id - # Required. + # A Execution id Required. # @param [String] step_id - # A Step id. - # Note: This step must include a TestExecutionStep. - # Required. + # A Step id. Note: This step must include a TestExecutionStep. Required. # @param [String] test_case_id - # A Test Case id. - # Required. + # A Test Case id. Required. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1341,33 +1241,24 @@ module Google execute_or_queue_command(command, &block) end - # Lists Test Cases attached to a Step. - # Experimental test cases API. Still in active development. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to write to project - # - INVALID_ARGUMENT - if the request is malformed - # - NOT_FOUND - if the containing Step does not exist + # Lists Test Cases attached to a Step. Experimental test cases API. Still in + # active development. May return any of the following canonical error codes: - + # PERMISSION_DENIED - if the user is not authorized to write to project - + # INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing + # Step does not exist # @param [String] project_id - # A Project id. - # Required. + # A Project id. Required. # @param [String] history_id - # A History id. - # Required. + # A History id. Required. # @param [String] execution_id - # A Execution id - # Required. + # A Execution id Required. # @param [String] step_id - # A Step id. - # Note: This step must include a TestExecutionStep. - # Required. + # A Step id. Note: This step must include a TestExecutionStep. Required. # @param [Fixnum] page_size - # The maximum number of TestCases to fetch. - # Default value: 100. The server will use this default if the field is not - # set or has a value of 0. - # Optional. + # The maximum number of TestCases to fetch. Default value: 100. The server will + # use this default if the field is not set or has a value of 0. Optional. # @param [String] page_token - # A continuation token to resume the query at the next item. - # Optional. + # A continuation token to resume the query at the next item. Optional. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1400,33 +1291,24 @@ module Google execute_or_queue_command(command, &block) end - # Lists thumbnails of images attached to a step. - # May return any of the following canonical error codes: - # - PERMISSION_DENIED - if the user is not authorized to read from the - # project, or from any of the images - # - INVALID_ARGUMENT - if the request is malformed - # - NOT_FOUND - if the step does not exist, or if any of the images - # do not exist + # Lists thumbnails of images attached to a step. May return any of the following + # canonical error codes: - PERMISSION_DENIED - if the user is not authorized to + # read from the project, or from any of the images - INVALID_ARGUMENT - if the + # request is malformed - NOT_FOUND - if the step does not exist, or if any of + # the images do not exist # @param [String] project_id - # A Project id. - # Required. + # A Project id. Required. # @param [String] history_id - # A History id. - # Required. + # A History id. Required. # @param [String] execution_id - # An Execution id. - # Required. + # An Execution id. Required. # @param [String] step_id - # A Step id. - # Required. + # A Step id. Required. # @param [Fixnum] page_size - # The maximum number of thumbnails to fetch. - # Default value: 50. The server will use this default if the field is not set - # or has a value of 0. - # Optional. + # The maximum number of thumbnails to fetch. Default value: 50. The server will + # use this default if the field is not set or has a value of 0. Optional. # @param [String] page_token - # A continuation token to resume the query at the next item. - # Optional. + # A continuation token to resume the query at the next item. Optional. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/translate_v3.rb b/generated/google/apis/translate_v3.rb index d7b272dc5..d97fd5188 100644 --- a/generated/google/apis/translate_v3.rb +++ b/generated/google/apis/translate_v3.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/translate/docs/quickstarts module TranslateV3 VERSION = 'V3' - REVISION = '20200515' + REVISION = '20200730' # 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/translate_v3/service.rb b/generated/google/apis/translate_v3/service.rb index 042826266..879e004e3 100644 --- a/generated/google/apis/translate_v3/service.rb +++ b/generated/google/apis/translate_v3/service.rb @@ -534,7 +534,20 @@ module Google # Required. The name of the project from which to list all of the glossaries. # @param [String] filter # Optional. Filter specifying constraints of a list operation. - # Filtering is not supported yet, and the parameter currently has no effect. + # Specify the constraint by the format of "key=value", where key must be + # "src" or "tgt", and the value must be a valid language code. + # For multiple restrictions, concatenate them by "AND" (uppercase only), + # such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used + # here, which means using 'en-US' and 'en' can lead to different results, + # which depends on the language code you used when you create the glossary. + # For the unidirectional glossaries, the "src" and "tgt" add restrictions + # on the source and target language code separately. + # For the equivalent term set glossaries, the "src" and/or "tgt" add + # restrictions on the term set. + # For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional + # glossaries which exactly match the source language code as "en-US" and the + # target language code "zh-CN", but all equivalent term set glossaries which + # contain "en-US" and "zh-CN" in their language set will be picked. # If missing, no filtering is performed. # @param [Fixnum] page_size # Optional. Requested page size. The server may return fewer glossaries than diff --git a/generated/google/apis/translate_v3beta1.rb b/generated/google/apis/translate_v3beta1.rb index 9319e69c5..0e9210544 100644 --- a/generated/google/apis/translate_v3beta1.rb +++ b/generated/google/apis/translate_v3beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/translate/docs/quickstarts module TranslateV3beta1 VERSION = 'V3beta1' - REVISION = '20200221' + REVISION = '20200730' # 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/translate_v3beta1/service.rb b/generated/google/apis/translate_v3beta1/service.rb index 9c9727d00..05f776bb9 100644 --- a/generated/google/apis/translate_v3beta1/service.rb +++ b/generated/google/apis/translate_v3beta1/service.rb @@ -534,7 +534,20 @@ module Google # Required. The name of the project from which to list all of the glossaries. # @param [String] filter # Optional. Filter specifying constraints of a list operation. - # Filtering is not supported yet, and the parameter currently has no effect. + # Specify the constraint by the format of "key=value", where key must be + # "src" or "tgt", and the value must be a valid language code. + # For multiple restrictions, concatenate them by "AND" (uppercase only), + # such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used + # here, which means using 'en-US' and 'en' can lead to different results, + # which depends on the language code you used when you create the glossary. + # For the unidirectional glossaries, the "src" and "tgt" add restrictions + # on the source and target language code separately. + # For the equivalent term set glossaries, the "src" and/or "tgt" add + # restrictions on the term set. + # For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional + # glossaries which exactly match the source language code as "en-US" and the + # target language code "zh-CN", but all equivalent term set glossaries which + # contain "en-US" and "zh-CN" in their language set will be picked. # If missing, no filtering is performed. # @param [Fixnum] page_size # Optional. Requested page size. The server may return fewer glossaries than diff --git a/generated/google/apis/websecurityscanner_v1.rb b/generated/google/apis/websecurityscanner_v1.rb index 6c341ebc4..f4caea322 100644 --- a/generated/google/apis/websecurityscanner_v1.rb +++ b/generated/google/apis/websecurityscanner_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/ module WebsecurityscannerV1 VERSION = 'V1' - REVISION = '20200516' + REVISION = '20200801' # 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/websecurityscanner_v1/classes.rb b/generated/google/apis/websecurityscanner_v1/classes.rb index 436552774..7ce9900e8 100644 --- a/generated/google/apis/websecurityscanner_v1/classes.rb +++ b/generated/google/apis/websecurityscanner_v1/classes.rb @@ -97,8 +97,7 @@ module Google attr_accessor :login_url # Required. Input only. The password of the custom account. The credential is - # stored encrypted - # and not returned in any response nor included in audit logs. + # stored encrypted and not returned in any response nor included in audit logs. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password @@ -120,13 +119,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 @@ -160,10 +157,9 @@ module Google # @return [String] attr_accessor :final_url - # Output only. The type of the Finding. - # Detailed and up-to-date information on findings can be found here: - # https://cloud.google.com/security-command-center/docs/how-to-remediate-web- - # security-scanner-findings + # Output only. The type of the Finding. Detailed and up-to-date information on + # findings can be found here: https://cloud.google.com/security-command-center/ + # docs/how-to-remediate-web-security-scanner-findings # Corresponds to the JSON property `findingType` # @return [String] attr_accessor :finding_type @@ -174,30 +170,26 @@ module Google attr_accessor :form # Output only. If the vulnerability was originated from nested IFrame, the - # immediate - # parent IFrame is reported. + # immediate parent IFrame is reported. # Corresponds to the JSON property `frameUrl` # @return [String] attr_accessor :frame_url # Output only. The URL produced by the server-side fuzzer and used in the - # request that - # triggered the vulnerability. + # request that triggered the vulnerability. # Corresponds to the JSON property `fuzzedUrl` # @return [String] attr_accessor :fuzzed_url # Output only. The http method of the request that triggered the vulnerability, - # in - # uppercase. + # in uppercase. # Corresponds to the JSON property `httpMethod` # @return [String] attr_accessor :http_method - # Output only. The resource name of the Finding. The name follows the format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanruns/`scanRunId`/findings/ - # `findingId`'. - # The finding IDs are generated by the system. + # Output only. The resource name of the Finding. The name follows the format of ' + # projects/`projectId`/scanConfigs/`scanConfigId`/scanruns/`scanRunId`/findings/` + # findingId`'. The finding IDs are generated by the system. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -208,8 +200,7 @@ module Google attr_accessor :outdated_library # Output only. The URL containing human-readable payload that user can leverage - # to - # reproduce the vulnerability. + # to reproduce the vulnerability. # Corresponds to the JSON property `reproductionUrl` # @return [String] attr_accessor :reproduction_url @@ -220,14 +211,13 @@ module Google attr_accessor :severity # Output only. The tracking ID uniquely identifies a vulnerability instance - # across - # multiple ScanRuns. + # across multiple ScanRuns. # Corresponds to the JSON property `trackingId` # @return [String] attr_accessor :tracking_id - # Information regarding any resource causing the vulnerability such - # as JavaScript sources, image, audio files, etc. + # Information regarding any resource causing the vulnerability such as + # JavaScript sources, image, audio files, etc. # Corresponds to the JSON property `violatingResource` # @return [Google::Apis::WebsecurityscannerV1::ViolatingResource] attr_accessor :violating_resource @@ -329,8 +319,7 @@ module Google include Google::Apis::Core::Hashable # Required. Input only. The password of the Google account. The credential is - # stored encrypted - # and not returned in any response nor included in audit logs. + # stored encrypted and not returned in any response nor included in audit logs. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password @@ -380,8 +369,8 @@ module Google class IapCredential include Google::Apis::Core::Hashable - # Describes authentication configuration when Web-Security-Scanner - # service account is added in Identity-Aware-Proxy (IAP) access policies. + # Describes authentication configuration when Web-Security-Scanner service + # account is added in Identity-Aware-Proxy (IAP) access policies. # Corresponds to the JSON property `iapTestServiceAccountInfo` # @return [Google::Apis::WebsecurityscannerV1::IapTestServiceAccountInfo] attr_accessor :iap_test_service_account_info @@ -396,13 +385,13 @@ module Google end end - # Describes authentication configuration when Web-Security-Scanner - # service account is added in Identity-Aware-Proxy (IAP) access policies. + # Describes authentication configuration when Web-Security-Scanner service + # account is added in Identity-Aware-Proxy (IAP) access policies. class IapTestServiceAccountInfo include Google::Apis::Core::Hashable - # Required. Describes OAuth2 client id of resources protected by - # Identity-Aware-Proxy (IAP). + # Required. Describes OAuth2 client id of resources protected by Identity-Aware- + # Proxy (IAP). # Corresponds to the JSON property `targetAudienceClientId` # @return [String] attr_accessor :target_audience_client_id @@ -426,8 +415,8 @@ module Google # @return [Array] attr_accessor :crawled_urls - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -471,8 +460,8 @@ module Google # @return [Array] attr_accessor :findings - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -492,8 +481,8 @@ module Google class ListScanConfigsResponse include Google::Apis::Core::Hashable - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -518,8 +507,8 @@ module Google class ListScanRunsResponse include Google::Apis::Core::Hashable - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -580,9 +569,8 @@ module Google # @return [Google::Apis::WebsecurityscannerV1::Authentication] attr_accessor :authentication - # The excluded URL patterns as described in - # https://cloud.google.com/security-command-center/docs/how-to-use-web-security- - # scanner#excluding_urls + # The excluded URL patterns as described in https://cloud.google.com/security- + # command-center/docs/how-to-use-web-security-scanner#excluding_urls # Corresponds to the JSON property `blacklistPatterns` # @return [Array] attr_accessor :blacklist_patterns @@ -592,30 +580,28 @@ module Google # @return [String] attr_accessor :display_name - # Controls export of scan configurations and results to Security - # Command Center. + # Controls export of scan configurations and results to Security Command Center. # Corresponds to the JSON property `exportToSecurityCommandCenter` # @return [String] attr_accessor :export_to_security_command_center - # Whether the scan config is managed by Web Security Scanner, output - # only. + # Whether the scan config is managed by Web Security Scanner, output only. # Corresponds to the JSON property `managedScan` # @return [Boolean] attr_accessor :managed_scan alias_method :managed_scan?, :managed_scan - # The maximum QPS during scanning. A valid value ranges from 5 to 20 - # inclusively. If the field is unspecified or its value is set 0, server will - # default to 15. Other values outside of [5, 20] range will be rejected with - # INVALID_ARGUMENT error. + # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. + # If the field is unspecified or its value is set 0, server will default to 15. + # Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT + # error. # Corresponds to the JSON property `maxQps` # @return [Fixnum] attr_accessor :max_qps - # The resource name of the ScanConfig. The name follows the format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`'. The ScanConfig IDs are - # generated by the system. + # The resource name of the ScanConfig. The name follows the format of 'projects/` + # projectId`/scanConfigs/`scanConfigId`'. The ScanConfig IDs are generated by + # the system. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -635,8 +621,8 @@ module Google # @return [Array] attr_accessor :starting_urls - # Whether the scan configuration has enabled static IP address scan feature. - # If enabled, the scanner will access applications from static IP addresses. + # Whether the scan configuration has enabled static IP address scan feature. If + # enabled, the scanner will access applications from static IP addresses. # Corresponds to the JSON property `staticIpScan` # @return [Boolean] attr_accessor :static_ip_scan @@ -681,10 +667,8 @@ module Google attr_accessor :code # Output only. Indicates the full name of the ScanConfig field that triggers - # this error, - # for example "scan_config.max_qps". This field is provided for - # troubleshooting purposes only and its actual value can change in the - # future. + # this error, for example "scan_config.max_qps". This field is provided for + # troubleshooting purposes only and its actual value can change in the future. # Corresponds to the JSON property `fieldName` # @return [String] attr_accessor :field_name @@ -706,14 +690,12 @@ module Google include Google::Apis::Core::Hashable # Output only. The time at which the ScanRun reached termination state - that - # the ScanRun - # is either finished or stopped by user. + # the ScanRun is either finished or stopped by user. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. - # Defines an error trace message for a ScanRun. + # Output only. Defines an error trace message for a ScanRun. # Corresponds to the JSON property `errorTrace` # @return [Google::Apis::WebsecurityscannerV1::ScanRunErrorTrace] attr_accessor :error_trace @@ -729,24 +711,22 @@ module Google attr_accessor :has_vulnerabilities alias_method :has_vulnerabilities?, :has_vulnerabilities - # Output only. The resource name of the ScanRun. The name follows the format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'. - # The ScanRun IDs are generated by the system. + # Output only. The resource name of the ScanRun. The name follows the format of ' + # projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'. The + # ScanRun IDs are generated by the system. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Output only. The percentage of total completion ranging from 0 to 100. - # If the scan is in queue, the value is 0. - # If the scan is running, the value ranges from 0 to 100. - # If the scan is finished, the value is 100. + # Output only. The percentage of total completion ranging from 0 to 100. If the + # scan is in queue, the value is 0. If the scan is running, the value ranges + # from 0 to 100. If the scan is finished, the value is 100. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent # Output only. The result state of the ScanRun. This field is only available - # after the - # execution state reaches "FINISHED". + # after the execution state reaches "FINISHED". # Corresponds to the JSON property `resultState` # @return [String] attr_accessor :result_state @@ -757,16 +737,14 @@ module Google attr_accessor :start_time # Output only. The number of URLs crawled during this ScanRun. If the scan is in - # progress, - # the value represents the number of URLs crawled up to now. + # progress, the value represents the number of URLs crawled up to now. # Corresponds to the JSON property `urlsCrawledCount` # @return [Fixnum] attr_accessor :urls_crawled_count # Output only. The number of URLs tested during this ScanRun. If the scan is in - # progress, - # the value represents the number of URLs tested up to now. The number of - # URLs tested is usually larger than the number URLS crawled because + # progress, the value represents the number of URLs tested up to now. The number + # of URLs tested is usually larger than the number URLS crawled because # typically a crawled URL is tested with multiple test payloads. # Corresponds to the JSON property `urlsTestedCount` # @return [Fixnum] @@ -797,8 +775,7 @@ module Google end end - # Output only. - # Defines an error trace message for a ScanRun. + # Output only. Defines an error trace message for a ScanRun. class ScanRunErrorTrace include Google::Apis::Core::Hashable @@ -808,9 +785,8 @@ module Google attr_accessor :code # Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates - # the most - # common HTTP error code, if such is available. For example, if this code is - # 404, the scan has encountered too many NOT_FOUND responses. + # the most common HTTP error code, if such is available. For example, if this + # code is 404, the scan has encountered too many NOT_FOUND responses. # Corresponds to the JSON property `mostCommonHttpErrorCode` # @return [Fixnum] attr_accessor :most_common_http_error_code @@ -835,9 +811,9 @@ module Google end end - # Output only. - # Defines a warning trace message for ScanRun. Warning traces provide customers - # with useful information that helps make the scanning process more effective. + # Output only. Defines a warning trace message for ScanRun. Warning traces + # provide customers with useful information that helps make the scanning process + # more effective. class ScanRunWarningTrace include Google::Apis::Core::Hashable @@ -866,8 +842,8 @@ module Google attr_accessor :interval_duration_days # A timestamp indicates when the next run will be scheduled. The value is - # refreshed by the server after each run. If unspecified, it will default - # to current server time, which means the scan will be scheduled to start + # refreshed by the server after each run. If unspecified, it will default to + # current server time, which means the scan will be scheduled to start # immediately. # Corresponds to the JSON property `scheduleTime` # @return [String] @@ -910,8 +886,8 @@ module Google end end - # Information regarding any resource causing the vulnerability such - # as JavaScript sources, image, audio files, etc. + # Information regarding any resource causing the vulnerability such as + # JavaScript sources, image, audio files, etc. class ViolatingResource include Google::Apis::Core::Hashable diff --git a/generated/google/apis/websecurityscanner_v1/service.rb b/generated/google/apis/websecurityscanner_v1/service.rb index 7989b6b82..966ffce74 100644 --- a/generated/google/apis/websecurityscanner_v1/service.rb +++ b/generated/google/apis/websecurityscanner_v1/service.rb @@ -50,8 +50,7 @@ module Google # Creates a new ScanConfig. # @param [String] parent # Required. The parent resource name where the scan is created, which should be - # a - # project resource name in the format 'projects/`projectId`'. + # a project resource name in the format 'projects/`projectId`'. # @param [Google::Apis::WebsecurityscannerV1::ScanConfig] scan_config_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -85,8 +84,7 @@ module Google # Deletes an existing ScanConfig and its child resources. # @param [String] name # Required. The resource name of the ScanConfig to be deleted. The name follows - # the - # format of 'projects/`projectId`/scanConfigs/`scanConfigId`'. + # the format of 'projects/`projectId`/scanConfigs/`scanConfigId`'. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -117,8 +115,7 @@ module Google # Gets a ScanConfig. # @param [String] name # Required. The resource name of the ScanConfig to be returned. The name follows - # the - # format of 'projects/`projectId`/scanConfigs/`scanConfigId`'. + # the format of 'projects/`projectId`/scanConfigs/`scanConfigId`'. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -149,16 +146,14 @@ module Google # Lists ScanConfigs under a given project. # @param [String] parent # Required. The parent resource name, which should be a project resource name in - # the - # format 'projects/`projectId`'. + # the format 'projects/`projectId`'. # @param [Fixnum] page_size - # The maximum number of ScanConfigs to return, can be limited by server. - # If not specified or not positive, the implementation will select a - # reasonable value. + # The maximum number of ScanConfigs to return, can be limited by server. If not + # specified or not positive, the implementation will select a reasonable value. # @param [String] page_token - # A token identifying a page of results to be returned. This should be a - # `next_page_token` value returned from a previous List request. - # If unspecified, the first page of results is returned. + # A token identifying a page of results to be returned. This should be a ` + # next_page_token` value returned from a previous List request. If unspecified, + # the first page of results is returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -190,16 +185,14 @@ module Google # Updates a ScanConfig. This method support partial update of a ScanConfig. # @param [String] name - # The resource name of the ScanConfig. The name follows the format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`'. The ScanConfig IDs are - # generated by the system. + # The resource name of the ScanConfig. The name follows the format of 'projects/` + # projectId`/scanConfigs/`scanConfigId`'. The ScanConfig IDs are generated by + # the system. # @param [Google::Apis::WebsecurityscannerV1::ScanConfig] scan_config_object # @param [String] update_mask # Required. The update mask applies to the resource. For the `FieldMask` - # definition, - # see - # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# - # fieldmask + # definition, see https://developers.google.com/protocol-buffers/docs/reference/ + # google.protobuf#fieldmask # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -267,9 +260,8 @@ module Google # Gets a ScanRun. # @param [String] name # Required. The resource name of the ScanRun to be returned. The name follows - # the - # format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'. + # the format of 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/` + # scanRunId`'. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -297,20 +289,18 @@ module Google execute_or_queue_command(command, &block) end - # Lists ScanRuns under a given ScanConfig, in descending order of ScanRun - # stop time. + # Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop + # time. # @param [String] parent # Required. The parent resource name, which should be a scan resource name in - # the - # format 'projects/`projectId`/scanConfigs/`scanConfigId`'. + # the format 'projects/`projectId`/scanConfigs/`scanConfigId`'. # @param [Fixnum] page_size - # The maximum number of ScanRuns to return, can be limited by server. - # If not specified or not positive, the implementation will select a - # reasonable value. + # The maximum number of ScanRuns to return, can be limited by server. If not + # specified or not positive, the implementation will select a reasonable value. # @param [String] page_token - # A token identifying a page of results to be returned. This should be a - # `next_page_token` value returned from a previous List request. - # If unspecified, the first page of results is returned. + # A token identifying a page of results to be returned. This should be a ` + # next_page_token` value returned from a previous List request. If unspecified, + # the first page of results is returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -343,8 +333,8 @@ module Google # Stops a ScanRun. The stopped ScanRun is returned. # @param [String] name # Required. The resource name of the ScanRun to be stopped. The name follows the - # format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'. + # format of 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId` + # '. # @param [Google::Apis::WebsecurityscannerV1::StopScanRunRequest] stop_scan_run_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -378,17 +368,15 @@ module Google # List CrawledUrls under a given ScanRun. # @param [String] parent # Required. The parent resource name, which should be a scan run resource name - # in the - # format - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'. + # in the format 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/` + # scanRunId`'. # @param [Fixnum] page_size - # The maximum number of CrawledUrls to return, can be limited by server. - # If not specified or not positive, the implementation will select a - # reasonable value. + # The maximum number of CrawledUrls to return, can be limited by server. If not + # specified or not positive, the implementation will select a reasonable value. # @param [String] page_token - # A token identifying a page of results to be returned. This should be a - # `next_page_token` value returned from a previous List request. - # If unspecified, the first page of results is returned. + # A token identifying a page of results to be returned. This should be a ` + # next_page_token` value returned from a previous List request. If unspecified, + # the first page of results is returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -421,9 +409,8 @@ module Google # List all FindingTypeStats under a given ScanRun. # @param [String] parent # Required. The parent resource name, which should be a scan run resource name - # in the - # format - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'. + # in the format 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/` + # scanRunId`'. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -454,10 +441,8 @@ module Google # Gets a Finding. # @param [String] name # Required. The resource name of the Finding to be returned. The name follows - # the - # format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`/findings/ - # `findingId`'. + # the format of 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/` + # scanRunId`/findings/`findingId`'. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -488,22 +473,18 @@ module Google # List Findings under a given ScanRun. # @param [String] parent # Required. The parent resource name, which should be a scan run resource name - # in the - # format - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'. + # in the format 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/` + # scanRunId`'. # @param [String] filter - # The filter expression. The expression must be in the format: - # . - # Supported field: 'finding_type'. - # Supported operator: '='. + # The filter expression. The expression must be in the format: . Supported field: + # 'finding_type'. Supported operator: '='. # @param [Fixnum] page_size - # The maximum number of Findings to return, can be limited by server. - # If not specified or not positive, the implementation will select a - # reasonable value. + # The maximum number of Findings to return, can be limited by server. If not + # specified or not positive, the implementation will select a reasonable value. # @param [String] page_token - # A token identifying a page of results to be returned. This should be a - # `next_page_token` value returned from a previous List request. - # If unspecified, the first page of results is returned. + # A token identifying a page of results to be returned. This should be a ` + # next_page_token` value returned from a previous List request. If unspecified, + # the first page of results is returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/websecurityscanner_v1alpha.rb b/generated/google/apis/websecurityscanner_v1alpha.rb index 65ec28d98..a25b8a857 100644 --- a/generated/google/apis/websecurityscanner_v1alpha.rb +++ b/generated/google/apis/websecurityscanner_v1alpha.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/ module WebsecurityscannerV1alpha VERSION = 'V1alpha' - REVISION = '20200516' + REVISION = '20200801' # 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/websecurityscanner_v1alpha/classes.rb b/generated/google/apis/websecurityscanner_v1alpha/classes.rb index 980f51d39..ebf200017 100644 --- a/generated/google/apis/websecurityscanner_v1alpha/classes.rb +++ b/generated/google/apis/websecurityscanner_v1alpha/classes.rb @@ -91,8 +91,7 @@ module Google attr_accessor :login_url # Required. Input only. The password of the custom account. The credential is - # stored encrypted - # and not returned in any response nor included in audit logs. + # stored encrypted and not returned in any response nor included in audit logs. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password @@ -114,13 +113,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 @@ -158,8 +155,8 @@ module Google # @return [String] attr_accessor :finding_type - # If the vulnerability was originated from nested IFrame, the immediate - # parent IFrame is reported. + # If the vulnerability was originated from nested IFrame, the immediate parent + # IFrame is reported. # Corresponds to the JSON property `frameUrl` # @return [String] attr_accessor :frame_url @@ -170,16 +167,14 @@ module Google # @return [String] attr_accessor :fuzzed_url - # The http method of the request that triggered the vulnerability, in - # uppercase. + # The http method of the request that triggered the vulnerability, in uppercase. # Corresponds to the JSON property `httpMethod` # @return [String] attr_accessor :http_method - # The resource name of the Finding. The name follows the format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanruns/`scanRunId`/findings/ - # `findingId`'. - # The finding IDs are generated by the system. + # The resource name of the Finding. The name follows the format of 'projects/` + # projectId`/scanConfigs/`scanConfigId`/scanruns/`scanRunId`/findings/`findingId` + # '. The finding IDs are generated by the system. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -189,20 +184,20 @@ module Google # @return [Google::Apis::WebsecurityscannerV1alpha::OutdatedLibrary] attr_accessor :outdated_library - # The URL containing human-readable payload that user can leverage to - # reproduce the vulnerability. + # The URL containing human-readable payload that user can leverage to reproduce + # the vulnerability. # Corresponds to the JSON property `reproductionUrl` # @return [String] attr_accessor :reproduction_url - # The tracking ID uniquely identifies a vulnerability instance across - # multiple ScanRuns. + # The tracking ID uniquely identifies a vulnerability instance across multiple + # ScanRuns. # Corresponds to the JSON property `trackingId` # @return [String] attr_accessor :tracking_id - # Information regarding any resource causing the vulnerability such - # as JavaScript sources, image, audio files, etc. + # Information regarding any resource causing the vulnerability such as + # JavaScript sources, image, audio files, etc. # Corresponds to the JSON property `violatingResource` # @return [Google::Apis::WebsecurityscannerV1alpha::ViolatingResource] attr_accessor :violating_resource @@ -277,8 +272,7 @@ module Google include Google::Apis::Core::Hashable # Required. Input only. The password of the Google account. The credential is - # stored encrypted - # and not returned in any response nor included in audit logs. + # stored encrypted and not returned in any response nor included in audit logs. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password @@ -333,8 +327,8 @@ module Google # @return [Array] attr_accessor :crawled_urls - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -378,8 +372,8 @@ module Google # @return [Array] attr_accessor :findings - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -399,8 +393,8 @@ module Google class ListScanConfigsResponse include Google::Apis::Core::Hashable - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -425,8 +419,8 @@ module Google class ListScanRunsResponse include Google::Apis::Core::Hashable - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -478,8 +472,8 @@ module Google end end - # A ScanConfig resource contains the configurations to launch a scan. - # next id: 12 + # A ScanConfig resource contains the configurations to launch a scan. next id: + # 12 class ScanConfig include Google::Apis::Core::Hashable @@ -488,9 +482,8 @@ module Google # @return [Google::Apis::WebsecurityscannerV1alpha::Authentication] attr_accessor :authentication - # The excluded URL patterns as described in - # https://cloud.google.com/security-command-center/docs/how-to-use-web-security- - # scanner#excluding_urls + # The excluded URL patterns as described in https://cloud.google.com/security- + # command-center/docs/how-to-use-web-security-scanner#excluding_urls # Corresponds to the JSON property `blacklistPatterns` # @return [Array] attr_accessor :blacklist_patterns @@ -505,17 +498,17 @@ module Google # @return [Google::Apis::WebsecurityscannerV1alpha::ScanRun] attr_accessor :latest_run - # The maximum QPS during scanning. A valid value ranges from 5 to 20 - # inclusively. If the field is unspecified or its value is set 0, server will - # default to 15. Other values outside of [5, 20] range will be rejected with - # INVALID_ARGUMENT error. + # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. + # If the field is unspecified or its value is set 0, server will default to 15. + # Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT + # error. # Corresponds to the JSON property `maxQps` # @return [Fixnum] attr_accessor :max_qps - # The resource name of the ScanConfig. The name follows the format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`'. The ScanConfig IDs are - # generated by the system. + # The resource name of the ScanConfig. The name follows the format of 'projects/` + # projectId`/scanConfigs/`scanConfigId`'. The ScanConfig IDs are generated by + # the system. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -530,8 +523,8 @@ module Google # @return [Array] attr_accessor :starting_urls - # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE - # will be used as a default. + # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will + # be used as a default. # Corresponds to the JSON property `targetPlatforms` # @return [Array] attr_accessor :target_platforms @@ -564,8 +557,8 @@ module Google class ScanRun include Google::Apis::Core::Hashable - # The time at which the ScanRun reached termination state - that the ScanRun - # is either finished or stopped by user. + # The time at which the ScanRun reached termination state - that the ScanRun is + # either finished or stopped by user. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time @@ -581,16 +574,15 @@ module Google attr_accessor :has_vulnerabilities alias_method :has_vulnerabilities?, :has_vulnerabilities - # The resource name of the ScanRun. The name follows the format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'. - # The ScanRun IDs are generated by the system. + # The resource name of the ScanRun. The name follows the format of 'projects/` + # projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'. The ScanRun IDs + # are generated by the system. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The percentage of total completion ranging from 0 to 100. - # If the scan is in queue, the value is 0. - # If the scan is running, the value ranges from 0 to 100. + # The percentage of total completion ranging from 0 to 100. If the scan is in + # queue, the value is 0. If the scan is running, the value ranges from 0 to 100. # If the scan is finished, the value is 100. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] @@ -613,10 +605,10 @@ module Google # @return [Fixnum] attr_accessor :urls_crawled_count - # The number of URLs tested during this ScanRun. If the scan is in progress, - # the value represents the number of URLs tested up to now. The number of - # URLs tested is usually larger than the number URLS crawled because - # typically a crawled URL is tested with multiple test payloads. + # The number of URLs tested during this ScanRun. If the scan is in progress, the + # value represents the number of URLs tested up to now. The number of URLs + # tested is usually larger than the number URLS crawled because typically a + # crawled URL is tested with multiple test payloads. # Corresponds to the JSON property `urlsTestedCount` # @return [Fixnum] attr_accessor :urls_tested_count @@ -649,8 +641,8 @@ module Google attr_accessor :interval_duration_days # A timestamp indicates when the next run will be scheduled. The value is - # refreshed by the server after each run. If unspecified, it will default - # to current server time, which means the scan will be scheduled to start + # refreshed by the server after each run. If unspecified, it will default to + # current server time, which means the scan will be scheduled to start # immediately. # Corresponds to the JSON property `scheduleTime` # @return [String] @@ -693,8 +685,8 @@ module Google end end - # Information regarding any resource causing the vulnerability such - # as JavaScript sources, image, audio files, etc. + # Information regarding any resource causing the vulnerability such as + # JavaScript sources, image, audio files, etc. class ViolatingResource include Google::Apis::Core::Hashable diff --git a/generated/google/apis/websecurityscanner_v1alpha/service.rb b/generated/google/apis/websecurityscanner_v1alpha/service.rb index 99f6ffce1..0441eaea0 100644 --- a/generated/google/apis/websecurityscanner_v1alpha/service.rb +++ b/generated/google/apis/websecurityscanner_v1alpha/service.rb @@ -50,8 +50,7 @@ module Google # Creates a new ScanConfig. # @param [String] parent # Required. The parent resource name where the scan is created, which should be - # a - # project resource name in the format 'projects/`projectId`'. + # a project resource name in the format 'projects/`projectId`'. # @param [Google::Apis::WebsecurityscannerV1alpha::ScanConfig] scan_config_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -85,8 +84,7 @@ module Google # Deletes an existing ScanConfig and its child resources. # @param [String] name # Required. The resource name of the ScanConfig to be deleted. The name follows - # the - # format of 'projects/`projectId`/scanConfigs/`scanConfigId`'. + # the format of 'projects/`projectId`/scanConfigs/`scanConfigId`'. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -117,8 +115,7 @@ module Google # Gets a ScanConfig. # @param [String] name # Required. The resource name of the ScanConfig to be returned. The name follows - # the - # format of 'projects/`projectId`/scanConfigs/`scanConfigId`'. + # the format of 'projects/`projectId`/scanConfigs/`scanConfigId`'. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -149,16 +146,14 @@ module Google # Lists ScanConfigs under a given project. # @param [String] parent # Required. The parent resource name, which should be a project resource name in - # the - # format 'projects/`projectId`'. + # the format 'projects/`projectId`'. # @param [Fixnum] page_size - # The maximum number of ScanConfigs to return, can be limited by server. - # If not specified or not positive, the implementation will select a - # reasonable value. + # The maximum number of ScanConfigs to return, can be limited by server. If not + # specified or not positive, the implementation will select a reasonable value. # @param [String] page_token - # A token identifying a page of results to be returned. This should be a - # `next_page_token` value returned from a previous List request. - # If unspecified, the first page of results is returned. + # A token identifying a page of results to be returned. This should be a ` + # next_page_token` value returned from a previous List request. If unspecified, + # the first page of results is returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -190,16 +185,14 @@ module Google # Updates a ScanConfig. This method support partial update of a ScanConfig. # @param [String] name - # The resource name of the ScanConfig. The name follows the format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`'. The ScanConfig IDs are - # generated by the system. + # The resource name of the ScanConfig. The name follows the format of 'projects/` + # projectId`/scanConfigs/`scanConfigId`'. The ScanConfig IDs are generated by + # the system. # @param [Google::Apis::WebsecurityscannerV1alpha::ScanConfig] scan_config_object # @param [String] update_mask # Required. The update mask applies to the resource. For the `FieldMask` - # definition, - # see - # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# - # fieldmask + # definition, see https://developers.google.com/protocol-buffers/docs/reference/ + # google.protobuf#fieldmask # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -267,9 +260,8 @@ module Google # Gets a ScanRun. # @param [String] name # Required. The resource name of the ScanRun to be returned. The name follows - # the - # format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'. + # the format of 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/` + # scanRunId`'. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -297,20 +289,18 @@ module Google execute_or_queue_command(command, &block) end - # Lists ScanRuns under a given ScanConfig, in descending order of ScanRun - # stop time. + # Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop + # time. # @param [String] parent # Required. The parent resource name, which should be a scan resource name in - # the - # format 'projects/`projectId`/scanConfigs/`scanConfigId`'. + # the format 'projects/`projectId`/scanConfigs/`scanConfigId`'. # @param [Fixnum] page_size - # The maximum number of ScanRuns to return, can be limited by server. - # If not specified or not positive, the implementation will select a - # reasonable value. + # The maximum number of ScanRuns to return, can be limited by server. If not + # specified or not positive, the implementation will select a reasonable value. # @param [String] page_token - # A token identifying a page of results to be returned. This should be a - # `next_page_token` value returned from a previous List request. - # If unspecified, the first page of results is returned. + # A token identifying a page of results to be returned. This should be a ` + # next_page_token` value returned from a previous List request. If unspecified, + # the first page of results is returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -343,8 +333,8 @@ module Google # Stops a ScanRun. The stopped ScanRun is returned. # @param [String] name # Required. The resource name of the ScanRun to be stopped. The name follows the - # format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'. + # format of 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId` + # '. # @param [Google::Apis::WebsecurityscannerV1alpha::StopScanRunRequest] stop_scan_run_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -378,17 +368,15 @@ module Google # List CrawledUrls under a given ScanRun. # @param [String] parent # Required. The parent resource name, which should be a scan run resource name - # in the - # format - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'. + # in the format 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/` + # scanRunId`'. # @param [Fixnum] page_size - # The maximum number of CrawledUrls to return, can be limited by server. - # If not specified or not positive, the implementation will select a - # reasonable value. + # The maximum number of CrawledUrls to return, can be limited by server. If not + # specified or not positive, the implementation will select a reasonable value. # @param [String] page_token - # A token identifying a page of results to be returned. This should be a - # `next_page_token` value returned from a previous List request. - # If unspecified, the first page of results is returned. + # A token identifying a page of results to be returned. This should be a ` + # next_page_token` value returned from a previous List request. If unspecified, + # the first page of results is returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -421,9 +409,8 @@ module Google # List all FindingTypeStats under a given ScanRun. # @param [String] parent # Required. The parent resource name, which should be a scan run resource name - # in the - # format - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'. + # in the format 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/` + # scanRunId`'. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -454,10 +441,8 @@ module Google # Gets a Finding. # @param [String] name # Required. The resource name of the Finding to be returned. The name follows - # the - # format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`/findings/ - # `findingId`'. + # the format of 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/` + # scanRunId`/findings/`findingId`'. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -488,22 +473,18 @@ module Google # List Findings under a given ScanRun. # @param [String] parent # Required. The parent resource name, which should be a scan run resource name - # in the - # format - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'. + # in the format 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/` + # scanRunId`'. # @param [String] filter - # Required. The filter expression. The expression must be in the format: - # . - # Supported field: 'finding_type'. - # Supported operator: '='. + # Required. The filter expression. The expression must be in the format: . + # Supported field: 'finding_type'. Supported operator: '='. # @param [Fixnum] page_size - # The maximum number of Findings to return, can be limited by server. - # If not specified or not positive, the implementation will select a - # reasonable value. + # The maximum number of Findings to return, can be limited by server. If not + # specified or not positive, the implementation will select a reasonable value. # @param [String] page_token - # A token identifying a page of results to be returned. This should be a - # `next_page_token` value returned from a previous List request. - # If unspecified, the first page of results is returned. + # A token identifying a page of results to be returned. This should be a ` + # next_page_token` value returned from a previous List request. If unspecified, + # the first page of results is returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/websecurityscanner_v1beta.rb b/generated/google/apis/websecurityscanner_v1beta.rb index acac82c9f..309ef4cf3 100644 --- a/generated/google/apis/websecurityscanner_v1beta.rb +++ b/generated/google/apis/websecurityscanner_v1beta.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/ module WebsecurityscannerV1beta VERSION = 'V1beta' - REVISION = '20200516' + REVISION = '20200801' # 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/websecurityscanner_v1beta/classes.rb b/generated/google/apis/websecurityscanner_v1beta/classes.rb index 5be846ddf..128e295d3 100644 --- a/generated/google/apis/websecurityscanner_v1beta/classes.rb +++ b/generated/google/apis/websecurityscanner_v1beta/classes.rb @@ -64,8 +64,7 @@ module Google # @return [String] attr_accessor :body - # The http method of the request that was used to visit the URL, in - # uppercase. + # The http method of the request that was used to visit the URL, in uppercase. # Corresponds to the JSON property `httpMethod` # @return [String] attr_accessor :http_method @@ -97,8 +96,7 @@ module Google attr_accessor :login_url # Required. Input only. The password of the custom account. The credential is - # stored encrypted - # and not returned in any response nor included in audit logs. + # stored encrypted and not returned in any response nor included in audit logs. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password @@ -120,13 +118,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 @@ -159,10 +155,9 @@ module Google # @return [String] attr_accessor :final_url - # The type of the Finding. - # Detailed and up-to-date information on findings can be found here: - # https://cloud.google.com/security-command-center/docs/how-to-remediate-web- - # security-scanner + # The type of the Finding. Detailed and up-to-date information on findings can + # be found here: https://cloud.google.com/security-command-center/docs/how-to- + # remediate-web-security-scanner # Corresponds to the JSON property `findingType` # @return [String] attr_accessor :finding_type @@ -172,8 +167,8 @@ module Google # @return [Google::Apis::WebsecurityscannerV1beta::Form] attr_accessor :form - # If the vulnerability was originated from nested IFrame, the immediate - # parent IFrame is reported. + # If the vulnerability was originated from nested IFrame, the immediate parent + # IFrame is reported. # Corresponds to the JSON property `frameUrl` # @return [String] attr_accessor :frame_url @@ -184,16 +179,14 @@ module Google # @return [String] attr_accessor :fuzzed_url - # The http method of the request that triggered the vulnerability, in - # uppercase. + # The http method of the request that triggered the vulnerability, in uppercase. # Corresponds to the JSON property `httpMethod` # @return [String] attr_accessor :http_method - # The resource name of the Finding. The name follows the format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanruns/`scanRunId`/findings/ - # `findingId`'. - # The finding IDs are generated by the system. + # The resource name of the Finding. The name follows the format of 'projects/` + # projectId`/scanConfigs/`scanConfigId`/scanruns/`scanRunId`/findings/`findingId` + # '. The finding IDs are generated by the system. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -203,8 +196,8 @@ module Google # @return [Google::Apis::WebsecurityscannerV1beta::OutdatedLibrary] attr_accessor :outdated_library - # The URL containing human-readable payload that user can leverage to - # reproduce the vulnerability. + # The URL containing human-readable payload that user can leverage to reproduce + # the vulnerability. # Corresponds to the JSON property `reproductionUrl` # @return [String] attr_accessor :reproduction_url @@ -214,14 +207,14 @@ module Google # @return [String] attr_accessor :severity - # The tracking ID uniquely identifies a vulnerability instance across - # multiple ScanRuns. + # The tracking ID uniquely identifies a vulnerability instance across multiple + # ScanRuns. # Corresponds to the JSON property `trackingId` # @return [String] attr_accessor :tracking_id - # Information regarding any resource causing the vulnerability such - # as JavaScript sources, image, audio files, etc. + # Information regarding any resource causing the vulnerability such as + # JavaScript sources, image, audio files, etc. # Corresponds to the JSON property `violatingResource` # @return [Google::Apis::WebsecurityscannerV1beta::ViolatingResource] attr_accessor :violating_resource @@ -323,8 +316,7 @@ module Google include Google::Apis::Core::Hashable # Required. Input only. The password of the Google account. The credential is - # stored encrypted - # and not returned in any response nor included in audit logs. + # stored encrypted and not returned in any response nor included in audit logs. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password @@ -374,8 +366,8 @@ module Google class IapCredential include Google::Apis::Core::Hashable - # Describes authentication configuration when Web-Security-Scanner - # service account is added in Identity-Aware-Proxy (IAP) access policies. + # Describes authentication configuration when Web-Security-Scanner service + # account is added in Identity-Aware-Proxy (IAP) access policies. # Corresponds to the JSON property `iapTestServiceAccountInfo` # @return [Google::Apis::WebsecurityscannerV1beta::IapTestServiceAccountInfo] attr_accessor :iap_test_service_account_info @@ -390,13 +382,13 @@ module Google end end - # Describes authentication configuration when Web-Security-Scanner - # service account is added in Identity-Aware-Proxy (IAP) access policies. + # Describes authentication configuration when Web-Security-Scanner service + # account is added in Identity-Aware-Proxy (IAP) access policies. class IapTestServiceAccountInfo include Google::Apis::Core::Hashable - # Required. Describes OAuth2 Client ID of resources protected by - # Identity-Aware-Proxy(IAP). + # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware- + # Proxy(IAP). # Corresponds to the JSON property `targetAudienceClientId` # @return [String] attr_accessor :target_audience_client_id @@ -420,8 +412,8 @@ module Google # @return [Array] attr_accessor :crawled_urls - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -465,8 +457,8 @@ module Google # @return [Array] attr_accessor :findings - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -486,8 +478,8 @@ module Google class ListScanConfigsResponse include Google::Apis::Core::Hashable - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -512,8 +504,8 @@ module Google class ListScanRunsResponse include Google::Apis::Core::Hashable - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -574,9 +566,8 @@ module Google # @return [Google::Apis::WebsecurityscannerV1beta::Authentication] attr_accessor :authentication - # The excluded URL patterns as described in - # https://cloud.google.com/security-command-center/docs/how-to-use-web-security- - # scanner#excluding_urls + # The excluded URL patterns as described in https://cloud.google.com/security- + # command-center/docs/how-to-use-web-security-scanner#excluding_urls # Corresponds to the JSON property `blacklistPatterns` # @return [Array] attr_accessor :blacklist_patterns @@ -586,8 +577,7 @@ module Google # @return [String] attr_accessor :display_name - # Controls export of scan configurations and results to Security - # Command Center. + # Controls export of scan configurations and results to Security Command Center. # Corresponds to the JSON property `exportToSecurityCommandCenter` # @return [String] attr_accessor :export_to_security_command_center @@ -598,24 +588,23 @@ module Google # @return [Google::Apis::WebsecurityscannerV1beta::ScanRun] attr_accessor :latest_run - # Whether the scan config is managed by Web Security Scanner, output - # only. + # Whether the scan config is managed by Web Security Scanner, output only. # Corresponds to the JSON property `managedScan` # @return [Boolean] attr_accessor :managed_scan alias_method :managed_scan?, :managed_scan - # The maximum QPS during scanning. A valid value ranges from 5 to 20 - # inclusively. If the field is unspecified or its value is set 0, server will - # default to 15. Other values outside of [5, 20] range will be rejected with - # INVALID_ARGUMENT error. + # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. + # If the field is unspecified or its value is set 0, server will default to 15. + # Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT + # error. # Corresponds to the JSON property `maxQps` # @return [Fixnum] attr_accessor :max_qps - # The resource name of the ScanConfig. The name follows the format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`'. The ScanConfig IDs are - # generated by the system. + # The resource name of the ScanConfig. The name follows the format of 'projects/` + # projectId`/scanConfigs/`scanConfigId`'. The ScanConfig IDs are generated by + # the system. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -635,15 +624,15 @@ module Google # @return [Array] attr_accessor :starting_urls - # Whether the scan configuration has enabled static IP address scan feature. - # If enabled, the scanner will access applications from static IP addresses. + # Whether the scan configuration has enabled static IP address scan feature. If + # enabled, the scanner will access applications from static IP addresses. # Corresponds to the JSON property `staticIpScan` # @return [Boolean] attr_accessor :static_ip_scan alias_method :static_ip_scan?, :static_ip_scan - # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE - # will be used as a default. + # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will + # be used as a default. # Corresponds to the JSON property `targetPlatforms` # @return [Array] attr_accessor :target_platforms @@ -688,10 +677,9 @@ module Google # @return [String] attr_accessor :code - # Indicates the full name of the ScanConfig field that triggers this error, - # for example "scan_config.max_qps". This field is provided for - # troubleshooting purposes only and its actual value can change in the - # future. + # Indicates the full name of the ScanConfig field that triggers this error, for + # example "scan_config.max_qps". This field is provided for troubleshooting + # purposes only and its actual value can change in the future. # Corresponds to the JSON property `fieldName` # @return [String] attr_accessor :field_name @@ -712,14 +700,13 @@ module Google class ScanRun include Google::Apis::Core::Hashable - # The time at which the ScanRun reached termination state - that the ScanRun - # is either finished or stopped by user. + # The time at which the ScanRun reached termination state - that the ScanRun is + # either finished or stopped by user. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. - # Defines an error trace message for a ScanRun. + # Output only. Defines an error trace message for a ScanRun. # Corresponds to the JSON property `errorTrace` # @return [Google::Apis::WebsecurityscannerV1beta::ScanRunErrorTrace] attr_accessor :error_trace @@ -735,16 +722,15 @@ module Google attr_accessor :has_vulnerabilities alias_method :has_vulnerabilities?, :has_vulnerabilities - # The resource name of the ScanRun. The name follows the format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'. - # The ScanRun IDs are generated by the system. + # The resource name of the ScanRun. The name follows the format of 'projects/` + # projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'. The ScanRun IDs + # are generated by the system. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The percentage of total completion ranging from 0 to 100. - # If the scan is in queue, the value is 0. - # If the scan is running, the value ranges from 0 to 100. + # The percentage of total completion ranging from 0 to 100. If the scan is in + # queue, the value is 0. If the scan is running, the value ranges from 0 to 100. # If the scan is finished, the value is 100. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] @@ -767,10 +753,10 @@ module Google # @return [Fixnum] attr_accessor :urls_crawled_count - # The number of URLs tested during this ScanRun. If the scan is in progress, - # the value represents the number of URLs tested up to now. The number of - # URLs tested is usually larger than the number URLS crawled because - # typically a crawled URL is tested with multiple test payloads. + # The number of URLs tested during this ScanRun. If the scan is in progress, the + # value represents the number of URLs tested up to now. The number of URLs + # tested is usually larger than the number URLS crawled because typically a + # crawled URL is tested with multiple test payloads. # Corresponds to the JSON property `urlsTestedCount` # @return [Fixnum] attr_accessor :urls_tested_count @@ -800,8 +786,7 @@ module Google end end - # Output only. - # Defines an error trace message for a ScanRun. + # Output only. Defines an error trace message for a ScanRun. class ScanRunErrorTrace include Google::Apis::Core::Hashable @@ -811,8 +796,8 @@ module Google attr_accessor :code # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most - # common HTTP error code, if such is available. For example, if this code is - # 404, the scan has encountered too many NOT_FOUND responses. + # common HTTP error code, if such is available. For example, if this code is 404, + # the scan has encountered too many NOT_FOUND responses. # Corresponds to the JSON property `mostCommonHttpErrorCode` # @return [Fixnum] attr_accessor :most_common_http_error_code @@ -837,9 +822,9 @@ module Google end end - # Output only. - # Defines a warning trace message for ScanRun. Warning traces provide customers - # with useful information that helps make the scanning process more effective. + # Output only. Defines a warning trace message for ScanRun. Warning traces + # provide customers with useful information that helps make the scanning process + # more effective. class ScanRunWarningTrace include Google::Apis::Core::Hashable @@ -868,8 +853,8 @@ module Google attr_accessor :interval_duration_days # A timestamp indicates when the next run will be scheduled. The value is - # refreshed by the server after each run. If unspecified, it will default - # to current server time, which means the scan will be scheduled to start + # refreshed by the server after each run. If unspecified, it will default to + # current server time, which means the scan will be scheduled to start # immediately. # Corresponds to the JSON property `scheduleTime` # @return [String] @@ -912,8 +897,8 @@ module Google end end - # Information regarding any resource causing the vulnerability such - # as JavaScript sources, image, audio files, etc. + # Information regarding any resource causing the vulnerability such as + # JavaScript sources, image, audio files, etc. class ViolatingResource include Google::Apis::Core::Hashable diff --git a/generated/google/apis/websecurityscanner_v1beta/service.rb b/generated/google/apis/websecurityscanner_v1beta/service.rb index 54d1b3848..8dd6c6d6c 100644 --- a/generated/google/apis/websecurityscanner_v1beta/service.rb +++ b/generated/google/apis/websecurityscanner_v1beta/service.rb @@ -50,8 +50,7 @@ module Google # Creates a new ScanConfig. # @param [String] parent # Required. The parent resource name where the scan is created, which should be - # a - # project resource name in the format 'projects/`projectId`'. + # a project resource name in the format 'projects/`projectId`'. # @param [Google::Apis::WebsecurityscannerV1beta::ScanConfig] scan_config_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -85,8 +84,7 @@ module Google # Deletes an existing ScanConfig and its child resources. # @param [String] name # Required. The resource name of the ScanConfig to be deleted. The name follows - # the - # format of 'projects/`projectId`/scanConfigs/`scanConfigId`'. + # the format of 'projects/`projectId`/scanConfigs/`scanConfigId`'. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -117,8 +115,7 @@ module Google # Gets a ScanConfig. # @param [String] name # Required. The resource name of the ScanConfig to be returned. The name follows - # the - # format of 'projects/`projectId`/scanConfigs/`scanConfigId`'. + # the format of 'projects/`projectId`/scanConfigs/`scanConfigId`'. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -149,16 +146,14 @@ module Google # Lists ScanConfigs under a given project. # @param [String] parent # Required. The parent resource name, which should be a project resource name in - # the - # format 'projects/`projectId`'. + # the format 'projects/`projectId`'. # @param [Fixnum] page_size - # The maximum number of ScanConfigs to return, can be limited by server. - # If not specified or not positive, the implementation will select a - # reasonable value. + # The maximum number of ScanConfigs to return, can be limited by server. If not + # specified or not positive, the implementation will select a reasonable value. # @param [String] page_token - # A token identifying a page of results to be returned. This should be a - # `next_page_token` value returned from a previous List request. - # If unspecified, the first page of results is returned. + # A token identifying a page of results to be returned. This should be a ` + # next_page_token` value returned from a previous List request. If unspecified, + # the first page of results is returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -190,16 +185,14 @@ module Google # Updates a ScanConfig. This method support partial update of a ScanConfig. # @param [String] name - # The resource name of the ScanConfig. The name follows the format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`'. The ScanConfig IDs are - # generated by the system. + # The resource name of the ScanConfig. The name follows the format of 'projects/` + # projectId`/scanConfigs/`scanConfigId`'. The ScanConfig IDs are generated by + # the system. # @param [Google::Apis::WebsecurityscannerV1beta::ScanConfig] scan_config_object # @param [String] update_mask # Required. The update mask applies to the resource. For the `FieldMask` - # definition, - # see - # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# - # fieldmask + # definition, see https://developers.google.com/protocol-buffers/docs/reference/ + # google.protobuf#fieldmask # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -267,9 +260,8 @@ module Google # Gets a ScanRun. # @param [String] name # Required. The resource name of the ScanRun to be returned. The name follows - # the - # format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'. + # the format of 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/` + # scanRunId`'. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -297,20 +289,18 @@ module Google execute_or_queue_command(command, &block) end - # Lists ScanRuns under a given ScanConfig, in descending order of ScanRun - # stop time. + # Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop + # time. # @param [String] parent # Required. The parent resource name, which should be a scan resource name in - # the - # format 'projects/`projectId`/scanConfigs/`scanConfigId`'. + # the format 'projects/`projectId`/scanConfigs/`scanConfigId`'. # @param [Fixnum] page_size - # The maximum number of ScanRuns to return, can be limited by server. - # If not specified or not positive, the implementation will select a - # reasonable value. + # The maximum number of ScanRuns to return, can be limited by server. If not + # specified or not positive, the implementation will select a reasonable value. # @param [String] page_token - # A token identifying a page of results to be returned. This should be a - # `next_page_token` value returned from a previous List request. - # If unspecified, the first page of results is returned. + # A token identifying a page of results to be returned. This should be a ` + # next_page_token` value returned from a previous List request. If unspecified, + # the first page of results is returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -343,8 +333,8 @@ module Google # Stops a ScanRun. The stopped ScanRun is returned. # @param [String] name # Required. The resource name of the ScanRun to be stopped. The name follows the - # format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'. + # format of 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId` + # '. # @param [Google::Apis::WebsecurityscannerV1beta::StopScanRunRequest] stop_scan_run_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -378,17 +368,15 @@ module Google # List CrawledUrls under a given ScanRun. # @param [String] parent # Required. The parent resource name, which should be a scan run resource name - # in the - # format - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'. + # in the format 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/` + # scanRunId`'. # @param [Fixnum] page_size - # The maximum number of CrawledUrls to return, can be limited by server. - # If not specified or not positive, the implementation will select a - # reasonable value. + # The maximum number of CrawledUrls to return, can be limited by server. If not + # specified or not positive, the implementation will select a reasonable value. # @param [String] page_token - # A token identifying a page of results to be returned. This should be a - # `next_page_token` value returned from a previous List request. - # If unspecified, the first page of results is returned. + # A token identifying a page of results to be returned. This should be a ` + # next_page_token` value returned from a previous List request. If unspecified, + # the first page of results is returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -421,9 +409,8 @@ module Google # List all FindingTypeStats under a given ScanRun. # @param [String] parent # Required. The parent resource name, which should be a scan run resource name - # in the - # format - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'. + # in the format 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/` + # scanRunId`'. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -454,10 +441,8 @@ module Google # Gets a Finding. # @param [String] name # Required. The resource name of the Finding to be returned. The name follows - # the - # format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`/findings/ - # `findingId`'. + # the format of 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/` + # scanRunId`/findings/`findingId`'. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -488,22 +473,18 @@ module Google # List Findings under a given ScanRun. # @param [String] parent # Required. The parent resource name, which should be a scan run resource name - # in the - # format - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'. + # in the format 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/` + # scanRunId`'. # @param [String] filter - # Required. The filter expression. The expression must be in the format: - # . - # Supported field: 'finding_type'. - # Supported operator: '='. + # Required. The filter expression. The expression must be in the format: . + # Supported field: 'finding_type'. Supported operator: '='. # @param [Fixnum] page_size - # The maximum number of Findings to return, can be limited by server. - # If not specified or not positive, the implementation will select a - # reasonable value. + # The maximum number of Findings to return, can be limited by server. If not + # specified or not positive, the implementation will select a reasonable value. # @param [String] page_token - # A token identifying a page of results to be returned. This should be a - # `next_page_token` value returned from a previous List request. - # If unspecified, the first page of results is returned. + # A token identifying a page of results to be returned. This should be a ` + # next_page_token` value returned from a previous List request. If unspecified, + # the first page of results is returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/youtube_analytics_v2.rb b/generated/google/apis/youtube_analytics_v2.rb index 16d48778e..d59c5f831 100644 --- a/generated/google/apis/youtube_analytics_v2.rb +++ b/generated/google/apis/youtube_analytics_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/youtube/analytics module YoutubeAnalyticsV2 VERSION = 'V2' - REVISION = '20200215' + REVISION = '20200801' # Manage your YouTube account AUTH_YOUTUBE = 'https://www.googleapis.com/auth/youtube' diff --git a/generated/google/apis/youtube_analytics_v2/classes.rb b/generated/google/apis/youtube_analytics_v2/classes.rb index 94253e64b..449e292be 100644 --- a/generated/google/apis/youtube_analytics_v2/classes.rb +++ b/generated/google/apis/youtube_analytics_v2/classes.rb @@ -26,9 +26,8 @@ module Google class EmptyResponse include Google::Apis::Core::Hashable - # Request Error information. - # The presence of an error field signals that the operation - # has failed. + # Request Error information. The presence of an error field signals that the + # operation has failed. # Corresponds to the JSON property `errors` # @return [Google::Apis::YoutubeAnalyticsV2::Errors] attr_accessor :errors @@ -47,52 +46,44 @@ module Google class ErrorProto include Google::Apis::Core::Hashable - # Error arguments, to be used when building user-friendly error messages - # given the error domain and code. Different error codes require different - # arguments. + # Error arguments, to be used when building user-friendly error messages given + # the error domain and code. Different error codes require different arguments. # Corresponds to the JSON property `argument` # @return [Array] attr_accessor :argument - # Error code in the error domain. This should correspond to - # a value of the enum type whose name is in domain. See - # the core error domain in error_domain.proto. + # Error code in the error domain. This should correspond to a value of the enum + # type whose name is in domain. See the core error domain in error_domain.proto. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # Debugging information, which should not be - # shared externally. + # Debugging information, which should not be shared externally. # Corresponds to the JSON property `debugInfo` # @return [String] attr_accessor :debug_info - # Error domain. RoSy services can define their own - # domain and error codes. This should normally be - # the name of an enum type, such as: gdata.CoreErrorDomain + # Error domain. RoSy services can define their own domain and error codes. This + # should normally be the name of an enum type, such as: gdata.CoreErrorDomain # Corresponds to the JSON property `domain` # @return [String] attr_accessor :domain - # A short explanation for the error, which can be shared outside Google. - # Please set domain, code and arguments whenever possible instead of this - # error message so that external APIs can build safe error messages - # themselves. - # External messages built in a RoSy interface will most likely refer to - # information and concepts that are not available externally and should not - # be exposed. It is safer if external APIs can understand the errors and - # decide what the error message should look like. + # A short explanation for the error, which can be shared outside Google. Please + # set domain, code and arguments whenever possible instead of this error message + # so that external APIs can build safe error messages themselves. External + # messages built in a RoSy interface will most likely refer to information and + # concepts that are not available externally and should not be exposed. It is + # safer if external APIs can understand the errors and decide what the error + # message should look like. # Corresponds to the JSON property `externalErrorMessage` # @return [String] attr_accessor :external_error_message - # Location of the error, as specified by the location type. - # If location_type is PATH, this should be a path to a field that's - # relative to the request, using FieldPath notation - # (net/proto2/util/public/field_path.h). - # Examples: - # authenticated_user.gaia_id - # resource.address[2].country + # Location of the error, as specified by the location type. If location_type is + # PATH, this should be a path to a field that's relative to the request, using + # FieldPath notation (net/proto2/util/public/field_path.h). Examples: + # authenticated_user.gaia_id resource.address[2].country # Corresponds to the JSON property `location` # @return [String] attr_accessor :location @@ -118,15 +109,13 @@ module Google end end - # Request Error information. - # The presence of an error field signals that the operation - # has failed. + # Request Error information. The presence of an error field signals that the + # operation has failed. class Errors include Google::Apis::Core::Hashable - # Global error code. Deprecated and ignored. - # Set custom error codes in ErrorProto.domain and ErrorProto.code - # instead. + # Global error code. Deprecated and ignored. Set custom error codes in + # ErrorProto.domain and ErrorProto.code instead. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code @@ -136,8 +125,8 @@ module Google # @return [Array] attr_accessor :error - # Request identifier generated by the service, which can be - # used to identify the error in the logs + # Request identifier generated by the service, which can be used to identify the + # error in the logs # Corresponds to the JSON property `requestId` # @return [String] attr_accessor :request_id @@ -163,9 +152,8 @@ module Google # @return [Google::Apis::YoutubeAnalyticsV2::GroupContentDetails] attr_accessor :content_details - # Request Error information. - # The presence of an error field signals that the operation - # has failed. + # Request Error information. The presence of an error field signals that the + # operation has failed. # Corresponds to the JSON property `errors` # @return [Google::Apis::YoutubeAnalyticsV2::Errors] attr_accessor :errors @@ -214,12 +202,9 @@ module Google # @return [Fixnum] attr_accessor :item_count - # The type of resources that the group contains. - # Valid values for this property are: - # * `youtube#channel` - # * `youtube#playlist` - # * `youtube#video` - # * `youtubePartner#asset` + # The type of resources that the group contains. Valid values for this property + # are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * ` + # youtubePartner#asset` # Corresponds to the JSON property `itemType` # @return [String] attr_accessor :item_type @@ -239,9 +224,8 @@ module Google class GroupItem include Google::Apis::Core::Hashable - # Request Error information. - # The presence of an error field signals that the operation - # has failed. + # Request Error information. The presence of an error field signals that the + # operation has failed. # Corresponds to the JSON property `errors` # @return [Google::Apis::YoutubeAnalyticsV2::Errors] attr_accessor :errors @@ -251,19 +235,17 @@ module Google # @return [String] attr_accessor :etag - # The ID that YouTube uses to uniquely identify the group that contains the - # item. + # The ID that YouTube uses to uniquely identify the group that contains the item. # Corresponds to the JSON property `groupId` # @return [String] attr_accessor :group_id - # The ID that YouTube uses to uniquely identify the `channel`, `video`, - # `playlist`, or `asset` resource that is included in the group. Note that - # this ID refers specifically to the inclusion of that resource in a - # particular group and is different than the channel ID, video ID, - # playlist ID, or asset ID that uniquely identifies the resource itself. - # The `resource.id` property's value specifies the unique channel, video, - # playlist, or asset ID. + # The ID that YouTube uses to uniquely identify the `channel`, `video`, ` + # playlist`, or `asset` resource that is included in the group. Note that this + # ID refers specifically to the inclusion of that resource in a particular group + # and is different than the channel ID, video ID, playlist ID, or asset ID that + # uniquely identifies the resource itself. The `resource.id` property's value + # specifies the unique channel, video, playlist, or asset ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -304,12 +286,9 @@ module Google # @return [String] attr_accessor :id - # Identifies the type of resource being added to the group. - # Valid values for this property are: - # * `youtube#channel` - # * `youtube#playlist` - # * `youtube#video` - # * `youtubePartner#asset` + # Identifies the type of resource being added to the group. Valid values for + # this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * + # `youtubePartner#asset` # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -329,8 +308,8 @@ module Google class GroupSnippet include Google::Apis::Core::Hashable - # The date and time that the group was created. The value is specified in - # ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + # The date and time that the group was created. The value is specified in ISO + # 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. # Corresponds to the JSON property `publishedAt` # @return [String] attr_accessor :published_at @@ -355,9 +334,8 @@ module Google class ListGroupItemsResponse include Google::Apis::Core::Hashable - # Request Error information. - # The presence of an error field signals that the operation - # has failed. + # Request Error information. The presence of an error field signals that the + # operation has failed. # Corresponds to the JSON property `errors` # @return [Google::Apis::YoutubeAnalyticsV2::Errors] attr_accessor :errors @@ -367,14 +345,14 @@ module Google # @return [String] attr_accessor :etag - # A list of groups that match the API request parameters. Each item in the - # list represents a `groupItem` resource. + # A list of groups that match the API request parameters. Each item in the list + # represents a `groupItem` resource. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # Identifies the API resource's type. The value will be - # `youtube#groupItemListResponse`. + # Identifies the API resource's type. The value will be `youtube# + # groupItemListResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -396,9 +374,8 @@ module Google class ListGroupsResponse include Google::Apis::Core::Hashable - # Request Error information. - # The presence of an error field signals that the operation - # has failed. + # Request Error information. The presence of an error field signals that the + # operation has failed. # Corresponds to the JSON property `errors` # @return [Google::Apis::YoutubeAnalyticsV2::Errors] attr_accessor :errors @@ -408,14 +385,14 @@ module Google # @return [String] attr_accessor :etag - # A list of groups that match the API request parameters. Each item in the - # list represents a `group` resource. + # A list of groups that match the API request parameters. Each item in the list + # represents a `group` resource. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # Identifies the API resource's type. The value will be - # `youtube#groupListResponse`. + # Identifies the API resource's type. The value will be `youtube# + # groupListResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -444,42 +421,38 @@ module Google class QueryResponse include Google::Apis::Core::Hashable - # This value specifies information about the data returned in the `rows` - # fields. Each item in the `columnHeaders` list identifies a field returned - # in the `rows` value, which contains a list of comma-delimited data. The - # `columnHeaders` list will begin with the dimensions specified in the API - # request, which will be followed by the metrics specified in the API - # request. The order of both dimensions and metrics will match the ordering - # in the API request. For example, if the API request contains the parameters - # `dimensions=ageGroup,gender&metrics=viewerPercentage`, the API response - # will return columns in this order: `ageGroup`, `gender`, - # `viewerPercentage`. + # This value specifies information about the data returned in the `rows` fields. + # Each item in the `columnHeaders` list identifies a field returned in the `rows` + # value, which contains a list of comma-delimited data. The `columnHeaders` + # list will begin with the dimensions specified in the API request, which will + # be followed by the metrics specified in the API request. The order of both + # dimensions and metrics will match the ordering in the API request. For example, + # if the API request contains the parameters `dimensions=ageGroup,gender& + # metrics=viewerPercentage`, the API response will return columns in this order: + # `ageGroup`, `gender`, `viewerPercentage`. # Corresponds to the JSON property `columnHeaders` # @return [Array] attr_accessor :column_headers - # Request Error information. - # The presence of an error field signals that the operation - # has failed. + # Request Error information. The presence of an error field signals that the + # operation has failed. # Corresponds to the JSON property `errors` # @return [Google::Apis::YoutubeAnalyticsV2::Errors] attr_accessor :errors - # This value specifies the type of data included in the API response. - # For the query method, the kind property value will be - # `youtubeAnalytics#resultTable`. + # This value specifies the type of data included in the API response. For the + # query method, the kind property value will be `youtubeAnalytics#resultTable`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The list contains all rows of the result table. Each item in the list is - # an array that contains comma-delimited data corresponding to a single row - # of data. The order of the comma-delimited data fields will match the - # order of the columns listed in the `columnHeaders` field. - # If no data is available for the given query, the `rows` element will be - # omitted from the response. - # The response for a query with the `day` dimension will not contain rows for - # the most recent days. + # The list contains all rows of the result table. Each item in the list is an + # array that contains comma-delimited data corresponding to a single row of data. + # The order of the comma-delimited data fields will match the order of the + # columns listed in the `columnHeaders` field. If no data is available for the + # given query, the `rows` element will be omitted from the response. The + # response for a query with the `day` dimension will not contain rows for the + # most recent days. # Corresponds to the JSON property `rows` # @return [Array>] attr_accessor :rows diff --git a/generated/google/apis/youtube_analytics_v2/service.rb b/generated/google/apis/youtube_analytics_v2/service.rb index 1d92bd13c..0c3e8db30 100644 --- a/generated/google/apis/youtube_analytics_v2/service.rb +++ b/generated/google/apis/youtube_analytics_v2/service.rb @@ -49,19 +49,18 @@ module Google # Removes an item from a group. # @param [String] id - # The `id` parameter specifies the YouTube group item ID of the group item - # that is being deleted. + # The `id` parameter specifies the YouTube group item ID of the group item that + # is being deleted. # @param [String] on_behalf_of_content_owner # This parameter can only be used in a properly authorized request. **Note:** - # This parameter is intended exclusively for YouTube content partners that - # own and manage many different YouTube channels. - # The `onBehalfOfContentOwner` parameter indicates that the request's - # authorization credentials identify a YouTube user who is acting on behalf - # of the content owner specified in the parameter value. It allows content - # owners to authenticate once and get access to all their video and channel - # data, without having to provide authentication credentials for each - # individual channel. The account that the user authenticates with must be - # linked to the specified YouTube content owner. + # This parameter is intended exclusively for YouTube content partners that own + # and manage many different YouTube channels. The `onBehalfOfContentOwner` + # parameter indicates that the request's authorization credentials identify a + # YouTube user who is acting on behalf of the content owner specified in the + # parameter value. It allows content owners to authenticate once and get access + # to all their video and channel data, without having to provide authentication + # credentials for each individual channel. The account that the user + # authenticates with must be linked to the specified YouTube content owner. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -94,15 +93,14 @@ module Google # @param [Google::Apis::YoutubeAnalyticsV2::GroupItem] group_item_object # @param [String] on_behalf_of_content_owner # This parameter can only be used in a properly authorized request. **Note:** - # This parameter is intended exclusively for YouTube content partners that - # own and manage many different YouTube channels. - # The `onBehalfOfContentOwner` parameter indicates that the request's - # authorization credentials identify a YouTube user who is acting on behalf - # of the content owner specified in the parameter value. It allows content - # owners to authenticate once and get access to all their video and channel - # data, without having to provide authentication credentials for each - # individual channel. The account that the user authenticates with must be - # linked to the specified YouTube content owner. + # This parameter is intended exclusively for YouTube content partners that own + # and manage many different YouTube channels. The `onBehalfOfContentOwner` + # parameter indicates that the request's authorization credentials identify a + # YouTube user who is acting on behalf of the content owner specified in the + # parameter value. It allows content owners to authenticate once and get access + # to all their video and channel data, without having to provide authentication + # credentials for each individual channel. The account that the user + # authenticates with must be linked to the specified YouTube content owner. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -138,15 +136,14 @@ module Google # want to retrieve group items. # @param [String] on_behalf_of_content_owner # This parameter can only be used in a properly authorized request. **Note:** - # This parameter is intended exclusively for YouTube content partners that - # own and manage many different YouTube channels. - # The `onBehalfOfContentOwner` parameter indicates that the request's - # authorization credentials identify a YouTube user who is acting on behalf - # of the content owner specified in the parameter value. It allows content - # owners to authenticate once and get access to all their video and channel - # data, without having to provide authentication credentials for each - # individual channel. The account that the user authenticates with must be - # linked to the specified YouTube content owner. + # This parameter is intended exclusively for YouTube content partners that own + # and manage many different YouTube channels. The `onBehalfOfContentOwner` + # parameter indicates that the request's authorization credentials identify a + # YouTube user who is acting on behalf of the content owner specified in the + # parameter value. It allows content owners to authenticate once and get access + # to all their video and channel data, without having to provide authentication + # credentials for each individual channel. The account that the user + # authenticates with must be linked to the specified YouTube content owner. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -177,19 +174,18 @@ module Google # Deletes a group. # @param [String] id - # The `id` parameter specifies the YouTube group ID of the group that is - # being deleted. + # The `id` parameter specifies the YouTube group ID of the group that is being + # deleted. # @param [String] on_behalf_of_content_owner # This parameter can only be used in a properly authorized request. **Note:** - # This parameter is intended exclusively for YouTube content partners that - # own and manage many different YouTube channels. - # The `onBehalfOfContentOwner` parameter indicates that the request's - # authorization credentials identify a YouTube user who is acting on behalf - # of the content owner specified in the parameter value. It allows content - # owners to authenticate once and get access to all their video and channel - # data, without having to provide authentication credentials for each - # individual channel. The account that the user authenticates with must be - # linked to the specified YouTube content owner. + # This parameter is intended exclusively for YouTube content partners that own + # and manage many different YouTube channels. The `onBehalfOfContentOwner` + # parameter indicates that the request's authorization credentials identify a + # YouTube user who is acting on behalf of the content owner specified in the + # parameter value. It allows content owners to authenticate once and get access + # to all their video and channel data, without having to provide authentication + # credentials for each individual channel. The account that the user + # authenticates with must be linked to the specified YouTube content owner. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -222,15 +218,14 @@ module Google # @param [Google::Apis::YoutubeAnalyticsV2::Group] group_object # @param [String] on_behalf_of_content_owner # This parameter can only be used in a properly authorized request. **Note:** - # This parameter is intended exclusively for YouTube content partners that - # own and manage many different YouTube channels. - # The `onBehalfOfContentOwner` parameter indicates that the request's - # authorization credentials identify a YouTube user who is acting on behalf - # of the content owner specified in the parameter value. It allows content - # owners to authenticate once and get access to all their video and channel - # data, without having to provide authentication credentials for each - # individual channel. The account that the user authenticates with must be - # linked to the specified YouTube content owner. + # This parameter is intended exclusively for YouTube content partners that own + # and manage many different YouTube channels. The `onBehalfOfContentOwner` + # parameter indicates that the request's authorization credentials identify a + # YouTube user who is acting on behalf of the content owner specified in the + # parameter value. It allows content owners to authenticate once and get access + # to all their video and channel data, without having to provide authentication + # credentials for each individual channel. The account that the user + # authenticates with must be linked to the specified YouTube content owner. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -261,30 +256,28 @@ module Google end # Returns a collection of groups that match the API request parameters. For - # example, you can retrieve all groups that the authenticated user owns, - # or you can retrieve one or more groups by their unique IDs. + # example, you can retrieve all groups that the authenticated user owns, or you + # can retrieve one or more groups by their unique IDs. # @param [String] id - # The `id` parameter specifies a comma-separated list of the YouTube group - # ID(s) for the resource(s) that are being retrieved. Each group must be - # owned by the authenticated user. In a `group` resource, the `id` property - # specifies the group's YouTube group ID. - # Note that if you do not specify a value for the `id` parameter, then you - # must set the `mine` parameter to `true`. + # The `id` parameter specifies a comma-separated list of the YouTube group ID(s) + # for the resource(s) that are being retrieved. Each group must be owned by the + # authenticated user. In a `group` resource, the `id` property specifies the + # group's YouTube group ID. Note that if you do not specify a value for the `id` + # parameter, then you must set the `mine` parameter to `true`. # @param [Boolean] mine # This parameter can only be used in a properly authorized request. Set this # parameter's value to true to retrieve all groups owned by the authenticated # user. # @param [String] on_behalf_of_content_owner # This parameter can only be used in a properly authorized request. **Note:** - # This parameter is intended exclusively for YouTube content partners that - # own and manage many different YouTube channels. - # The `onBehalfOfContentOwner` parameter indicates that the request's - # authorization credentials identify a YouTube user who is acting on behalf - # of the content owner specified in the parameter value. It allows content - # owners to authenticate once and get access to all their video and channel - # data, without having to provide authentication credentials for each - # individual channel. The account that the user authenticates with must be - # linked to the specified YouTube content owner. + # This parameter is intended exclusively for YouTube content partners that own + # and manage many different YouTube channels. The `onBehalfOfContentOwner` + # parameter indicates that the request's authorization credentials identify a + # YouTube user who is acting on behalf of the content owner specified in the + # parameter value. It allows content owners to authenticate once and get access + # to all their video and channel data, without having to provide authentication + # credentials for each individual channel. The account that the user + # authenticates with must be linked to the specified YouTube content owner. # @param [String] page_token # The `pageToken` parameter identifies a specific page in the result set that # should be returned. In an API response, the `nextPageToken` property @@ -323,15 +316,14 @@ module Google # @param [Google::Apis::YoutubeAnalyticsV2::Group] group_object # @param [String] on_behalf_of_content_owner # This parameter can only be used in a properly authorized request. **Note:** - # This parameter is intended exclusively for YouTube content partners that - # own and manage many different YouTube channels. - # The `onBehalfOfContentOwner` parameter indicates that the request's - # authorization credentials identify a YouTube user who is acting on behalf - # of the content owner specified in the parameter value. It allows content - # owners to authenticate once and get access to all their video and channel - # data, without having to provide authentication credentials for each - # individual channel. The account that the user authenticates with must be - # linked to the specified YouTube content owner. + # This parameter is intended exclusively for YouTube content partners that own + # and manage many different YouTube channels. The `onBehalfOfContentOwner` + # parameter indicates that the request's authorization credentials identify a + # YouTube user who is acting on behalf of the content owner specified in the + # parameter value. It allows content owners to authenticate once and get access + # to all their video and channel data, without having to provide authentication + # credentials for each individual channel. The account that the user + # authenticates with must be linked to the specified YouTube content owner. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -363,71 +355,59 @@ module Google # Retrieve your YouTube Analytics reports. # @param [String] currency - # The currency to which financial metrics should be converted. The default is - # US Dollar (USD). If the result contains no financial metrics, this flag - # will be ignored. Responds with an error if the specified currency is not - # recognized.", + # The currency to which financial metrics should be converted. The default is US + # Dollar (USD). If the result contains no financial metrics, this flag will be + # ignored. Responds with an error if the specified currency is not recognized.", # pattern: [A-Z]`3` # @param [String] dimensions - # A comma-separated list of YouTube Analytics dimensions, such as `views` or - # `ageGroup,gender`. See the [Available - # Reports](/youtube/analytics/v2/available_reports) document for a list of - # the reports that you can retrieve and the dimensions used for those - # reports. Also see the [Dimensions](/youtube/analytics/v2/dimsmets/dims) - # document for definitions of those dimensions." + # A comma-separated list of YouTube Analytics dimensions, such as `views` or ` + # ageGroup,gender`. See the [Available Reports](/youtube/analytics/v2/ + # available_reports) document for a list of the reports that you can retrieve + # and the dimensions used for those reports. Also see the [Dimensions](/youtube/ + # analytics/v2/dimsmets/dims) document for definitions of those dimensions." # pattern: [0-9a-zA-Z,]+ # @param [String] end_date - # The end date for fetching YouTube Analytics data. The value should be in - # `YYYY-MM-DD` format. - # required: true, pattern: [0-9]`4`-[0-9]`2`-[0-9]`2` + # The end date for fetching YouTube Analytics data. The value should be in `YYYY- + # MM-DD` format. required: true, pattern: [0-9]`4`-[0-9]`2`-[0-9]`2` # @param [String] filters # A list of filters that should be applied when retrieving YouTube Analytics # data. The [Available Reports](/youtube/analytics/v2/available_reports) - # document identifies the dimensions that can be used to filter each report, - # and the [Dimensions](/youtube/analytics/v2/dimsmets/dims) document defines - # those dimensions. If a request uses multiple filters, join them together - # with a semicolon (`;`), and the returned result table will satisfy both - # filters. For example, a filters parameter value of - # `video==dMH0bHeiRNg;country==IT` restricts the result set to include data - # for the given video in Italy.", + # document identifies the dimensions that can be used to filter each report, and + # the [Dimensions](/youtube/analytics/v2/dimsmets/dims) document defines those + # dimensions. If a request uses multiple filters, join them together with a + # semicolon (`;`), and the returned result table will satisfy both filters. For + # example, a filters parameter value of `video==dMH0bHeiRNg;country==IT` + # restricts the result set to include data for the given video in Italy.", # @param [String] ids - # Identifies the YouTube channel or content owner for which you are - # retrieving YouTube Analytics data. - # - To request data for a YouTube user, set the `ids` parameter value to - # `channel==CHANNEL_ID`, where `CHANNEL_ID` specifies the unique YouTube - # channel ID. - # - To request data for a YouTube CMS content owner, set the `ids` parameter - # value to `contentOwner==OWNER_NAME`, where `OWNER_NAME` is the CMS name - # of the content owner. - # required: true, pattern: [a-zA-Z]+==[a-zA-Z0-9_+-]+ + # Identifies the YouTube channel or content owner for which you are retrieving + # YouTube Analytics data. - To request data for a YouTube user, set the `ids` + # parameter value to `channel==CHANNEL_ID`, where `CHANNEL_ID` specifies the + # unique YouTube channel ID. - To request data for a YouTube CMS content owner, + # set the `ids` parameter value to `contentOwner==OWNER_NAME`, where `OWNER_NAME` + # is the CMS name of the content owner. required: true, pattern: [a-zA-Z]+==[a- + # zA-Z0-9_+-]+ # @param [Boolean] include_historical_channel_data - # If set to true historical data (i.e. channel data from before the linking - # of the channel to the content owner) will be retrieved.", + # If set to true historical data (i.e. channel data from before the linking of + # the channel to the content owner) will be retrieved.", # @param [Fixnum] max_results - # The maximum number of rows to include in the response.", - # minValue: 1 + # The maximum number of rows to include in the response.", minValue: 1 # @param [String] metrics - # A comma-separated list of YouTube Analytics metrics, such as `views` or - # `likes,dislikes`. See the - # [Available Reports](/youtube/analytics/v2/available_reports) document for - # a list of the reports that you can retrieve and the metrics - # available in each report, and see the - # [Metrics](/youtube/analytics/v2/dimsmets/mets) document for definitions of - # those metrics. - # required: true, pattern: [0-9a-zA-Z,]+ + # A comma-separated list of YouTube Analytics metrics, such as `views` or `likes, + # dislikes`. See the [Available Reports](/youtube/analytics/v2/available_reports) + # document for a list of the reports that you can retrieve and the metrics + # available in each report, and see the [Metrics](/youtube/analytics/v2/dimsmets/ + # mets) document for definitions of those metrics. required: true, pattern: [0- + # 9a-zA-Z,]+ # @param [String] sort - # A comma-separated list of dimensions or metrics that determine the sort - # order for YouTube Analytics data. By default the sort order is ascending. - # The '`-`' prefix causes descending sort order.", - # pattern: [-0-9a-zA-Z,]+ + # A comma-separated list of dimensions or metrics that determine the sort order + # for YouTube Analytics data. By default the sort order is ascending. The '`-`' + # prefix causes descending sort order.", pattern: [-0-9a-zA-Z,]+ # @param [String] start_date - # The start date for fetching YouTube Analytics data. The value should be in - # `YYYY-MM-DD` format. - # required: true, pattern: "[0-9]`4`-[0-9]`2`-[0-9]`2` + # The start date for fetching YouTube Analytics data. The value should be in ` + # YYYY-MM-DD` format. required: true, pattern: "[0-9]`4`-[0-9]`2`-[0-9]`2` # @param [Fixnum] start_index - # An index of the first entity to retrieve. Use this parameter as a - # pagination mechanism along with the max-results parameter (one-based, - # inclusive).", + # An index of the first entity to retrieve. Use this parameter as a pagination + # mechanism along with the max-results parameter (one-based, inclusive).", # minValue: 1 # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/youtube_partner_v1.rb b/generated/google/apis/youtube_partner_v1.rb index 7cb10cccb..0ca7af29c 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 = '20200727' + REVISION = '20200803' # 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_partner_v1/service.rb b/generated/google/apis/youtube_partner_v1/service.rb index 8b3875b78..1e0e77f86 100644 --- a/generated/google/apis/youtube_partner_v1/service.rb +++ b/generated/google/apis/youtube_partner_v1/service.rb @@ -44,8 +44,8 @@ module Google attr_accessor :quota_user def initialize - super('https://youtubepartner.googleapis.com/', '') - @batch_path = 'batch' + super('https://www.googleapis.com/', '') + @batch_path = 'batch/youtubePartner/v1' end # Insert an asset label for an owner. diff --git a/generated/google/apis/youtube_v3.rb b/generated/google/apis/youtube_v3.rb index ca1774b49..8d34df747 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 = '20200722' + REVISION = '20200802' # Manage your YouTube account AUTH_YOUTUBE = 'https://www.googleapis.com/auth/youtube' diff --git a/generated/google/apis/youtube_v3/classes.rb b/generated/google/apis/youtube_v3/classes.rb index 1276ab79d..8fe28be5f 100644 --- a/generated/google/apis/youtube_v3/classes.rb +++ b/generated/google/apis/youtube_v3/classes.rb @@ -82,15 +82,15 @@ module Google class AccessPolicy include Google::Apis::Core::Hashable - # The value of allowed indicates whether the access to the - # policy is allowed or denied by default. + # The value of allowed indicates whether the access to the policy is allowed or + # denied by default. # Corresponds to the JSON property `allowed` # @return [Boolean] attr_accessor :allowed alias_method :allowed?, :allowed - # A list of region codes that identify countries where the default policy do - # not apply. + # A list of region codes that identify countries where the default policy do not + # apply. # Corresponds to the JSON property `exception` # @return [Array] attr_accessor :exception @@ -106,14 +106,13 @@ module Google end end - # An activity resource contains - # information about an action that a particular channel, or user, has - # taken on YouTube.The actions reported in activity feeds include rating - # a video, sharing a video, marking a video as a favorite, commenting on - # a video, uploading a video, and so forth. Each activity - # resource identifies the type of action, the channel associated with - # the action, and the resource(s) associated with the action, such as - # the video that was rated or uploaded. + # An *activity* resource contains information about an action that a particular + # channel, or user, has taken on YouTube.The actions reported in activity feeds + # include rating a video, sharing a video, marking a video as a favorite, + # commenting on a video, uploading a video, and so forth. Each activity resource + # identifies the type of action, the channel associated with the action, and the + # resource(s) associated with the action, such as the video that was rated or + # uploaded. class Activity include Google::Apis::Core::Hashable @@ -133,15 +132,14 @@ module Google # @return [String] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#activity". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # activity". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Basic details about an activity, including title, description, thumbnails, - # activity type and group. - # Next ID: 12 + # activity type and group. Next ID: 12 # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::ActivitySnippet] attr_accessor :snippet @@ -375,8 +373,8 @@ module Google # @return [String] attr_accessor :ad_tag - # The URL the client should ping to indicate that the user clicked through - # on this promoted item. + # The URL the client should ping to indicate that the user clicked through on + # this promoted item. # Corresponds to the JSON property `clickTrackingUrl` # @return [String] attr_accessor :click_tracking_url @@ -387,14 +385,14 @@ module Google # @return [String] attr_accessor :creative_view_url - # The type of call-to-action, a message to the user indicating action that - # can be taken. + # The type of call-to-action, a message to the user indicating action that can + # be taken. # Corresponds to the JSON property `ctaType` # @return [String] attr_accessor :cta_type - # The custom call-to-action button text. If specified, it will override - # the default button text for the cta_type. + # The custom call-to-action button text. If specified, it will override the + # default button text for the cta_type. # Corresponds to the JSON property `customCtaButtonText` # @return [String] attr_accessor :custom_cta_button_text @@ -404,15 +402,15 @@ module Google # @return [String] attr_accessor :description_text - # The URL the client should direct the user to, if the user chooses to - # visit the advertiser's website. + # The URL the client should direct the user to, if the user chooses to visit the + # advertiser's website. # Corresponds to the JSON property `destinationUrl` # @return [String] attr_accessor :destination_url - # The list of forecasting URLs. The client should ping all of these URLs - # when a promoted item is not available, to indicate that a promoted item - # could have been shown. + # The list of forecasting URLs. The client should ping all of these URLs when a + # promoted item is not available, to indicate that a promoted item could have + # been shown. # Corresponds to the JSON property `forecastingUrl` # @return [Array] attr_accessor :forecasting_url @@ -578,14 +576,14 @@ module Google # @return [Array] attr_accessor :items - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#activityListResponse". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # activityListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken - # parameter to retrieve the next page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -596,8 +594,8 @@ module Google # @return [Google::Apis::YoutubeV3::PageInfo] attr_accessor :page_info - # The token that can be used as the value of the pageToken - # parameter to retrieve the previous page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the previous page in the result set. # Corresponds to the JSON property `prevPageToken` # @return [String] attr_accessor :prev_page_token @@ -607,7 +605,7 @@ module Google # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination - # The visitorId identifies the visitor. + # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id @@ -631,13 +629,12 @@ module Google end # Basic details about an activity, including title, description, thumbnails, - # activity type and group. - # Next ID: 12 + # activity type and group. Next ID: 12 class ActivitySnippet include Google::Apis::Core::Hashable - # The ID that YouTube uses to uniquely identify the channel associated - # with the activity. + # The ID that YouTube uses to uniquely identify the channel associated with the + # activity. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id @@ -647,25 +644,24 @@ module Google # @return [String] attr_accessor :channel_title - # The description of the resource primarily associated with the activity. - # @mutable youtube.activities.insert + # The description of the resource primarily associated with the activity. @ + # mutable youtube.activities.insert # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # The group ID associated with the activity. A group ID identifies user - # events that are associated with the same user and resource. For example, - # if a user rates a video and marks the same video as a favorite, the - # entries for those events would have the same group ID in the user's - # activity feed. In your user interface, you can avoid repetition by - # grouping events with the same groupId value. + # The group ID associated with the activity. A group ID identifies user events + # that are associated with the same user and resource. For example, if a user + # rates a video and marks the same video as a favorite, the entries for those + # events would have the same group ID in the user's activity feed. In your user + # interface, you can avoid repetition by grouping events with the same groupId + # value. # Corresponds to the JSON property `groupId` # @return [String] attr_accessor :group_id - # The date and time that the video was uploaded. The value is specified - # in ISO 8601 - # format. + # The date and time that the video was uploaded. The value is specified in ISO + # 8601 format. # Corresponds to the JSON property `publishedAt` # @return [String] attr_accessor :published_at @@ -702,9 +698,8 @@ module Google end end - # A caption resource represents a YouTube - # caption track. A caption track is associated with exactly one YouTube - # video. + # A *caption* resource represents a YouTube caption track. A caption track is + # associated with exactly one YouTube video. class Caption include Google::Apis::Core::Hashable @@ -718,8 +713,8 @@ module Google # @return [String] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#caption". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # caption". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -761,13 +756,13 @@ module Google # @return [Array] attr_accessor :items - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#captionListResponse". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # captionListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The visitorId identifies the visitor. + # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id @@ -795,74 +790,66 @@ module Google # @return [String] attr_accessor :audio_track_type - # The reason that YouTube failed to process the caption track. This - # property is only present if the state - # property's value is failed. + # The reason that YouTube failed to process the caption track. This property is + # only present if the state property's value is failed. # Corresponds to the JSON property `failureReason` # @return [String] attr_accessor :failure_reason - # Indicates whether YouTube synchronized the caption track to the audio - # track in the video. The value will be true if a sync was - # explicitly requested when the caption track was uploaded. For example, - # when calling the captions.insert or - # captions.update methods, you can set the sync - # parameter to true to instruct YouTube to sync the uploaded - # track to the video. If the value is false, YouTube uses - # the time codes in the uploaded caption track to determine when to display - # captions. + # Indicates whether YouTube synchronized the caption track to the audio track in + # the video. The value will be true if a sync was explicitly requested when the + # caption track was uploaded. For example, when calling the captions.insert or + # captions.update methods, you can set the sync parameter to true to instruct + # YouTube to sync the uploaded track to the video. If the value is false, + # YouTube uses the time codes in the uploaded caption track to determine when to + # display captions. # Corresponds to the JSON property `isAutoSynced` # @return [Boolean] attr_accessor :is_auto_synced alias_method :is_auto_synced?, :is_auto_synced - # Indicates whether the track contains closed captions for the deaf - # and hard of hearing. The default value is false. + # Indicates whether the track contains closed captions for the deaf and hard of + # hearing. The default value is false. # Corresponds to the JSON property `isCC` # @return [Boolean] attr_accessor :is_cc alias_method :is_cc?, :is_cc - # Indicates whether the caption track is a draft. If the value is - # true, then the track is not publicly visible. - # The default value is false. - # @mutable youtube.captions.insert youtube.captions.update + # Indicates whether the caption track is a draft. If the value is true, then the + # track is not publicly visible. The default value is false. @mutable youtube. + # captions.insert youtube.captions.update # Corresponds to the JSON property `isDraft` # @return [Boolean] attr_accessor :is_draft alias_method :is_draft?, :is_draft - # Indicates whether caption track is formatted for "easy reader," - # meaning it is at a third-grade level for language learners. - # The default value is false. + # Indicates whether caption track is formatted for "easy reader," meaning it is + # at a third-grade level for language learners. The default value is false. # Corresponds to the JSON property `isEasyReader` # @return [Boolean] attr_accessor :is_easy_reader alias_method :is_easy_reader?, :is_easy_reader - # Indicates whether the caption track uses large text for the - # vision-impaired. The default value is false. + # Indicates whether the caption track uses large text for the vision-impaired. + # The default value is false. # Corresponds to the JSON property `isLarge` # @return [Boolean] attr_accessor :is_large alias_method :is_large?, :is_large - # The language of the caption track. The property value is a - # BCP-47 - # language tag. + # The language of the caption track. The property value is a BCP-47 language tag. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language # The date and time when the caption track was last updated. The value is - # specified in ISO 8601 - # format. + # specified in ISO 8601 format. # Corresponds to the JSON property `lastUpdated` # @return [String] attr_accessor :last_updated - # The name of the caption track. The name is intended to be visible - # to the user as an option during playback. + # The name of the caption track. The name is intended to be visible to the user + # as an option during playback. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -877,9 +864,8 @@ module Google # @return [String] attr_accessor :track_kind - # The ID that YouTube uses to uniquely identify the video associated - # with the caption track. - # @mutable youtube.captions.insert + # The ID that YouTube uses to uniquely identify the video associated with the + # caption track. @mutable youtube.captions.insert # Corresponds to the JSON property `videoId` # @return [String] attr_accessor :video_id @@ -910,7 +896,7 @@ module Google class CdnSettings include Google::Apis::Core::Hashable - # The format of the video stream that you are sending to Youtube.

+ # The format of the video stream that you are sending to Youtube. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format @@ -949,13 +935,12 @@ module Google end end - # A channel resource contains - # information about a YouTube channel. + # A *channel* resource contains information about a YouTube channel. class Channel include Google::Apis::Core::Hashable - # The auditDetails object encapsulates channel data that is - # relevant for YouTube Partners during the audit process. + # The auditDetails object encapsulates channel data that is relevant for YouTube + # Partners during the audit process. # Corresponds to the JSON property `auditDetails` # @return [Google::Apis::YoutubeV3::ChannelAuditDetails] attr_accessor :audit_details @@ -970,14 +955,14 @@ module Google # @return [Google::Apis::YoutubeV3::ChannelContentDetails] attr_accessor :content_details - # The contentOwnerDetails object encapsulates channel data that - # is relevant for YouTube Partners linked with the channel. + # The contentOwnerDetails object encapsulates channel data that is relevant for + # YouTube Partners linked with the channel. # Corresponds to the JSON property `contentOwnerDetails` # @return [Google::Apis::YoutubeV3::ChannelContentOwnerDetails] attr_accessor :content_owner_details - # The conversionPings object encapsulates information about - # conversion pings that need to be respected by the channel. + # The conversionPings object encapsulates information about conversion pings + # that need to be respected by the channel. # Corresponds to the JSON property `conversionPings` # @return [Google::Apis::YoutubeV3::ChannelConversionPings] attr_accessor :conversion_pings @@ -992,14 +977,14 @@ module Google # @return [String] attr_accessor :id - # Describes an invideo promotion campaign consisting of multiple promoted - # items. A campaign belongs to a single channel_id. + # Describes an invideo promotion campaign consisting of multiple promoted items. + # A campaign belongs to a single channel_id. # Corresponds to the JSON property `invideoPromotion` # @return [Google::Apis::YoutubeV3::InvideoPromotion] attr_accessor :invideo_promotion - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#channel". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # channel". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1053,8 +1038,8 @@ module Google end end - # The auditDetails object encapsulates channel data that is - # relevant for YouTube Partners during the audit process. + # The auditDetails object encapsulates channel data that is relevant for YouTube + # Partners during the audit process. class ChannelAuditDetails include Google::Apis::Core::Hashable @@ -1097,8 +1082,8 @@ module Google # @return [String] attr_accessor :etag - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#channelBannerResource". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # channelBannerResource". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1161,14 +1146,12 @@ module Google class ChannelCard include Google::Apis::Core::Hashable - # External channel ID. - # Required. + # External channel ID. Required. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id - # Each card can have a custom message. - # Required. + # Each card can have a custom message. Required. # Corresponds to the JSON property `customMessage` # @return [String] attr_accessor :custom_message @@ -1206,51 +1189,37 @@ module Google class RelatedPlaylists include Google::Apis::Core::Hashable - # The ID of the playlist that contains the channel"s favorite videos. Use - # the playlistItems.insert - # and playlistItems.delete - # to add or remove items from that list. + # The ID of the playlist that contains the channel"s favorite videos. Use the + # playlistItems.insert and playlistItems.delete to add or remove items from that + # list. # Corresponds to the JSON property `favorites` # @return [String] attr_accessor :favorites # The ID of the playlist that contains the channel"s liked videos. Use the - # - # playlistItems.insert and playlistItems.delete - # to add or remove items from that list. + # playlistItems.insert and playlistItems.delete to add or remove items from that + # list. # Corresponds to the JSON property `likes` # @return [String] attr_accessor :likes - # The ID of the playlist that contains the channel"s uploaded videos. Use - # the videos.insert method to - # upload new videos and the videos.delete method to + # The ID of the playlist that contains the channel"s uploaded videos. Use the + # videos.insert method to upload new videos and the videos.delete method to # delete previously uploaded videos. # Corresponds to the JSON property `uploads` # @return [String] attr_accessor :uploads # The ID of the playlist that contains the channel"s watch history. Use the - # playlistItems.insert - # and playlistItems.delete - # to add or remove items from that list. + # playlistItems.insert and playlistItems.delete to add or remove items from that + # list. # Corresponds to the JSON property `watchHistory` # @return [String] attr_accessor :watch_history - # The ID of the playlist that contains the channel"s watch later playlist. - # Use the playlistItems.insert - # and playlistItems.delete - # to add or remove items from that list. + # The ID of the playlist that contains the channel"s watch later playlist. Use + # the playlistItems.insert and playlistItems.delete to add or remove items from + # that list. # Corresponds to the JSON property `watchLater` # @return [String] attr_accessor :watch_later @@ -1270,8 +1239,8 @@ module Google end end - # The contentOwnerDetails object encapsulates channel data that - # is relevant for YouTube Partners linked with the channel. + # The contentOwnerDetails object encapsulates channel data that is relevant for + # YouTube Partners linked with the channel. class ChannelContentOwnerDetails include Google::Apis::Core::Hashable @@ -1280,10 +1249,8 @@ module Google # @return [String] attr_accessor :content_owner - # The date and time of when the channel was linked to the content owner. - # The value is specified in ISO - # 8601 - # format. + # The date and time of when the channel was linked to the content owner. The + # value is specified in ISO 8601 format. # Corresponds to the JSON property `timeLinked` # @return [String] attr_accessor :time_linked @@ -1310,13 +1277,12 @@ module Google # @return [String] attr_accessor :context - # The url (without the schema) that the player shall send the ping to. - # It's at caller's descretion to decide which schema to use (http vs https) - # Example of a returned url: //googleads.g.doubleclick.net/pagead/ - # viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D - # cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default - # The caller must append biscotti authentication (ms param in case of - # mobile, for example) to this ping. + # The url (without the schema) that the player shall send the ping to. It's at + # caller's descretion to decide which schema to use (http vs https) Example of a + # returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/ + # 962985656/?data=path%3DtHe_path%3Btype%3D cview%3Butuid% + # 3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must append biscotti + # authentication (ms param in case of mobile, for example) to this ping. # Corresponds to the JSON property `conversionUrl` # @return [String] attr_accessor :conversion_url @@ -1332,14 +1298,14 @@ module Google end end - # The conversionPings object encapsulates information about - # conversion pings that need to be respected by the channel. + # The conversionPings object encapsulates information about conversion pings + # that need to be respected by the channel. class ChannelConversionPings include Google::Apis::Core::Hashable # Pings that the app shall fire (authenticated by biscotti cookie). Each ping - # has a context, in which the app must fire the ping, and a url identifying - # the ping. + # has a context, in which the app must fire the ping, and a url identifying the + # ping. # Corresponds to the JSON property `pings` # @return [Array] attr_accessor :pings @@ -1373,14 +1339,14 @@ module Google # @return [Array] attr_accessor :items - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#channelListResponse". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # channelListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken - # parameter to retrieve the next page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1391,8 +1357,8 @@ module Google # @return [Google::Apis::YoutubeV3::PageInfo] attr_accessor :page_info - # The token that can be used as the value of the pageToken - # parameter to retrieve the previous page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the previous page in the result set. # Corresponds to the JSON property `prevPageToken` # @return [String] attr_accessor :prev_page_token @@ -1402,7 +1368,7 @@ module Google # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination - # The visitorId identifies the visitor. + # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id @@ -1506,8 +1472,8 @@ module Google # @return [String] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#channelSection". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # channelSection". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1588,13 +1554,13 @@ module Google # @return [Array] attr_accessor :items - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#channelSectionListResponse". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # channelSectionListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The visitorId identifies the visitor. + # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id @@ -1636,8 +1602,8 @@ module Google class ChannelSectionSnippet include Google::Apis::Core::Hashable - # The ID that YouTube uses to uniquely identify the channel that published - # the channel section. + # The ID that YouTube uses to uniquely identify the channel that published the + # channel section. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id @@ -1758,8 +1724,8 @@ module Google # @return [String] attr_accessor :keywords - # Whether user-submitted comments left on the channel page need to be - # approved by the channel owner to be publicly visible. + # Whether user-submitted comments left on the channel page need to be approved + # by the channel owner to be publicly visible. # Corresponds to the JSON property `moderateComments` # @return [Boolean] attr_accessor :moderate_comments @@ -1850,9 +1816,8 @@ module Google # @return [Google::Apis::YoutubeV3::ChannelLocalization] attr_accessor :localized - # The date and time that the channel was created. The value is specified in - # < a href="//www.w3.org/TR/NOTE-datetime">ISO 8601 - # format. + # The date and time that the channel was created. The value is specified in < a + # href="//www.w3.org/TR/NOTE-datetime">ISO 8601 format. # Corresponds to the JSON property `publishedAt` # @return [String] attr_accessor :published_at @@ -1933,15 +1898,15 @@ module Google class ChannelStatus include Google::Apis::Core::Hashable - # If true, then the user is linked to either a YouTube username or G+ - # account. Otherwise, the user doesn't have a public YouTube identity. + # If true, then the user is linked to either a YouTube username or G+ account. + # Otherwise, the user doesn't have a public YouTube identity. # Corresponds to the JSON property `isLinked` # @return [Boolean] attr_accessor :is_linked alias_method :is_linked?, :is_linked - # The long uploads status of this channel. See - # https://support.google.com/youtube/answer/71673 for more information. + # The long uploads status of this channel. See https://support.google.com/ + # youtube/answer/71673 for more information. # Corresponds to the JSON property `longUploadsStatus` # @return [String] attr_accessor :long_uploads_status @@ -2013,8 +1978,7 @@ module Google attr_accessor :topic_categories # A list of Freebase topic IDs associated with the channel. You can retrieve - # information about each topic using the Freebase Topic API. + # information about each topic using the Freebase Topic API. # Corresponds to the JSON property `topicIds` # @return [Array] attr_accessor :topic_ids @@ -2030,7 +1994,7 @@ module Google end end - # A comment represents a single YouTube comment. + # A *comment* represents a single YouTube comment. class Comment include Google::Apis::Core::Hashable @@ -2044,8 +2008,8 @@ module Google # @return [String] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#comment". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # comment". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2087,14 +2051,14 @@ module Google # @return [Array] attr_accessor :items - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#commentListResponse". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # commentListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken - # parameter to retrieve the next page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2110,7 +2074,7 @@ module Google # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination - # The visitorId identifies the visitor. + # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id @@ -2162,9 +2126,9 @@ module Google attr_accessor :can_rate alias_method :can_rate?, :can_rate - # The id of the corresponding YouTube channel. In case of a channel comment - # this is the channel the comment refers to. In case of a video comment - # it's the video's channel. + # The id of the corresponding YouTube channel. In case of a channel comment this + # is the channel the comment refers to. In case of a video comment it's the + # video's channel. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id @@ -2186,29 +2150,27 @@ module Google attr_accessor :parent_id # The date and time when the comment was orignally published. The value is - # specified in ISO 8601 - # format. + # specified in ISO 8601 format. # Corresponds to the JSON property `publishedAt` # @return [String] attr_accessor :published_at - # The comment's text. The format is either plain text or HTML dependent on - # what has been requested. Even the plain text representation may differ - # from the text originally posted in that it may replace video links with - # video titles etc. + # The comment's text. The format is either plain text or HTML dependent on what + # has been requested. Even the plain text representation may differ from the + # text originally posted in that it may replace video links with video titles + # etc. # Corresponds to the JSON property `textDisplay` # @return [String] attr_accessor :text_display # The comment's original raw text as initially posted or last updated. The - # original text will only be returned if it is accessible to the viewer, - # which is only guaranteed if the viewer is the comment's author. + # original text will only be returned if it is accessible to the viewer, which + # is only guaranteed if the viewer is the comment's author. # Corresponds to the JSON property `textOriginal` # @return [String] attr_accessor :text_original - # The date and time when was last updated . The value is - # specified in ISO 8601 + # The date and time when was last updated . The value is specified in ISO 8601 # format. # Corresponds to the JSON property `updatedAt` # @return [String] @@ -2219,9 +2181,9 @@ module Google # @return [String] attr_accessor :video_id - # The rating the viewer has given to this comment. For the time being this - # will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. - # This may change in the future. + # The rating the viewer has given to this comment. For the time being this will + # never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may + # change in the future. # Corresponds to the JSON property `viewerRating` # @return [String] attr_accessor :viewer_rating @@ -2269,9 +2231,9 @@ module Google end end - # A comment thread represents information that - # applies to a top level comment and all its replies. It can also include the - # top level comment itself and some of the replies. + # A *comment thread* represents information that applies to a top level comment + # and all its replies. It can also include the top level comment itself and some + # of the replies. class CommentThread include Google::Apis::Core::Hashable @@ -2285,8 +2247,8 @@ module Google # @return [String] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#commentThread". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # commentThread". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2334,14 +2296,14 @@ module Google # @return [Array] attr_accessor :items - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#commentThreadListResponse". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # commentThreadListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken - # parameter to retrieve the next page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2357,7 +2319,7 @@ module Google # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination - # The visitorId identifies the visitor. + # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id @@ -2384,8 +2346,8 @@ module Google include Google::Apis::Core::Hashable # A limited number of replies. Unless the number of replies returned equals - # total_reply_count in the snippet the returned replies are only a subset - # of the total number of replies. + # total_reply_count in the snippet the returned replies are only a subset of the + # total number of replies. # Corresponds to the JSON property `comments` # @return [Array] attr_accessor :comments @@ -2411,21 +2373,21 @@ module Google attr_accessor :can_reply alias_method :can_reply?, :can_reply - # The YouTube channel the comments in the thread refer to or the channel - # with the video the comments refer to. If video_id isn't set the comments - # refer to the channel itself. + # The YouTube channel the comments in the thread refer to or the channel with + # the video the comments refer to. If video_id isn't set the comments refer to + # the channel itself. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id - # Whether the thread (and therefore all its comments) is visible to all - # YouTube users. + # Whether the thread (and therefore all its comments) is visible to all YouTube + # users. # Corresponds to the JSON property `isPublic` # @return [Boolean] attr_accessor :is_public alias_method :is_public?, :is_public - # A comment represents a single YouTube comment. + # A *comment* represents a single YouTube comment. # Corresponds to the JSON property `topLevelComment` # @return [Google::Apis::YoutubeV3::Comment] attr_accessor :top_level_comment @@ -2456,27 +2418,26 @@ module Google end end - # Ratings schemes. The country-specific ratings are mostly for - # movies and shows. + # Ratings schemes. The country-specific ratings are mostly for movies and shows. # LINT.IfChange class ContentRating include Google::Apis::Core::Hashable - # The video's Australian Classification Board (ACB) or Australian - # Communications and Media Authority (ACMA) rating. ACMA ratings are used - # to classify children's television programming. + # The video's Australian Classification Board (ACB) or Australian Communications + # and Media Authority (ACMA) rating. ACMA ratings are used to classify children' + # s television programming. # Corresponds to the JSON property `acbRating` # @return [String] attr_accessor :acb_rating - # The video's rating from Italy's Autorità per le Garanzie nelle - # Comunicazioni (AGCOM). + # The video's rating from Italy's Autorità per le Garanzie nelle Comunicazioni ( + # AGCOM). # Corresponds to the JSON property `agcomRating` # @return [String] attr_accessor :agcom_rating - # The video's Anatel (Asociación Nacional de Televisión) - # rating for Chilean television. + # The video's Anatel (Asociación Nacional de Televisión) rating for Chilean + # television. # Corresponds to the JSON property `anatelRating` # @return [String] attr_accessor :anatel_rating @@ -2491,27 +2452,23 @@ module Google # @return [String] attr_accessor :bfvc_rating - # The video's rating from the Austrian Board of Media Classification - # (Bundesministerium für Unterricht, Kunst und Kultur). + # The video's rating from the Austrian Board of Media Classification ( + # Bundesministerium für Unterricht, Kunst und Kultur). # Corresponds to the JSON property `bmukkRating` # @return [String] attr_accessor :bmukk_rating - # Rating system for Canadian TV - Canadian TV Classification System - # The video's rating from the Canadian Radio-Television and - # Telecommunications Commission (CRTC) for Canadian English-language - # broadcasts. For more information, see the - # Canadian - # Broadcast Standards Council website. + # Rating system for Canadian TV - Canadian TV Classification System The video's + # rating from the Canadian Radio-Television and Telecommunications Commission ( + # CRTC) for Canadian English-language broadcasts. For more information, see the + # Canadian Broadcast Standards Council website. # Corresponds to the JSON property `catvRating` # @return [String] attr_accessor :catv_rating - # The video's rating from the Canadian Radio-Television and - # Telecommunications Commission (CRTC) for Canadian French-language - # broadcasts. For more information, see the - # Canadian - # Broadcast Standards Council website. + # The video's rating from the Canadian Radio-Television and Telecommunications + # Commission (CRTC) for Canadian French-language broadcasts. For more + # information, see the Canadian Broadcast Standards Council website. # Corresponds to the JSON property `catvfrRating` # @return [String] attr_accessor :catvfr_rating @@ -2521,14 +2478,12 @@ module Google # @return [String] attr_accessor :cbfc_rating - # The video's Consejo de Calificación Cinematográfica (Chile) - # rating. + # The video's Consejo de Calificación Cinematográfica (Chile) rating. # Corresponds to the JSON property `cccRating` # @return [String] attr_accessor :ccc_rating - # The video's rating from Portugal's Comissão de - # Classificação de Espect´culos. + # The video's rating from Portugal's Comissão de Classificação de Espect´culos. # Corresponds to the JSON property `cceRating` # @return [String] attr_accessor :cce_rating @@ -2543,14 +2498,12 @@ module Google # @return [String] attr_accessor :chvrs_rating - # The video's rating from the Commission de Contrôle des Films - # (Belgium). + # The video's rating from the Commission de Contrôle des Films (Belgium). # Corresponds to the JSON property `cicfRating` # @return [String] attr_accessor :cicf_rating - # The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI - # (CNA). + # The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI (CNA). # Corresponds to the JSON property `cnaRating` # @return [String] attr_accessor :cna_rating @@ -2560,14 +2513,14 @@ module Google # @return [String] attr_accessor :cnc_rating - # The video's rating from France's Conseil supérieur de - # l’audiovisuel, which rates broadcast content. + # The video's rating from France's Conseil supérieur de l’audiovisuel, which + # rates broadcast content. # Corresponds to the JSON property `csaRating` # @return [String] attr_accessor :csa_rating - # The video's rating from Luxembourg's Commission de surveillance - # de la classification des films (CSCF). + # The video's rating from Luxembourg's Commission de surveillance de la + # classification des films (CSCF). # Corresponds to the JSON property `cscfRating` # @return [String] attr_accessor :cscf_rating @@ -2577,8 +2530,8 @@ module Google # @return [String] attr_accessor :czfilm_rating - # The video's Departamento de Justiça, Classificação, - # Qualificação e Títulos (DJCQT - Brazil) rating. + # The video's Departamento de Justiça, Classificação, Qualificação e Títulos ( + # DJCQT - Brazil) rating. # Corresponds to the JSON property `djctqRating` # @return [String] attr_accessor :djctq_rating @@ -2588,8 +2541,8 @@ module Google # @return [Array] attr_accessor :djctq_rating_reasons - # Rating system in Turkey - Evaluation and Classification Board of the - # Ministry of Culture and Tourism + # Rating system in Turkey - Evaluation and Classification Board of the Ministry + # of Culture and Tourism # Corresponds to the JSON property `ecbmctRating` # @return [String] attr_accessor :ecbmct_rating @@ -2604,8 +2557,7 @@ module Google # @return [String] attr_accessor :egfilm_rating - # The video's Eirin (映倫) rating. - # Eirin is the Japanese rating system. + # The video's Eirin (映倫) rating. Eirin is the Japanese rating system. # Corresponds to the JSON property `eirinRating` # @return [String] attr_accessor :eirin_rating @@ -2615,17 +2567,14 @@ module Google # @return [String] attr_accessor :fcbm_rating - # The video's rating from Hong Kong's Office for Film, Newspaper - # and Article Administration. + # The video's rating from Hong Kong's Office for Film, Newspaper and Article + # Administration. # Corresponds to the JSON property `fcoRating` # @return [String] attr_accessor :fco_rating - # This property has been deprecated. Use the - # contentDetails.contentRating. - # cncRating - # instead. + # This property has been deprecated. Use the contentDetails.contentRating. + # cncRating instead. # Corresponds to the JSON property `fmocRating` # @return [String] attr_accessor :fmoc_rating @@ -2640,8 +2589,8 @@ module Google # @return [Array] attr_accessor :fpb_rating_reasons - # The video's Freiwillige Selbstkontrolle der Filmwirtschaft - # (FSK - Germany) rating. + # The video's Freiwillige Selbstkontrolle der Filmwirtschaft (FSK - Germany) + # rating. # Corresponds to the JSON property `fskRating` # @return [String] attr_accessor :fsk_rating @@ -2651,16 +2600,14 @@ module Google # @return [String] attr_accessor :grfilm_rating - # The video's Instituto de la Cinematografía y de las Artes - # Audiovisuales (ICAA - Spain) rating. + # The video's Instituto de la Cinematografía y de las Artes Audiovisuales (ICAA - + # Spain) rating. # Corresponds to the JSON property `icaaRating` # @return [String] attr_accessor :icaa_rating - # The video's Irish Film Classification Office (IFCO - Ireland) rating. - # See the IFCO - # website for more information. + # The video's Irish Film Classification Office (IFCO - Ireland) rating. See the + # IFCO website for more information. # Corresponds to the JSON property `ifcoRating` # @return [String] attr_accessor :ifco_rating @@ -2681,15 +2628,14 @@ module Google # @return [String] attr_accessor :kfcb_rating - # The video's NICAM/Kijkwijzer rating from the Nederlands Instituut - # voor de Classificatie van Audiovisuele Media (Netherlands). + # The video's NICAM/Kijkwijzer rating from the Nederlands Instituut voor de + # Classificatie van Audiovisuele Media (Netherlands). # Corresponds to the JSON property `kijkwijzerRating` # @return [String] attr_accessor :kijkwijzer_rating - # The video's Korea Media Rating Board - # (영상물등급위원회) rating. - # The KMRB rates videos in South Korea. + # The video's Korea Media Rating Board (영상물등급위원회) rating. The KMRB rates videos + # in South Korea. # Corresponds to the JSON property `kmrbRating` # @return [String] attr_accessor :kmrb_rating @@ -2704,8 +2650,8 @@ module Google # @return [String] attr_accessor :mccaa_rating - # The video's rating from the Danish Film Institute's (Det Danske - # Filminstitut) Media Council for Children and Young People. + # The video's rating from the Danish Film Institute's (Det Danske Filminstitut) + # Media Council for Children and Young People. # Corresponds to the JSON property `mccypRating` # @return [String] attr_accessor :mccyp_rating @@ -2726,21 +2672,21 @@ module Google # @return [String] attr_accessor :medietilsynet_rating - # The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti - # (National Audiovisual Institute). + # The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti ( + # National Audiovisual Institute). # Corresponds to the JSON property `mekuRating` # @return [String] attr_accessor :meku_rating - # The rating system for MENA countries, a clone of MPAA. It is needed to - # prevent titles go live w/o additional QC check, since some of them can be + # The rating system for MENA countries, a clone of MPAA. It is needed to prevent + # titles go live w/o additional QC check, since some of them can be # inappropriate for the countries at all. See b/33408548 for more details. # Corresponds to the JSON property `menaMpaaRating` # @return [String] attr_accessor :mena_mpaa_rating - # The video's rating from the Ministero dei Beni e delle Attività - # Culturali e del Turismo (Italy). + # The video's rating from the Ministero dei Beni e delle Attività Culturali e + # del Turismo (Italy). # Corresponds to the JSON property `mibacRating` # @return [String] attr_accessor :mibac_rating @@ -2750,8 +2696,7 @@ module Google # @return [String] attr_accessor :moc_rating - # The video's rating from Taiwan's Ministry of Culture - # (文化部). + # The video's rating from Taiwan's Ministry of Culture (文化部). # Corresponds to the JSON property `moctwRating` # @return [String] attr_accessor :moctw_rating @@ -2761,14 +2706,14 @@ module Google # @return [String] attr_accessor :mpaa_rating - # The rating system for trailer, DVD, and Ad in the US. See - # http://movielabs.com/md/ratings/v2.3/html/US_MPAAT_Ratings.html. + # The rating system for trailer, DVD, and Ad in the US. See http://movielabs.com/ + # md/ratings/v2.3/html/US_MPAAT_Ratings.html. # Corresponds to the JSON property `mpaatRating` # @return [String] attr_accessor :mpaat_rating - # The video's rating from the Movie and Television Review and - # Classification Board (Philippines). + # The video's rating from the Movie and Television Review and Classification + # Board (Philippines). # Corresponds to the JSON property `mtrcbRating` # @return [String] attr_accessor :mtrcb_rating @@ -2783,8 +2728,7 @@ module Google # @return [String] attr_accessor :nbcpl_rating - # The video's rating from the Bulgarian - # National Film Center. + # The video's rating from the Bulgarian National Film Center. # Corresponds to the JSON property `nfrcRating` # @return [String] attr_accessor :nfrc_rating @@ -2794,8 +2738,8 @@ module Google # @return [String] attr_accessor :nfvcb_rating - # The video's rating from the Nacionãlais Kino centrs (National Film - # Centre of Latvia). + # The video's rating from the Nacionãlais Kino centrs (National Film Centre of + # Latvia). # Corresponds to the JSON property `nkclvRating` # @return [String] attr_accessor :nkclv_rating @@ -2805,8 +2749,8 @@ module Google # @return [String] attr_accessor :nmc_rating - # The video's Office of Film and Literature Classification - # (OFLC - New Zealand) rating. + # The video's Office of Film and Literature Classification (OFLC - New Zealand) + # rating. # Corresponds to the JSON property `oflcRating` # @return [String] attr_accessor :oflc_rating @@ -2816,8 +2760,8 @@ module Google # @return [String] attr_accessor :pefilm_rating - # The video's rating from the Hungarian Nemzeti Filmiroda, the Rating - # Committee of the National Office of Film. + # The video's rating from the Hungarian Nemzeti Filmiroda, the Rating Committee + # of the National Office of Film. # Corresponds to the JSON property `rcnofRating` # @return [String] attr_accessor :rcnof_rating @@ -2827,20 +2771,19 @@ module Google # @return [String] attr_accessor :resorteviolencia_rating - # The video's General Directorate of Radio, Television and Cinematography - # (Mexico) rating. + # The video's General Directorate of Radio, Television and Cinematography ( + # Mexico) rating. # Corresponds to the JSON property `rtcRating` # @return [String] attr_accessor :rtc_rating - # The video's rating from Ireland's Raidió Teilifís - # Éireann. + # The video's rating from Ireland's Raidió Teilifís Éireann. # Corresponds to the JSON property `rteRating` # @return [String] attr_accessor :rte_rating - # The video's National Film Registry of the Russian Federation - # (MKRF - Russia) rating. + # The video's National Film Registry of the Russian Federation (MKRF - Russia) + # rating. # Corresponds to the JSON property `russiaRating` # @return [String] attr_accessor :russia_rating @@ -2855,8 +2798,7 @@ module Google # @return [String] attr_accessor :smais_rating - # The video's rating from Statens medieråd (Sweden's National Media - # Council). + # The video's rating from Statens medieråd (Sweden's National Media Council). # Corresponds to the JSON property `smsaRating` # @return [String] attr_accessor :smsa_rating @@ -3013,13 +2955,11 @@ module Google end end - # A guideCategory resource identifies a category - # that YouTube algorithmically assigns based on a - # channel's content or other indicators, such as the channel's popularity. The - # list is similar to video categories, with the - # difference being that a video's uploader can assign a video category but only - # YouTube can assign a channel category. + # A *guideCategory* resource identifies a category that YouTube algorithmically + # assigns based on a channel's content or other indicators, such as the channel' + # s popularity. The list is similar to video categories, with the difference + # being that a video's uploader can assign a video category but only YouTube can + # assign a channel category. class GuideCategory include Google::Apis::Core::Hashable @@ -3033,8 +2973,8 @@ module Google # @return [String] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#guideCategory". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # guideCategory". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3071,21 +3011,21 @@ module Google # @return [String] attr_accessor :event_id - # A list of categories that can be associated with YouTube channels. In this - # map, the category ID is the map key, and its value is the corresponding - # guideCategory resource. + # A list of categories that can be associated with YouTube channels. In this map, + # the category ID is the map key, and its value is the corresponding + # guideCategory resource. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#guideCategoryListResponse". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # guideCategoryListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken - # parameter to retrieve the next page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -3096,8 +3036,8 @@ module Google # @return [Google::Apis::YoutubeV3::PageInfo] attr_accessor :page_info - # The token that can be used as the value of the pageToken - # parameter to retrieve the previous page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the previous page in the result set. # Corresponds to the JSON property `prevPageToken` # @return [String] attr_accessor :prev_page_token @@ -3107,7 +3047,7 @@ module Google # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination - # The visitorId identifies the visitor. + # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id @@ -3155,8 +3095,8 @@ module Google end end - # An i18nLanguage resource identifies a UI - # language currently supported by YouTube. + # An *i18nLanguage* resource identifies a UI language currently supported by + # YouTube. class I18nLanguage include Google::Apis::Core::Hashable @@ -3170,14 +3110,14 @@ module Google # @return [String] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#i18nLanguage". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # i18nLanguage". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Basic details about an i18n language, such as language code and - # human-readable name. + # Basic details about an i18n language, such as language code and human-readable + # name. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::I18nLanguageSnippet] attr_accessor :snippet @@ -3209,20 +3149,19 @@ module Google # @return [String] attr_accessor :event_id - # A list of supported i18n languages. In this map, the i18n language ID is - # the map key, and its value is the corresponding i18nLanguage - # resource. + # A list of supported i18n languages. In this map, the i18n language ID is the + # map key, and its value is the corresponding i18nLanguage resource. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#i18nLanguageListResponse". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # i18nLanguageListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The visitorId identifies the visitor. + # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id @@ -3241,8 +3180,8 @@ module Google end end - # Basic details about an i18n language, such as language code and - # human-readable name. + # Basic details about an i18n language, such as language code and human-readable + # name. class I18nLanguageSnippet include Google::Apis::Core::Hashable @@ -3267,8 +3206,7 @@ module Google end end - # A i18nRegion resource identifies a region where - # YouTube is available. + # A *i18nRegion* resource identifies a region where YouTube is available. class I18nRegion include Google::Apis::Core::Hashable @@ -3282,8 +3220,8 @@ module Google # @return [String] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#i18nRegion". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # i18nRegion". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3321,20 +3259,19 @@ module Google # @return [String] attr_accessor :event_id - # A list of regions where YouTube is available. In this map, the i18n region - # ID is the map key, and its value is the corresponding - # i18nRegion resource. + # A list of regions where YouTube is available. In this map, the i18n region ID + # is the map key, and its value is the corresponding i18nRegion resource. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#i18nRegionListResponse". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # i18nRegionListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The visitorId identifies the visitor. + # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id @@ -3389,8 +3326,8 @@ module Google # @return [Google::Apis::YoutubeV3::LocalizedProperty] attr_accessor :background_image_url - # This is used only in update requests; if it's set, we use this URL to - # generate all of the above banner URLs. + # This is used only in update requests; if it's set, we use this URL to generate + # all of the above banner URLs. # Corresponds to the JSON property `bannerExternalUrl` # @return [String] attr_accessor :banner_external_url @@ -3470,8 +3407,8 @@ module Google # @return [Google::Apis::YoutubeV3::LocalizedProperty] attr_accessor :large_branded_banner_image_imap_script - # The URL for the 854px by 70px image that appears below the video player in - # the expanded video view of the video watch page. + # The URL for the 854px by 70px image that appears below the video player in the + # expanded video view of the video watch page. # Corresponds to the JSON property `largeBrandedBannerImageUrl` # @return [Google::Apis::YoutubeV3::LocalizedProperty] attr_accessor :large_branded_banner_image_url @@ -3481,17 +3418,16 @@ module Google # @return [Google::Apis::YoutubeV3::LocalizedProperty] attr_accessor :small_branded_banner_image_imap_script - # The URL for the 640px by 70px banner image that appears below the video - # player in the default view of the video watch page. - # The URL for the image that appears above the top-left corner of the video - # player. This is a 25-pixel-high image with a flexible width that cannot - # exceed 170 pixels. + # The URL for the 640px by 70px banner image that appears below the video player + # in the default view of the video watch page. The URL for the image that + # appears above the top-left corner of the video player. This is a 25-pixel-high + # image with a flexible width that cannot exceed 170 pixels. # Corresponds to the JSON property `smallBrandedBannerImageUrl` # @return [Google::Apis::YoutubeV3::LocalizedProperty] attr_accessor :small_branded_banner_image_url - # The URL for a 1px by 1px tracking pixel that can be used to collect - # statistics for views of the channel or video pages. + # The URL for a 1px by 1px tracking pixel that can be used to collect statistics + # for views of the channel or video pages. # Corresponds to the JSON property `trackingImageUrl` # @return [String] attr_accessor :tracking_image_url @@ -3588,8 +3524,7 @@ module Google # @return [Google::Apis::YoutubeV3::PlaylistCard] attr_accessor :playlist_infocard - # Each card can have a teaser. - # Required. + # Each card can have a teaser. Required. # Corresponds to the JSON property `teaser` # @return [Google::Apis::YoutubeV3::InfoCardSnippetTeaser] attr_accessor :teaser @@ -3617,16 +3552,14 @@ module Google class InfoCardSnippetTeaser include Google::Apis::Core::Hashable - # The offset from the video start at which the teaser should be displayed - # (activated), in milliseconds. - # Required. + # The offset from the video start at which the teaser should be displayed ( + # activated), in milliseconds. Required. # Corresponds to the JSON property `teaserStartOffset` # @return [String] attr_accessor :teaser_start_offset - # The teaser text to show at the top of the player for the info-card. - # Required for channel and link type cards. - # Optional for video and playlist type cards. + # The teaser text to show at the top of the player for the info-card. Required + # for channel and link type cards. Optional for video and playlist type cards. # Corresponds to the JSON property `teaserText` # @return [String] attr_accessor :teaser_text @@ -3696,33 +3629,30 @@ module Google class IngestionInfo include Google::Apis::Core::Hashable - # The backup ingestion URL that you should use to stream video to - # YouTube. You have the option of simultaneously streaming the content - # that you are sending to the ingestionAddress to this URL. + # The backup ingestion URL that you should use to stream video to YouTube. You + # have the option of simultaneously streaming the content that you are sending + # to the ingestionAddress to this URL. # Corresponds to the JSON property `backupIngestionAddress` # @return [String] attr_accessor :backup_ingestion_address - # The primary ingestion URL that you should use to stream video to - # YouTube. You must stream video to this URL.

- # Depending on which application or tool you use to encode - # your video stream, you may need to enter the stream URL and stream - # name separately or you may need to concatenate them in the following - # format:
STREAM_URL/STREAM_NAME
+ # The primary ingestion URL that you should use to stream video to YouTube. You + # must stream video to this URL. Depending on which application or tool you use + # to encode your video stream, you may need to enter the stream URL and stream + # name separately or you may need to concatenate them in the following format: * + # STREAM_URL/STREAM_NAME* # Corresponds to the JSON property `ingestionAddress` # @return [String] attr_accessor :ingestion_address - # This ingestion url may be used instead of - # backupIngestionAddress in order to stream via RTMPS. Not - # applicable to non-RTMP streams. + # This ingestion url may be used instead of backupIngestionAddress in order to + # stream via RTMPS. Not applicable to non-RTMP streams. # Corresponds to the JSON property `rtmpsBackupIngestionAddress` # @return [String] attr_accessor :rtmps_backup_ingestion_address - # This ingestion url may be used instead of - # ingestionAddress in order to stream via RTMPS. Not applicable - # to non-RTMP streams. + # This ingestion url may be used instead of ingestionAddress in order to stream + # via RTMPS. Not applicable to non-RTMP streams. # Corresponds to the JSON property `rtmpsIngestionAddress` # @return [String] attr_accessor :rtmps_ingestion_address @@ -3746,8 +3676,7 @@ module Google end end - # LINT.IfChange - # Describes an invideo branding. + # LINT.IfChange Describes an invideo branding. class InvideoBranding include Google::Apis::Core::Hashable @@ -3768,8 +3697,8 @@ module Google # @return [Google::Apis::YoutubeV3::InvideoPosition] attr_accessor :position - # The channel to which this branding links. If not present it defaults to - # the current channel. + # The channel to which this branding links. If not present it defaults to the + # current channel. # Corresponds to the JSON property `targetChannelId` # @return [String] attr_accessor :target_channel_id @@ -3819,8 +3748,8 @@ module Google end end - # Describes an invideo promotion campaign consisting of multiple promoted - # items. A campaign belongs to a single channel_id. + # Describes an invideo promotion campaign consisting of multiple promoted items. + # A campaign belongs to a single channel_id. class InvideoPromotion include Google::Apis::Core::Hashable @@ -3840,11 +3769,10 @@ module Google # @return [Google::Apis::YoutubeV3::InvideoPosition] attr_accessor :position - # Indicates whether the channel's promotional campaign uses "smart timing." - # This feature attempts to show promotions at a point in the video when they - # are more likely to be clicked and less likely to disrupt the viewing - # experience. This feature also picks up a single promotion to show on each - # video. + # Indicates whether the channel's promotional campaign uses "smart timing." This + # feature attempts to show promotions at a point in the video when they are more + # likely to be clicked and less likely to disrupt the viewing experience. This + # feature also picks up a single promotion to show on each video. # Corresponds to the JSON property `useSmartTiming` # @return [Boolean] attr_accessor :use_smart_timing @@ -3873,18 +3801,17 @@ module Google # @return [Fixnum] attr_accessor :duration_ms - # Defines the time at which the promotion will appear. Depending on the value - # of type the value of the offsetMs field will - # represent a time offset from the start or from the end of the video, - # expressed in milliseconds. + # Defines the time at which the promotion will appear. Depending on the value of + # type the value of the offsetMs field will represent a time offset from the + # start or from the end of the video, expressed in milliseconds. # Corresponds to the JSON property `offsetMs` # @return [Fixnum] attr_accessor :offset_ms - # Describes a timing type. If the value is offsetFromStart, then - # the offsetMs field represents an offset from the start of the - # video. If the value is offsetFromEnd, then the - # offsetMs field represents an offset from the end of the video. + # Describes a timing type. If the value is offsetFromStart, then the offsetMs + # field represents an offset from the start of the video. If the value is + # offsetFromEnd, then the offsetMs field represents an offset from the end of + # the video. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -3943,8 +3870,7 @@ module Google class LinkCard include Google::Apis::Core::Hashable - # Custom text to show as the website link. - # Required. + # Custom text to show as the website link. Required. # Corresponds to the JSON property `customLinkText` # @return [String] attr_accessor :custom_link_text @@ -3954,14 +3880,12 @@ module Google # @return [String] attr_accessor :external_image_url - # The URL to which this card points. - # Required. + # The URL to which this card points. Required. # Corresponds to the JSON property `targetUrl` # @return [String] attr_accessor :target_url - # The title to show on the card. - # Required. + # The title to show on the card. Required. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -4010,8 +3934,8 @@ module Google end end - # A liveBroadcast resource represents an event - # that will be streamed, via live video, on YouTube. + # A *liveBroadcast* resource represents an event that will be streamed, via live + # video, on YouTube. class LiveBroadcast include Google::Apis::Core::Hashable @@ -4030,8 +3954,8 @@ module Google # @return [String] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#liveBroadcast". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # liveBroadcast". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -4072,15 +3996,13 @@ module Google class LiveBroadcastContentDetails include Google::Apis::Core::Hashable - # This value uniquely identifies the - # live stream - # bound to the broadcast. + # This value uniquely identifies the live stream bound to the broadcast. # Corresponds to the JSON property `boundStreamId` # @return [String] attr_accessor :bound_stream_id - # The date and time that the live stream referenced by - # boundStreamId was last updated. + # The date and time that the live stream referenced by boundStreamId was last + # updated. # Corresponds to the JSON property `boundStreamLastUpdateTimeMs` # @return [String] attr_accessor :bound_stream_last_update_time_ms @@ -4090,56 +4012,53 @@ module Google # @return [String] attr_accessor :closed_captions_type - # This setting indicates whether auto start is enabled for this broadcast. - # The default value for this property is false.

- # This setting can only be used by Events. + # This setting indicates whether auto start is enabled for this broadcast. The + # default value for this property is false. This setting can only be used by + # Events. # Corresponds to the JSON property `enableAutoStart` # @return [Boolean] attr_accessor :enable_auto_start alias_method :enable_auto_start?, :enable_auto_start - # This setting indicates whether auto stop is enabled for this broadcast. - # The default value for this property is false.

- # This setting can only be used by Events. + # This setting indicates whether auto stop is enabled for this broadcast. The + # default value for this property is false. This setting can only be used by + # Events. # Corresponds to the JSON property `enableAutoStop` # @return [Boolean] attr_accessor :enable_auto_stop alias_method :enable_auto_stop?, :enable_auto_stop - # This setting indicates whether HTTP POST closed captioning is enabled for - # this broadcast. The ingestion URL of the closed captions is returned - # through the liveStreams API. This is mutually exclusive with using the - # closed_captions_type property, and is equivalent to setting - # closed_captions_type to CLOSED_CAPTIONS_HTTP_POST. + # This setting indicates whether HTTP POST closed captioning is enabled for this + # broadcast. The ingestion URL of the closed captions is returned through the + # liveStreams API. This is mutually exclusive with using the + # closed_captions_type property, and is equivalent to setting + # closed_captions_type to CLOSED_CAPTIONS_HTTP_POST. # Corresponds to the JSON property `enableClosedCaptions` # @return [Boolean] attr_accessor :enable_closed_captions alias_method :enable_closed_captions?, :enable_closed_captions - # This setting indicates whether YouTube should enable content encryption - # for the broadcast. + # This setting indicates whether YouTube should enable content encryption for + # the broadcast. # Corresponds to the JSON property `enableContentEncryption` # @return [Boolean] attr_accessor :enable_content_encryption alias_method :enable_content_encryption?, :enable_content_encryption - # This setting determines whether viewers can access DVR controls while - # watching the video. DVR controls enable the viewer to control the video - # playback experience by pausing, rewinding, or fast forwarding content. - # The default value for this property is true.

- # Important: You must set the value to true - # and also set the enableArchive property's value to - # true if you want to make playback available immediately - # after the broadcast ends. + # This setting determines whether viewers can access DVR controls while watching + # the video. DVR controls enable the viewer to control the video playback + # experience by pausing, rewinding, or fast forwarding content. The default + # value for this property is true. *Important:* You must set the value to true + # and also set the enableArchive property's value to true if you want to make + # playback available immediately after the broadcast ends. # Corresponds to the JSON property `enableDvr` # @return [Boolean] attr_accessor :enable_dvr alias_method :enable_dvr?, :enable_dvr # This setting indicates whether the broadcast video can be played in an - # embedded player. If you choose to archive the video (using the - # enableArchive property), this setting will also apply to - # the archived video. + # embedded player. If you choose to archive the video (using the enableArchive + # property), this setting will also apply to the archived video. # Corresponds to the JSON property `enableEmbed` # @return [Boolean] attr_accessor :enable_embed @@ -4151,20 +4070,17 @@ module Google attr_accessor :enable_low_latency alias_method :enable_low_latency?, :enable_low_latency - # If both this and enable_low_latency are set, they must match. - # LATENCY_NORMAL should match enable_low_latency=false - # LATENCY_LOW should match enable_low_latency=true - # LATENCY_ULTRA_LOW should have enable_low_latency omitted. + # If both this and enable_low_latency are set, they must match. LATENCY_NORMAL + # should match enable_low_latency=false LATENCY_LOW should match + # enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency + # omitted. # Corresponds to the JSON property `latencyPreference` # @return [String] attr_accessor :latency_preference - # The mesh for projecting the video if projection is - # mesh. The mesh value must be a UTF-8 string containing the - # base-64 encoding of 3D mesh data that follows the - # Spherical Video V2 RFC specification for an mshp box, excluding the box + # The mesh for projecting the video if projection is mesh. The mesh value must + # be a UTF-8 string containing the base-64 encoding of 3D mesh data that follows + # the Spherical Video V2 RFC specification for an mshp box, excluding the box # size and type but including the following four reserved zero bytes for the # version and flags. # Corresponds to the JSON property `mesh` @@ -4177,37 +4093,27 @@ module Google # @return [Google::Apis::YoutubeV3::MonitorStreamInfo] attr_accessor :monitor_stream - # The projection format of this broadcast. This defaults to - # rectangular. + # The projection format of this broadcast. This defaults to rectangular. # Corresponds to the JSON property `projection` # @return [String] attr_accessor :projection - # Automatically start recording after the event goes live. - # The default value for this property is true.

- # Important: You must also set the enableDvr - # property's value to - # true if you want the playback to be available immediately - # after the broadcast ends. If you set this property's value to - # true but do not also set the enableDvr property - # to true, there may be a delay of around one day before the - # archived video will be available for playback. + # Automatically start recording after the event goes live. The default value for + # this property is true. *Important:* You must also set the enableDvr property's + # value to true if you want the playback to be available immediately after the + # broadcast ends. If you set this property's value to true but do not also set + # the enableDvr property to true, there may be a delay of around one day before + # the archived video will be available for playback. # Corresponds to the JSON property `recordFromStart` # @return [Boolean] attr_accessor :record_from_start alias_method :record_from_start?, :record_from_start - # This setting indicates whether the broadcast should automatically begin - # with an in-stream - # slate when you update the broadcast's status to live. - # After updating the status, you then need to send a - # liveCuepoints.insert - # request that sets the cuepoint's eventState to - # end to remove the in-stream slate and make your broadcast - # stream visible to viewers. + # This setting indicates whether the broadcast should automatically begin with + # an in-stream slate when you update the broadcast's status to live. After + # updating the status, you then need to send a liveCuepoints.insert request that + # sets the cuepoint's eventState to end to remove the in-stream slate and make + # your broadcast stream visible to viewers. # Corresponds to the JSON property `startWithSlate` # @return [Boolean] attr_accessor :start_with_slate @@ -4257,14 +4163,14 @@ module Google # @return [Array] attr_accessor :items - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#liveBroadcastListResponse". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # liveBroadcastListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken - # parameter to retrieve the next page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -4275,8 +4181,8 @@ module Google # @return [Google::Apis::YoutubeV3::PageInfo] attr_accessor :page_info - # The token that can be used as the value of the pageToken - # parameter to retrieve the previous page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the previous page in the result set. # Corresponds to the JSON property `prevPageToken` # @return [String] attr_accessor :prev_page_token @@ -4286,7 +4192,7 @@ module Google # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination - # The visitorId identifies the visitor. + # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id @@ -4313,39 +4219,34 @@ module Google class LiveBroadcastSnippet include Google::Apis::Core::Hashable - # The date and time that the broadcast actually ended. This information is - # only available once the broadcast's state is complete. The - # value is specified in ISO 8601 - # format. + # The date and time that the broadcast actually ended. This information is only + # available once the broadcast's state is complete. The value is specified in + # ISO 8601 format. # Corresponds to the JSON property `actualEndTime` # @return [String] attr_accessor :actual_end_time # The date and time that the broadcast actually started. This information is - # only available once the broadcast's state is live. The - # value is specified in ISO 8601 - # format. + # only available once the broadcast's state is live. The value is specified in + # ISO 8601 format. # Corresponds to the JSON property `actualStartTime` # @return [String] attr_accessor :actual_start_time - # The ID that YouTube uses to uniquely identify the channel that - # is publishing the broadcast. + # The ID that YouTube uses to uniquely identify the channel that is publishing + # the broadcast. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id - # The broadcast's description. As with the title, you can set - # this field by modifying the broadcast resource or by setting the - # description - # field of the corresponding video resource. + # The broadcast's description. As with the title, you can set this field by + # modifying the broadcast resource or by setting the description field of the + # corresponding video resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Indicates whether this broadcast is the default broadcast. - # Internal only. + # Indicates whether this broadcast is the default broadcast. Internal only. # Corresponds to the JSON property `isDefaultBroadcast` # @return [Boolean] attr_accessor :is_default_broadcast @@ -4357,23 +4258,19 @@ module Google attr_accessor :live_chat_id # The date and time that the broadcast was added to YouTube's live broadcast - # schedule. The value is specified in - # ISO 8601 - # format. + # schedule. The value is specified in ISO 8601 format. # Corresponds to the JSON property `publishedAt` # @return [String] attr_accessor :published_at - # The date and time that the broadcast is scheduled to end. The value - # is specified in ISO 8601 - # format. + # The date and time that the broadcast is scheduled to end. The value is + # specified in ISO 8601 format. # Corresponds to the JSON property `scheduledEndTime` # @return [String] attr_accessor :scheduled_end_time - # The date and time that the broadcast is scheduled to start. The value - # is specified in ISO 8601 - # format. + # The date and time that the broadcast is scheduled to start. The value is + # specified in ISO 8601 format. # Corresponds to the JSON property `scheduledStartTime` # @return [String] attr_accessor :scheduled_start_time @@ -4383,11 +4280,9 @@ module Google # @return [Google::Apis::YoutubeV3::ThumbnailDetails] attr_accessor :thumbnails - # The broadcast's title. Note that the broadcast represents exactly one - # YouTube video. You can set this field by modifying the broadcast resource - # or by setting the - # title - # field of the corresponding video resource. + # The broadcast's title. Note that the broadcast represents exactly one YouTube + # video. You can set this field by modifying the broadcast resource or by + # setting the title field of the corresponding video resource. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -4418,11 +4313,11 @@ module Google include Google::Apis::Core::Hashable # The total number of live chat messages currently on the broadcast. The - # property and its value will be present if the broadcast is public, has - # the live chat feature enabled, and has at least one message. Note that - # this field will not be filled after the broadcast ends. So this property - # would not identify the number of chat messages for an archived video of a - # completed live broadcast. + # property and its value will be present if the broadcast is public, has the + # live chat feature enabled, and has at least one message. Note that this field + # will not be filled after the broadcast ends. So this property would not + # identify the number of chat messages for an archived video of a completed live + # broadcast. # Corresponds to the JSON property `totalChatCount` # @return [Fixnum] attr_accessor :total_chat_count @@ -4442,9 +4337,7 @@ module Google include Google::Apis::Core::Hashable # The broadcast's status. The status can be updated using the API's - # liveBroadcasts.transition method. + # liveBroadcasts.transition method. # Corresponds to the JSON property `lifeCycleStatus` # @return [String] attr_accessor :life_cycle_status @@ -4454,21 +4347,18 @@ module Google # @return [String] attr_accessor :live_broadcast_priority - # Whether the broadcast is made for kids or not, decided by YouTube instead - # of the creator. This field is read only. + # Whether the broadcast is made for kids or not, decided by YouTube instead of + # the creator. This field is read only. # Corresponds to the JSON property `madeForKids` # @return [Boolean] attr_accessor :made_for_kids alias_method :made_for_kids?, :made_for_kids - # The broadcast's privacy status. Note that the broadcast represents - # exactly one YouTube video, so the privacy settings are identical to - # those supported for videos. In addition, you can set this field by - # modifying the broadcast resource or by setting the - # privacyStatus - # field of the corresponding video resource. + # The broadcast's privacy status. Note that the broadcast represents exactly one + # YouTube video, so the privacy settings are identical to those supported for + # videos. In addition, you can set this field by modifying the broadcast + # resource or by setting the privacyStatus field of the corresponding video + # resource. # Corresponds to the JSON property `privacyStatus` # @return [String] attr_accessor :privacy_status @@ -4514,8 +4404,8 @@ module Google # @return [String] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string - # `"youtube#liveChatBan"`. + # Identifies what kind of resource this is. Value: the fixed string `"youtube# + # liveChatBan"`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -4612,13 +4502,12 @@ module Google end end - # A liveChatMessage resource represents a chat - # message in a YouTube Live Chat. + # A *liveChatMessage* resource represents a chat message in a YouTube Live Chat. class LiveChatMessage include Google::Apis::Core::Hashable - # The authorDetails object contains basic details about the - # user that posted this message. + # The authorDetails object contains basic details about the user that posted + # this message. # Corresponds to the JSON property `authorDetails` # @return [Google::Apis::YoutubeV3::LiveChatMessageAuthorDetails] attr_accessor :author_details @@ -4633,13 +4522,13 @@ module Google # @return [String] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#liveChatMessage". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # liveChatMessage". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The snippet object contains basic details about the message. + # The snippet object contains basic details about the message. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::LiveChatMessageSnippet] attr_accessor :snippet @@ -4761,8 +4650,8 @@ module Google # @return [Array] attr_accessor :items - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#liveChatMessageListResponse". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # liveChatMessageListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -4773,8 +4662,7 @@ module Google attr_accessor :next_page_token # The date and time when the underlying stream went offline. The value is - # specified in ISO 8601 - # format. + # specified in ISO 8601 format. # Corresponds to the JSON property `offlineAt` # @return [String] attr_accessor :offline_at @@ -4795,7 +4683,7 @@ module Google # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination - # The visitorId identifies the visitor. + # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id @@ -4842,28 +4730,26 @@ module Google class LiveChatMessageSnippet include Google::Apis::Core::Hashable - # The ID of the user that authored this message, this field is not always - # filled. - # textMessageEvent - the user that wrote the message - # fanFundingEvent - the user that funded the broadcast - # newSponsorEvent - the user that just became a sponsor - # messageDeletedEvent - the moderator that took the action + # The ID of the user that authored this message, this field is not always filled. + # textMessageEvent - the user that wrote the message fanFundingEvent - the user + # that funded the broadcast newSponsorEvent - the user that just became a + # sponsor messageDeletedEvent - the moderator that took the action # messageRetractedEvent - the author that retracted their message - # userBannedEvent - the moderator that took the action - # superChatEvent - the user that made the purchase + # userBannedEvent - the moderator that took the action superChatEvent - the user + # that made the purchase # Corresponds to the JSON property `authorChannelId` # @return [String] attr_accessor :author_channel_id - # Contains a string that can be displayed to the user. - # If this field is not present the message is silent, at the moment only - # messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent. + # Contains a string that can be displayed to the user. If this field is not + # present the message is silent, at the moment only messages of type TOMBSTONE + # and CHAT_ENDED_EVENT are silent. # Corresponds to the JSON property `displayMessage` # @return [String] attr_accessor :display_message - # Details about the funding event, this is only set if the type is - # 'fanFundingEvent'. + # Details about the funding event, this is only set if the type is ' + # fanFundingEvent'. # Corresponds to the JSON property `fanFundingEventDetails` # @return [Google::Apis::YoutubeV3::LiveChatFanFundingEventDetails] attr_accessor :fan_funding_event_details @@ -4890,32 +4776,31 @@ module Google attr_accessor :message_retracted_details # The date and time when the message was orignally published. The value is - # specified in ISO 8601 - # format. + # specified in ISO 8601 format. # Corresponds to the JSON property `publishedAt` # @return [String] attr_accessor :published_at - # Details about the Super Chat event, this is only set if the type is - # 'superChatEvent'. + # Details about the Super Chat event, this is only set if the type is ' + # superChatEvent'. # Corresponds to the JSON property `superChatDetails` # @return [Google::Apis::YoutubeV3::LiveChatSuperChatDetails] attr_accessor :super_chat_details - # Details about the Super Sticker event, this is only set if the type is - # 'superStickerEvent'. + # Details about the Super Sticker event, this is only set if the type is ' + # superStickerEvent'. # Corresponds to the JSON property `superStickerDetails` # @return [Google::Apis::YoutubeV3::LiveChatSuperStickerDetails] attr_accessor :super_sticker_details - # Details about the text message, this is only set if the type is - # 'textMessageEvent'. + # Details about the text message, this is only set if the type is ' + # textMessageEvent'. # Corresponds to the JSON property `textMessageDetails` # @return [Google::Apis::YoutubeV3::LiveChatTextMessageDetails] attr_accessor :text_message_details - # The type of message, this will always be present, it determines the - # contents of the message as well as which fields will be present. + # The type of message, this will always be present, it determines the contents + # of the message as well as which fields will be present. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -4947,9 +4832,9 @@ module Google end end - # A liveChatModerator resource represents a - # moderator for a YouTube live chat. A chat moderator has the ability to - # ban/unban users from a chat, remove message, etc. + # A *liveChatModerator* resource represents a moderator for a YouTube live chat. + # A chat moderator has the ability to ban/unban users from a chat, remove + # message, etc. class LiveChatModerator include Google::Apis::Core::Hashable @@ -4963,14 +4848,13 @@ module Google # @return [String] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#liveChatModerator". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # liveChatModerator". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The snippet object contains basic details about the - # moderator. + # The snippet object contains basic details about the moderator. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::LiveChatModeratorSnippet] attr_accessor :snippet @@ -5007,14 +4891,14 @@ module Google # @return [Array] attr_accessor :items - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#liveChatModeratorListResponse". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # liveChatModeratorListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken - # parameter to retrieve the next page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5025,8 +4909,8 @@ module Google # @return [Google::Apis::YoutubeV3::PageInfo] attr_accessor :page_info - # The token that can be used as the value of the pageToken - # parameter to retrieve the previous page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the previous page in the result set. # Corresponds to the JSON property `prevPageToken` # @return [String] attr_accessor :prev_page_token @@ -5036,7 +4920,7 @@ module Google # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination - # The visitorId identifies the visitor. + # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id @@ -5103,8 +4987,8 @@ module Google # @return [String] attr_accessor :currency - # The tier in which the amount belongs. Lower amounts belong to lower - # tiers. The lowest tier is 1. + # The tier in which the amount belongs. Lower amounts belong to lower tiers. The + # lowest tier is 1. # Corresponds to the JSON property `tier` # @return [Fixnum] attr_accessor :tier @@ -5152,8 +5036,8 @@ module Google # @return [Google::Apis::YoutubeV3::SuperStickerMetadata] attr_accessor :super_sticker_metadata - # The tier in which the amount belongs. Lower amounts belong to lower - # tiers. The lowest tier is 1. + # The tier in which the amount belongs. Lower amounts belong to lower tiers. The + # lowest tier is 1. # Corresponds to the JSON property `tier` # @return [Fixnum] attr_accessor :tier @@ -5195,8 +5079,8 @@ module Google class LiveChatUserBannedMessageDetails include Google::Apis::Core::Hashable - # The duration of the ban. This property is only present if the - # banType is temporary. + # The duration of the ban. This property is only present if the banType is + # temporary. # Corresponds to the JSON property `banDurationSeconds` # @return [Fixnum] attr_accessor :ban_duration_seconds @@ -5247,14 +5131,14 @@ module Google # @return [String] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#liveStream". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # liveStream". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The snippet object contains basic details about the - # stream, including its channel, title, and description. + # The snippet object contains basic details about the stream, including its + # channel, title, and description. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::LiveStreamSnippet] attr_accessor :snippet @@ -5326,25 +5210,17 @@ module Google # @return [String] attr_accessor :closed_captions_ingestion_url - # Indicates whether the stream is reusable, which means that it - # can be bound to multiple broadcasts. It is common for - # broadcasters to reuse the same stream for many different - # broadcasts if those broadcasts occur at different times.

- # If you set this value to false, then the stream - # will not be reusable, which means that it can only be bound to - # one broadcast. Non-reusable streams differ from reusable streams in the - # following ways: - #
    - #
  • A non-reusable stream can only be bound to one broadcast.
    • - #
  • A non-reusable stream might be deleted by an automated process - # after the broadcast ends.
    • - #
  • The - # liveStreams.list method does not list non-reusable streams - # if you call the method and set the mine parameter to - # true. The only way to use that method to retrieve the - # resource for a non-reusable stream is to use the id - # parameter to identify the stream.
    • - #
+ # Indicates whether the stream is reusable, which means that it can be bound to + # multiple broadcasts. It is common for broadcasters to reuse the same stream + # for many different broadcasts if those broadcasts occur at different times. If + # you set this value to false, then the stream will not be reusable, which means + # that it can only be bound to one broadcast. Non-reusable streams differ from + # reusable streams in the following ways: - A non-reusable stream can only be + # bound to one broadcast. - A non-reusable stream might be deleted by an + # automated process after the broadcast ends. - The liveStreams.list method does + # not list non-reusable streams if you call the method and set the mine + # parameter to true. The only way to use that method to retrieve the resource + # for a non-reusable stream is to use the id parameter to identify the stream. # Corresponds to the JSON property `isReusable` # @return [Boolean] attr_accessor :is_reusable @@ -5411,14 +5287,14 @@ module Google # @return [Array] attr_accessor :items - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#liveStreamListResponse". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # liveStreamListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken - # parameter to retrieve the next page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5429,8 +5305,8 @@ module Google # @return [Google::Apis::YoutubeV3::PageInfo] attr_accessor :page_info - # The token that can be used as the value of the pageToken - # parameter to retrieve the previous page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the previous page in the result set. # Corresponds to the JSON property `prevPageToken` # @return [String] attr_accessor :prev_page_token @@ -5440,7 +5316,7 @@ module Google # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination - # The visitorId identifies the visitor. + # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id @@ -5467,14 +5343,13 @@ module Google class LiveStreamSnippet include Google::Apis::Core::Hashable - # The ID that YouTube uses to uniquely identify the channel that - # is transmitting the stream. + # The ID that YouTube uses to uniquely identify the channel that is transmitting + # the stream. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id - # The stream's description. The value cannot be longer than 10000 - # characters. + # The stream's description. The value cannot be longer than 10000 characters. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -5485,9 +5360,8 @@ module Google attr_accessor :is_default_stream alias_method :is_default_stream?, :is_default_stream - # The date and time that the stream was created. The value is specified in - # ISO 8601 - # format. + # The date and time that the stream was created. The value is specified in ISO + # 8601 format. # Corresponds to the JSON property `publishedAt` # @return [String] attr_accessor :published_at @@ -5592,9 +5466,8 @@ module Google end end - # A member resource represents a member for a - # YouTube channel. A member provides recurring monetary support to a creator - # and receives special benefits. + # A *member* resource represents a member for a YouTube channel. A member + # provides recurring monetary support to a creator and receives special benefits. class Member include Google::Apis::Core::Hashable @@ -5603,13 +5476,13 @@ module Google # @return [String] attr_accessor :etag - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#member". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # member". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The snippet object contains basic details about the member. + # The snippet object contains basic details about the member. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::MemberSnippet] attr_accessor :snippet @@ -5645,14 +5518,14 @@ module Google # @return [Array] attr_accessor :items - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#memberListResponse". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # memberListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken - # parameter to retrieve the next page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5668,7 +5541,7 @@ module Google # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination - # The visitorId identifies the visitor. + # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id @@ -5737,8 +5610,7 @@ module Google # @return [String] attr_accessor :highest_accessible_level - # Display name for the highest level that the user has access to at the - # moment. + # Display name for the highest level that the user has access to at the moment. # Corresponds to the JSON property `highestAccessibleLevelDisplayName` # @return [String] attr_accessor :highest_accessible_level_display_name @@ -5772,14 +5644,13 @@ module Google class MembershipsDuration include Google::Apis::Core::Hashable - # The date and time when the user became a continuous member across all - # levels. + # The date and time when the user became a continuous member across all levels. # Corresponds to the JSON property `memberSince` # @return [String] attr_accessor :member_since - # The cumulative time the user has been a member across all levels in - # complete months (the time is rounded down to the nearest integer). + # The cumulative time the user has been a member across all levels in complete + # months (the time is rounded down to the nearest integer). # Corresponds to the JSON property `memberTotalDurationMonths` # @return [Fixnum] attr_accessor :member_total_duration_months @@ -5804,14 +5675,13 @@ module Google # @return [String] attr_accessor :level - # The date and time when the user became a continuous member for the given - # level. + # The date and time when the user became a continuous member for the given level. # Corresponds to the JSON property `memberSince` # @return [String] attr_accessor :member_since - # The cumulative time the user has been a member for the given level in - # complete months (the time is rounded down to the nearest integer). + # The cumulative time the user has been a member for the given level in complete + # months (the time is rounded down to the nearest integer). # Corresponds to the JSON property `memberTotalDurationMonths` # @return [Fixnum] attr_accessor :member_total_duration_months @@ -5828,10 +5698,10 @@ module Google end end - # A membershipsLevel resource represents an offer - # made by YouTube creators for their fans. Users can become members of the - # channel by joining one of the available levels. They will provide recurring - # monetary support and receives special benefits. + # A *membershipsLevel* resource represents an offer made by YouTube creators for + # their fans. Users can become members of the channel by joining one of the + # available levels. They will provide recurring monetary support and receives + # special benefits. class MembershipsLevel include Google::Apis::Core::Hashable @@ -5845,13 +5715,13 @@ module Google # @return [String] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#membershipsLevelListResponse". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # membershipsLevelListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The snippet object contains basic details about the level. + # The snippet object contains basic details about the level. # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::MembershipsLevelSnippet] attr_accessor :snippet @@ -5888,13 +5758,13 @@ module Google # @return [Array] attr_accessor :items - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#membershipsLevelListResponse". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # membershipsLevelListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The visitorId identifies the visitor. + # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id @@ -5942,10 +5812,8 @@ module Google class MonitorStreamInfo include Google::Apis::Core::Hashable - # If you have set the - # enableMonitorStream - # property to true, then this property determines the - # length of the live broadcast delay. + # If you have set the enableMonitorStream property to true, then this property + # determines the length of the live broadcast delay. # Corresponds to the JSON property `broadcastStreamDelayMs` # @return [Fixnum] attr_accessor :broadcast_stream_delay_ms @@ -5955,16 +5823,13 @@ module Google # @return [String] attr_accessor :embed_html - # This value determines whether the monitor stream is enabled for the - # broadcast. If the monitor stream is enabled, then YouTube will - # broadcast the event content on a special stream intended only for - # the broadcaster's consumption. The broadcaster can use the stream - # to review the event content and also to identify the optimal times - # to insert cuepoints.

- # You need to set this value to true if you intend to have - # a broadcast delay for your event.

- # Note: This property cannot be updated once the - # broadcast is in the testing or live state. + # This value determines whether the monitor stream is enabled for the broadcast. + # If the monitor stream is enabled, then YouTube will broadcast the event + # content on a special stream intended only for the broadcaster's consumption. + # The broadcaster can use the stream to review the event content and also to + # identify the optimal times to insert cuepoints. You need to set this value to + # true if you intend to have a broadcast delay for your event. *Note:* This + # property cannot be updated once the broadcast is in the testing or live state. # Corresponds to the JSON property `enableMonitorStream` # @return [Boolean] attr_accessor :enable_monitor_stream @@ -6008,39 +5873,24 @@ module Google end end - # A playlist resource represents a YouTube - # playlist. A playlist is a collection of videos that can be viewed - # sequentially and shared with other users. A playlist can contain up to - # 200 videos, and YouTube does not limit the number of playlists that - # each user creates. By default, playlists are publicly visible to other - # users, but playlists can be public or private.

YouTube - # also uses playlists to identify special collections of videos for a - # channel, such as: - #
    - #
  • uploaded videos
    • - #
  • favorite videos
    • - #
  • positively rated (liked) videos
    • - #
  • watch history
    • - #
  • watch later
    • - #
- # To be more specific, these lists are associated with a channel, which - # is a collection of a person, group, or company's videos, playlists, - # and other YouTube information. You can retrieve the playlist IDs for - # each of these lists from the channel resource for a - # given channel.

You can then use the - # playlistItems.list method to retrieve any of those - # lists. You can also add or remove items from those lists by calling - # the - # playlistItems.insert and - # playlistItems.delete methods. + # A *playlist* resource represents a YouTube playlist. A playlist is a + # collection of videos that can be viewed sequentially and shared with other + # users. A playlist can contain up to 200 videos, and YouTube does not limit the + # number of playlists that each user creates. By default, playlists are publicly + # visible to other users, but playlists can be public or private. YouTube also + # uses playlists to identify special collections of videos for a channel, such + # as: - uploaded videos - favorite videos - positively rated (liked) videos - + # watch history - watch later To be more specific, these lists are associated + # with a channel, which is a collection of a person, group, or company's videos, + # playlists, and other YouTube information. You can retrieve the playlist IDs + # for each of these lists from the channel resource for a given channel. You can + # then use the playlistItems.list method to retrieve any of those lists. You can + # also add or remove items from those lists by calling the playlistItems.insert + # and playlistItems.delete methods. class Playlist include Google::Apis::Core::Hashable - # The contentDetails object contains information like - # video count. + # The contentDetails object contains information like video count. # Corresponds to the JSON property `contentDetails` # @return [Google::Apis::YoutubeV3::PlaylistContentDetails] attr_accessor :content_details @@ -6055,8 +5905,8 @@ module Google # @return [String] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#playlist". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # playlist". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -6066,8 +5916,8 @@ module Google # @return [Hash] attr_accessor :localizations - # The player object contains information that you would use - # to play the playlist in an embedded player. + # The player object contains information that you would use to play the playlist + # in an embedded player. # Corresponds to the JSON property `player` # @return [Google::Apis::YoutubeV3::PlaylistPlayer] attr_accessor :player @@ -6077,8 +5927,7 @@ module Google # @return [Google::Apis::YoutubeV3::PlaylistSnippet] attr_accessor :snippet - # The status object contains status information for the - # playlist. + # The status object contains status information for the playlist. # Corresponds to the JSON property `status` # @return [Google::Apis::YoutubeV3::PlaylistStatus] attr_accessor :status @@ -6104,20 +5953,17 @@ module Google class PlaylistCard include Google::Apis::Core::Hashable - # Each card can have a custom message. - # Optional. + # Each card can have a custom message. Optional. # Corresponds to the JSON property `customMessage` # @return [String] attr_accessor :custom_message - # External playlist ID. - # Required. + # External playlist ID. Required. # Corresponds to the JSON property `playlistId` # @return [String] attr_accessor :playlist_id - # Starting video, if not the first. - # Optional. + # Starting video, if not the first. Optional. # Corresponds to the JSON property `startVideoId` # @return [String] attr_accessor :start_video_id @@ -6153,41 +5999,26 @@ module Google end end - # A playlistItem resource identifies - # another resource, such as a video, that is included in a playlist. In - # addition, the playlistItem resource contains details - # about the included resource that pertain specifically to how that - # resource is used in that playlist.

YouTube uses playlists to - # identify special collections of videos for a channel, such as: - #
    - #
  • uploaded videos
    • - #
  • favorite videos
    • - #
  • positively rated (liked) videos
    • - #
  • watch history
    • - #
  • watch later
    • - #
- # To be more specific, these lists are associated with a channel, which - # is a collection of a person, group, or company's videos, playlists, - # and other YouTube information. - #

- # You can retrieve the playlist IDs for each of these lists from the - # channel resource - # for a given channel. You can then use the - # playlistItems.list method to retrieve any of those - # lists. You can also add or remove items from those lists by calling - # the - # playlistItems.insert and - # playlistItems.delete methods. For example, if a user gives - # a positive rating to a video, you would insert that video into the - # liked videos playlist for that user's channel. + # A *playlistItem* resource identifies another resource, such as a video, that + # is included in a playlist. In addition, the playlistItem resource contains + # details about the included resource that pertain specifically to how that + # resource is used in that playlist. YouTube uses playlists to identify special + # collections of videos for a channel, such as: - uploaded videos - favorite + # videos - positively rated (liked) videos - watch history - watch later To be + # more specific, these lists are associated with a channel, which is a + # collection of a person, group, or company's videos, playlists, and other + # YouTube information. You can retrieve the playlist IDs for each of these lists + # from the channel resource for a given channel. You can then use the + # playlistItems.list method to retrieve any of those lists. You can also add or + # remove items from those lists by calling the playlistItems.insert and + # playlistItems.delete methods. For example, if a user gives a positive rating + # to a video, you would insert that video into the liked videos playlist for + # that user's channel. class PlaylistItem include Google::Apis::Core::Hashable - # The contentDetails object is included in the resource if - # the included item is a YouTube video. The object contains additional - # information about the video. + # The contentDetails object is included in the resource if the included item is + # a YouTube video. The object contains additional information about the video. # Corresponds to the JSON property `contentDetails` # @return [Google::Apis::YoutubeV3::PlaylistItemContentDetails] attr_accessor :content_details @@ -6202,15 +6033,14 @@ module Google # @return [String] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#playlistItem". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # playlistItem". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Basic details about a playlist, including title, description and thumbnails. - # Basic details of a YouTube Playlist item provided by the author. - # Next ID: 13 + # Basic details of a YouTube Playlist item provided by the author. Next ID: 13 # Corresponds to the JSON property `snippet` # @return [Google::Apis::YoutubeV3::PlaylistItemSnippet] attr_accessor :snippet @@ -6240,10 +6070,9 @@ module Google include Google::Apis::Core::Hashable # The time, measured in seconds from the start of the video, when the video - # should stop playing. (The playlist owner can specify the times when the - # video should start and stop playing when the video is played in the context - # of the playlist.) By default, assume that the video.endTime is - # the end of the video. + # should stop playing. (The playlist owner can specify the times when the video + # should start and stop playing when the video is played in the context of the + # playlist.) By default, assume that the video.endTime is the end of the video. # Corresponds to the JSON property `endAt` # @return [String] attr_accessor :end_at @@ -6254,24 +6083,21 @@ module Google attr_accessor :note # The time, measured in seconds from the start of the video, when the video - # should start playing. (The playlist owner can specify the times when the - # video should start and stop playing when the video is played in the context - # of the playlist.) The default value is 0. + # should start playing. (The playlist owner can specify the times when the video + # should start and stop playing when the video is played in the context of the + # playlist.) The default value is 0. # Corresponds to the JSON property `startAt` # @return [String] attr_accessor :start_at - # The ID that YouTube uses to uniquely identify a video. To retrieve the video - # resource, set the id query parameter to this value in your - # API request. + # The ID that YouTube uses to uniquely identify a video. To retrieve the video + # resource, set the id query parameter to this value in your API request. # Corresponds to the JSON property `videoId` # @return [String] attr_accessor :video_id # The date and time that the video was published to YouTube. The value is - # specified in ISO 8601 - # format. + # specified in ISO 8601 format. # Corresponds to the JSON property `videoPublishedAt` # @return [String] attr_accessor :video_published_at @@ -6309,15 +6135,14 @@ module Google # @return [Array] attr_accessor :items - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#playlistItemListResponse". - # Etag of this resource. + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # playlistItemListResponse". Etag of this resource. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken - # parameter to retrieve the next page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -6328,8 +6153,8 @@ module Google # @return [Google::Apis::YoutubeV3::PageInfo] attr_accessor :page_info - # The token that can be used as the value of the pageToken - # parameter to retrieve the previous page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the previous page in the result set. # Corresponds to the JSON property `prevPageToken` # @return [String] attr_accessor :prev_page_token @@ -6339,7 +6164,7 @@ module Google # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination - # The visitorId identifies the visitor. + # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id @@ -6363,13 +6188,12 @@ module Google end # Basic details about a playlist, including title, description and thumbnails. - # Basic details of a YouTube Playlist item provided by the author. - # Next ID: 13 + # Basic details of a YouTube Playlist item provided by the author. Next ID: 13 class PlaylistItemSnippet include Google::Apis::Core::Hashable - # The ID that YouTube uses to uniquely identify the user that added - # the item to the playlist. + # The ID that YouTube uses to uniquely identify the user that added the item to + # the playlist. # Corresponds to the JSON property `channelId` # @return [String] attr_accessor :channel_id @@ -6384,22 +6208,21 @@ module Google # @return [String] attr_accessor :description - # The ID that YouTube uses to uniquely identify thGe playlist that the - # playlist item is in. + # The ID that YouTube uses to uniquely identify thGe playlist that the playlist + # item is in. # Corresponds to the JSON property `playlistId` # @return [String] attr_accessor :playlist_id - # The order in which the item appears in the playlist. The value uses a - # zero-based index, so the first item has a position of 0, - # the second item has a position of 1, and so forth. + # The order in which the item appears in the playlist. The value uses a zero- + # based index, so the first item has a position of 0, the second item has a + # position of 1, and so forth. # Corresponds to the JSON property `position` # @return [Fixnum] attr_accessor :position # The date and time that the item was added to the playlist. The value is - # specified in ISO 8601 - # format. + # specified in ISO 8601 format. # Corresponds to the JSON property `publishedAt` # @return [String] attr_accessor :published_at @@ -6475,14 +6298,14 @@ module Google # @return [Array] attr_accessor :items - # Identifies what kind of resource this is. Value: the fixed string - # "youtube#playlistListResponse". + # Identifies what kind of resource this is. Value: the fixed string "youtube# + # playlistListResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken - # parameter to retrieve the next page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -6493,8 +6316,8 @@ module Google # @return [Google::Apis::YoutubeV3::PageInfo] attr_accessor :page_info - # The token that can be used as the value of the pageToken - # parameter to retrieve the previous page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the previous page in the result set. # Corresponds to the JSON property `prevPageToken` # @return [String] attr_accessor :prev_page_token @@ -6504,7 +6327,7 @@ module Google # @return [Google::Apis::YoutubeV3::TokenPagination] attr_accessor :token_pagination - # The visitorId identifies the visitor. + # The visitorId identifies the visitor. # Corresponds to the JSON property `visitorId` # @return [String] attr_accessor :visitor_id @@ -6556,8 +6379,7 @@ module Google class PlaylistPlayer include Google::Apis::Core::Hashable - # An <iframe> tag that embeds a player that will - # play the playlist. + # An